Interface DispatchEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, DispatchEnablerQuerySession, OsidSession, OsidSession
public interface DispatchEnablerSearchSession extends DispatchEnablerQuerySession

This session provides methods for searching among DispatchEnablers . The search query is constructed using the DispatchEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

  • federated publisher view: searches include dispatch enablers in publishers of which this publisher is an ancestor in the publisher hierarchy
  • isolated publisher view: searches are restricted to dispatch enablers in this publisher

Dispatch enablers may have a query record indicated by their respective record types. The query record is accessed via the DispatchEnablerQuery .

  • Method Details

    • getDispatchEnablerSearch

      DispatchEnablerSearch getDispatchEnablerSearch()
      Gets a dispatch enabler search.
      Returns:
      the dispatch enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablerSearchOrder

      DispatchEnablerSearchOrder getDispatchEnablerSearchOrder()
      Gets a dispatch enabler search order. The DispatchEnablerSearchOrder is supplied to a DispatchEnablerSearch to specify the ordering of results.
      Returns:
      the dispatch enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablersBySearch

      DispatchEnablerSearchResults getDispatchEnablersBySearch(DispatchEnablerQuery dispatchEnablerQuery, DispatchEnablerSearch dispatchEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      dispatchEnablerQuery - the dispatch enabler query
      dispatchEnablerSearch - the dispatch enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - dispatchEnablerQuery or dispatchEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchEnablerQuery or dispatchEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchEnablerQueryFromInspector

      DispatchEnablerQuery getDispatchEnablerQueryFromInspector(DispatchEnablerQueryInspector dispatchEnablerQueryInspector)
      Gets a dispatch enabler query from an inspector. The inspector is available from a DispatchEnablerSearchResults .
      Parameters:
      dispatchEnablerQueryInspector - a dispatch enabler query inspector
      Returns:
      the dispatch enabler query
      Throws:
      NullArgumentException - dispatchEnablerQueryInspector is null
      UnsupportedException - dispatchEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.