Interface DispatchProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, DispatchProcessorEnablerQuerySession, OsidSession, OsidSession
public interface DispatchProcessorEnablerSearchSession extends DispatchProcessorEnablerQuerySession

This session provides methods for searching among DispatchProcessorEnablers . The search query is constructed using the DispatchProcessorEnablerQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getDispatchProcessorEnablerSearch

      DispatchProcessorEnablerSearch getDispatchProcessorEnablerSearch()
      Gets a dispatch processor enabler search.
      Returns:
      the dispatch processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorEnablerSearchOrder

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

    • getDispatchProcessorEnablersBySearch

      DispatchProcessorEnablerSearchResults getDispatchProcessorEnablersBySearch(DispatchProcessorEnablerQuery dispatchProcessorEnablerQuery, DispatchProcessorEnablerSearch dispatchProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      dispatchProcessorEnablerQuery - the dispatch processor enabler query
      dispatchProcessorEnablerSearch - the dispatch processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - dispatchProcessorEnablerQuery or dispatchProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchProcessorEnablerQuery or dispatchProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorEnablerQueryFromInspector

      DispatchProcessorEnablerQuery getDispatchProcessorEnablerQueryFromInspector(DispatchProcessorEnablerQueryInspector dispatchProcessorEnablerQueryInspector)
      Gets a dispatch processor enabler query from an inspector. The inspector is available from a DispatchProcessorEnablerSearchResults .
      Parameters:
      dispatchProcessorEnablerQueryInspector - a dispatch processor enabler query inspector
      Returns:
      the dispatch processor enabler query
      Throws:
      NullArgumentException - dispatchProcessorEnablerQueryInspector is null
      UnsupportedException - dispatchProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.