OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.QueueSearchSession
Implementsosid.provisioning.QueueQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

  • federated broker view: searches include queues in brokers of which this broker is an ancestor in the broker hierarchy
  • isolated broker view: searches are restricted to queues in this broker

Queues may have a queue record indicated by their respective record types. The queue record is accessed via the QueueQuery.

MethodgetQueueSearch
Description

Gets a queue search.

Returnosid.provisioning.QueueSearchthe queue search
CompliancemandatoryThis method must be implemented.
MethodgetQueueSearchOrder
Description

Gets a queue search order. The QueueSearchOrder is supplied to a QueueSearch to specify the ordering of results.

Returnosid.provisioning.QueueSearchOrderthe queue search order
CompliancemandatoryThis method must be implemented.
MethodgetQueuesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.provisioning.QueueQueryqueueQuerythe queue query
osid.provisioning.QueueSearchqueueSearchthe queue search
Returnosid.provisioning.QueueSearchResultsthe queue search results
ErrorsNULL_ARGUMENT queueQuery or queueSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueQuery or queueSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueQueryFromInspector
Description

Gets a queue query from an inspector. The inspector is available from a QueueSearchResults.

Parametersosid.provisioning.QueueQueryInspectorqueueQueryInspectora queue query inspector
Returnosid.provisioning.QueueQuerythe queue query
ErrorsNULL_ARGUMENT queueQueryInspector is null
UNSUPPORTED queueQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.