Interface QueueProcessorSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QueueProcessorQuerySession
public interface QueueProcessorSearchSession extends QueueProcessorQuerySession

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

getQueueProcessorsByQuery() is the basic search method and returns a list of QueueProcessors. A more advanced search may be performed with getQueueProcessorsBySearch(). It accepts a QueueProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as tracking. getQueueProcessorsBySearch() returns a QueueProcessorSearchResults that can be used to access the resulting QueueProcessorList or be used to perform a search within the result set through QueueProcessorSearch.

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue processor in front office of which this front office matchmaker is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to queue processor in this office
QueueProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the QueueProcessorQuery.

  • Method Details

    • getQueueProcessorSearch

      QueueProcessorSearch getQueueProcessorSearch()
      Gets a queue processor search.
      Returns:
      the queue processor search
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorSearchOrder

      QueueProcessorSearchOrder getQueueProcessorSearchOrder()
      Gets a queue processor search order. The QueueProcessorSearchOrder is supplied to a QueueProcessorSearch to specify the ordering of results.
      Returns:
      the queue processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorsBySearch

      QueueProcessorSearchResults getQueueProcessorsBySearch(QueueProcessorQuery queueProcessorQuery, QueueProcessorSearch queueProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      queueProcessorQuery - the queue processor query
      queueProcessorSearch - the queue processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - queueProcessorQuery or queueProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueProcessorQuery or queueProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorQueryFromInspector

      QueueProcessorQuery getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector)
      Gets a queue processor query from an inspector. The inspector is available from a QueueProcessorSearchResults.
      Parameters:
      queueProcessorQueryInspector - a queue processor query inspector
      Returns:
      the queue processor query
      Throws:
      NullArgumentException - queueProcessorQueryInspector is null
      UnsupportedException - queueProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.