Interface QueueProcessorEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QueueProcessorEnablerQuerySession
public interface QueueProcessorEnablerSearchSession extends QueueProcessorEnablerQuerySession

This session provides methods for searching among QueueProcessorEnablers . The search query is constructed using the QueueProcessorEnablerQuery .

getQueueProcessorEnablersByQuery() is the basic search method and returns a list of QueueProcessorEnablers . A more advanced search may be performed with getQueueProcessorEnablersBySearch() .It accepts a QueueProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getQueueProcessorEnablersBySearch() returns a QueueProcessorEnablerSearchResults that can be used to access the resulting QueueProcessorEnablerList or be used to perform a search within the result set through Qu eueProcessorEnablerSearch .

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include queue processor enablers in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to queue processor enablers in this distributor

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

  • Method Details

    • getQueueProcessorEnablerSearch

      QueueProcessorEnablerSearch getQueueProcessorEnablerSearch()
      Gets a queue processor enabler search.
      Returns:
      the queue processor enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablerSearchOrder

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

    • getQueueProcessorEnablersBySearch

      QueueProcessorEnablerSearchResults getQueueProcessorEnablersBySearch(QueueProcessorEnablerQuery queueProcessorEnablerQuery, QueueProcessorEnablerSearch queueProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      queueProcessorEnablerQuery - the queue processor enabler query
      queueProcessorEnablerSearch - the queue processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - queueProcessorEnablerQuery or queueProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueProcessorEnablerQuery or queueProcessorEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablerQueryFromInspector

      QueueProcessorEnablerQuery getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector)
      Gets a queue processor enabler query from an inspector. The inspector is available from a QueueProcessorEnablerSearchResults .
      Parameters:
      queueProcessorEnablerQueryInspector - a queue processor enabler query inspector
      Returns:
      the queue processor enabler query
      Throws:
      NullArgumentException - queueProcessorEnablerQueryInspector is null
      UnsupportedException - queueProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.