Interface QueueConstrainerSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, QueueConstrainerQuerySession
public interface QueueConstrainerSearchSession extends QueueConstrainerQuerySession

This session provides methods for searching among QueueConstrainers. The search query is constructed using the QueueConstrainerQuery.

getQueueConstrainersByQuery() is the basic search method and returns a list of QueueConstrainers. A more advanced search may be performed with getQueueConstrainersBySearch(). It accepts a QueueConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getQueueConstrainersBySearch() returns a QueueConstrainerSearchResults that can be used to access the resulting QueueConstrainerList or be used to perform a search within the result set through Qu eueConstrainerSearch.

This session defines views that offer differing behaviors for searching.

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

Queue constrainers may have a query record indicated by their respective record types. The query record is accessed via the QueueConstrainerQuery.

Like all OsidSessions, QueueConstrainerSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getQueueConstrainerSearch

      QueueConstrainerSearch getQueueConstrainerSearch()
      Gets a queue constrainer search.
      Returns:
      the queue constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerSearchOrder

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

    • getQueueConstrainersBySearch

      QueueConstrainerSearchResults getQueueConstrainersBySearch(QueueConstrainerQuery queueConstrainerQuery, QueueConstrainerSearch queueConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      queueConstrainerQuery - the queue constrainer query
      queueConstrainerSearch - the queue constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - queueConstrainerQuery or queueConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerQuery or queueConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQueryFromInspector

      QueueConstrainerQuery getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
      Gets a queue constrainer query from an inspector. The inspector is available from a QueueConstrainerSearchResults.
      Parameters:
      queueConstrainerQueryInspector - a queue constrainer query inspector
      Returns:
      the queue constrainer query
      Throws:
      NullArgumentException - queueConstrainerQueryInspector is null
      UnsupportedException - queueConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.