Interface QueueConstrainerEnablerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QueueConstrainerEnablerQuerySession
public interface QueueConstrainerEnablerSearchSession extends QueueConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue constrainer enablers 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 constrainer enablers in this office
QueueConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the QueueConstrainerEnablerQuery .

  • Method Details

    • getQueueConstrainerEnablerSearch

      QueueConstrainerEnablerSearch getQueueConstrainerEnablerSearch()
      Gets a queue constrainer enabler search.
      Returns:
      the queue constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablerSearchOrder

      QueueConstrainerEnablerSearchOrder getQueueConstrainerEnablerSearchOrder()
      Gets a queue constrainer enabler search order. The QueueConstrainerEnablerSearchOrder is supplied to a QueueConstrainerEnablerSearch to specify the ordering of results.
      Returns:
      the queue constrainer enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablersBySearch

      QueueConstrainerEnablerSearchResults getQueueConstrainerEnablersBySearch(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery, QueueConstrainerEnablerSearch queueConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      queueConstrainerEnablerQuery - the queue constrainer enabler query
      queueConstrainerEnablerSearch - the queue constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerEnablerQueryFromInspector

      QueueConstrainerEnablerQuery getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)
      Gets a queue constrainer enabler query from an inspector. The inspector is available from a QueueConstrainerEnablerSearchResults .
      Parameters:
      queueConstrainerEnablerQueryInspector - a queue constrainer enabler query inspector
      Returns:
      the queue constrainer enabler query
      Throws:
      NullArgumentException - queueConstrainerEnablerQueryInspector is null
      UnsupportedException - queueConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.