OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueConstrainerSearchSession
Implementsosid.provisioning.rules.QueueConstrainerQuerySession
Description

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

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 provisioning. 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 QueueConstrainerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetQueueConstrainerSearch
Description

Gets a queue constrainer search.

Returnosid.provisioning.rules.QueueConstrainerSearchthe queue constrainer search
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerSearchOrder
Description

Gets a queue constrainer search order. The QueueConstrainerSearchOrder is supplied to a QueueConstrainerSearch to specify the ordering of results.

Returnosid.provisioning.rules.QueueConstrainerSearchOrderthe queue constrainer search order
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainersBySearch
Description

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

Parametersosid.provisioning.rules.QueueConstrainerQueryqueueConstrainerQuerythe queue constrainer query
osid.provisioning.rules.QueueConstrainerSearchqueueConstrainerSearchthe queue constrainer search
Returnosid.provisioning.rules.QueueConstrainerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT queueConstrainerQuery or queueConstrainerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerQuery or queueConstrainerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerQueryFromInspector
Description

Gets a queue constrainer query from an inspector. The inspector is available from a QueueConstrainerSearchResults.

Parametersosid.provisioning.rules.QueueConstrainerQueryInspectorqueueConstrainerQueryInspectora queue constrainer query inspector
Returnosid.provisioning.rules.QueueConstrainerQuerythe queue constrainer query
ErrorsNULL_ARGUMENT queueConstrainerQueryInspector is null
UNSUPPORTED queueConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.