Interface DispatchProcessorSearchSession

All Superinterfaces:
AutoCloseable, Closeable, DispatchProcessorQuerySession, OsidSession, OsidSession
public interface DispatchProcessorSearchSession extends DispatchProcessorQuerySession

This session provides methods for searching among DispatchProcessors . The search query is constructed using the DispatchProcessorQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getDispatchProcessorSearch

      DispatchProcessorSearch getDispatchProcessorSearch()
      Gets a dispatch processor search.
      Returns:
      the dispatch processor search
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorSearchOrder

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

    • getDispatchProcessorsBySearch

      DispatchProcessorSearchResults getDispatchProcessorsBySearch(DispatchProcessorQuery dispatchProcessorQuery, DispatchProcessorSearch dispatchProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      dispatchProcessorQuery - the dispatch processor query
      dispatchProcessorSearch - the dispatch processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - dispatchProcessorQuery or dispatchProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - dispatchProcessorQuery or dispatchProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchProcessorQueryFromInspector

      DispatchProcessorQuery getDispatchProcessorQueryFromInspector(DispatchProcessorQueryInspector dispatchProcessorQueryInspector)
      Gets a dispatch processor query from an inspector. The inspector is available from a DispatchProcessorSearchResults .
      Parameters:
      dispatchProcessorQueryInspector - a dispatch processor query inspector
      Returns:
      the dispatch processor query
      Throws:
      NullArgumentException - dispatchProcessorQueryInspector is null
      UnsupportedException - dispatchProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.