Interface SupersedingEventSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SupersedingEventQuerySession
public interface SupersedingEventSearchSession extends SupersedingEventQuerySession

This session provides methods for searching SupersedingEvent objects. The search query is constructed using the SupersedingEventQuery. The superseding event record Type also specifies the record for the superseding event query.

getSupersedingEventsByQuery() is the basic search method and returns a list of SupersedingEvents. A more advanced search may be performed with getSupersedingEventsBySearch(). It accepts a SupersedingEventSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSupersedingEventsBySearch() returns a SupersedingEventSearchResults that can be used to access the resulting SupersedingEventList or be used to perform a search within the result set through SupersedingEventSearch.

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include superseding events in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to superseding events in this calendar

Superseding events may have a query record indicated by their respective record types. The query record is accessed via the SupersedingEventQuery.

  • Method Details

    • getSupersedingEventSearch

      SupersedingEventSearch getSupersedingEventSearch()
      Gets a superseding event search.
      Returns:
      the superseding event search
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventSearchOrder

      SupersedingEventSearchOrder getSupersedingEventSearchOrder()
      Gets a superseding event search order. The SupersedingEventSearchOrder is supplied to a SupersedingEventSearch to specify the ordering of results.
      Returns:
      the superseding event search order
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventsBySearch

      SupersedingEventSearchResults getSupersedingEventsBySearch(SupersedingEventQuery supersedingEventQuery, SupersedingEventSearch supersedingEventSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      supersedingEventQuery - the superseding search query
      supersedingEventSearch - the superseding search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - supersedingEventQuery or supersedingEventSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - supersedingEventQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventQueryFromInspector

      SupersedingEventQuery getSupersedingEventQueryFromInspector(SupersedingEventQueryInspector supersedingEventQueryInspector)
      Gets a superseding event query from an inspector. The inspector is available from a SupersedingEventSearchResults.
      Parameters:
      supersedingEventQueryInspector - a superseding event query inspector
      Returns:
      the superseding event query
      Throws:
      NullArgumentException - supersedingEventQueryInspector is null
      UnsupportedException - supersedingEventQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.