Interface SupersedingEventEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SupersedingEventEnablerQuerySession
public interface SupersedingEventEnablerSearchSession extends SupersedingEventEnablerQuerySession

This session provides methods for searching among SupersedingEventEnabler objects. The search query is constructed using the SupersedingEventEnablerQuery .

getSupersedingEventEnablersByQuery() is the basic search method and returns a list of SupersedingEventEnablers . A more advanced search may be performed with getSupersedingEventEnablersBySearch() .It accepts a SupersedingEventEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as calendaring. getSupersedingEventEnablersBySearch() returns a SupersedingEventEnablerSearchResults that can be used to access the resulting SupersedingEventEnablerList or be used to perform a search within the result set through SupersedingEventEnablerSearch .

This session defines views that offer differing behaviors for searching.

  • federated calendar view: searches include superseding event enablers in calendars of which this calendar is an ancestor in the calendar hierarchy
  • isolated calendar view: searches are restricted to superseding event enablers in this calendar
SupersedingEventEnablers may have a query record indicated by their respective record types. The query record is accessed via the SupersedingEventEnablerQuery .

  • Method Details

    • getSupersedingEventEnablerSearch

      SupersedingEventEnablerSearch getSupersedingEventEnablerSearch()
      Gets a superseding event enabler search.
      Returns:
      the superseding event enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablerSearchOrder

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

    • getSupersedingEventEnablersBySearch

      SupersedingEventEnablerSearchResults getSupersedingEventEnablersBySearch(SupersedingEventEnablerQuery supersedingEventEnablerQuery, SupersedingEventEnablerSearch supersedingEventEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      supersedingEventEnablerQuery - the superseding event enabler query
      supersedingEventEnablerSearch - the superseding event enabler search
      Returns:
      the superseding event search results
      Throws:
      NullArgumentException - supersedingEventEnablerQuery or supersedingEventEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - supersedingEventEnablerQuery or supersedingEventEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSupersedingEventEnablerQueryFromInspector

      SupersedingEventEnablerQuery getSupersedingEventEnablerQueryFromInspector(SupersedingEventEnablerQueryInspector supersedingEventEnablerQueryInspector)
      Gets a superseding event enabler query from an inspector. The inspector is available from a SupersedingEventEnablerSearchResults .
      Parameters:
      supersedingEventEnablerQueryInspector - a superseding event enabler query inspector
      Returns:
      the superseding event enabler query
      Throws:
      NullArgumentException - supersedingEventEnablerQueryInspector is null
      UnsupportedException - supersedingEventEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.