OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueConstrainerEnablerSearchSession
Implementsosid.provisioning.rules.QueueConstrainerEnablerQuerySession
Description

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 provisioning. 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 distributor view: searches include queue constrainer enablers in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to queue constrainer enablers in this distributor

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

MethodgetQueueConstrainerEnablerSearch
Description

Gets a queue constrainer enabler search.

Returnosid.provisioning.rules.QueueConstrainerEnablerSearchthe queue constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerSearchOrder
Description

Gets a queue constrainer enabler search order. The QueueConstrainerEnablerSearchOrder is supplied to a QueueConstrainerEnablerSearch to specify the ordering of results.

Returnosid.provisioning.rules.QueueConstrainerEnablerSearchOrderthe queue constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersBySearch
Description

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

Parametersosid.provisioning.rules.QueueConstrainerEnablerQueryqueueConstrainerEnablerQuerythe queue constrainer enabler query
osid.provisioning.rules.QueueConstrainerEnablerSearchqueueConstrainerEnablerSearchthe queue constrainer enabler search
Returnosid.provisioning.rules.QueueConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerQueryFromInspector
Description

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

Parametersosid.provisioning.rules.QueueConstrainerEnablerQueryInspectorqueueConstrainerEnablerQueryInspectora queue constrainer enabler query inspector
Returnosid.provisioning.rules.QueueConstrainerEnablerQuerythe queue constrainer enabler query
ErrorsNULL_ARGUMENT queueConstrainerEnablerQueryInspector is null
UNSUPPORTED queueConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.