OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorEnablerSearchSession
Implementsosid.provisioning.rules.QueueProcessorEnablerQuerySession
Description

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

getQueueProcessorEnablersByQuery() is the basic search method and returns a list of QueueProcessorEnablers. A more advanced search may be performed with getQueueProcessorEnablersBySearch(). It accepts a QueueProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as provisioning. getQueueProcessorEnablersBySearch() returns a QueueProcessorEnablerSearchResults that can be used to access the resulting QueueProcessorEnablerList or be used to perform a search within the result set through QueueProcessorEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetQueueProcessorEnablerSearch
Description

Gets a queue processor enabler search.

Returnosid.provisioning.rules.QueueProcessorEnablerSearchthe queue processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerSearchOrder
Description

Gets a queue processor enabler search order. The QueueProcessorEnablerSearchOrder is supplied to a QueueProcessorEnablerSearch to specify the ordering of results.

Returnosid.provisioning.rules.QueueProcessorEnablerSearchOrderthe queue processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablersBySearch
Description

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

Parametersosid.provisioning.rules.QueueProcessorEnablerQueryqueueProcessorEnablerQuerythe queue processor enabler query
osid.provisioning.rules.QueueProcessorEnablerSearchqueueProcessorEnablerSearchthe queue processor enabler search
Returnosid.provisioning.rules.QueueProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT queueProcessorEnablerQuery or queueProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueProcessorEnablerQuery or queueProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerQueryFromInspector
Description

Gets a queue processor enabler query from an inspector. The inspector is available from a QueueProcessorEnablerSearchResults.

Parametersosid.provisioning.rules.QueueProcessorEnablerQueryInspectorqueueProcessorEnablerQueryInspectora queue processor enabler query inspector
Returnosid.provisioning.rules.QueueProcessorEnablerQuerythe queue processor enabler query
ErrorsNULL_ARGUMENT queueProcessorEnablerQueryInspector is null
UNSUPPORTED queueProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.