OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorEnablerSearchSession
Implementsosid.provisioning.rules.BrokerProcessorEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetBrokerProcessorEnablerSearch
Description

Gets a broker processor enabler search.

Returnosid.provisioning.rules.BrokerProcessorEnablerSearchthe broker processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerSearchOrder
Description

Gets a broker processor enabler search order. The BrokerProcessorEnablerSearchOrder is supplied to a BrokerProcessorEnablerSearch to specify the ordering of results.

Returnosid.provisioning.rules.BrokerProcessorEnablerSearchOrderthe broker processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablersBySearch
Description

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

Parametersosid.provisioning.rules.BrokerProcessorEnablerQuerybrokerProcessorEnablerQuerythe broker processor enabler query
osid.provisioning.rules.BrokerProcessorEnablerSearchbrokerProcessorEnablerSearchthe broker processor enabler search
Returnosid.provisioning.rules.BrokerProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT brokerProcessorEnablerQuery or brokerProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerProcessorEnablerQuery or brokerProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorEnablerQueryFromInspector
Description

Gets a broker processor enabler query from an inspector. The inspector is available from a BrokerProcessorEnablerSearchResults.

Parametersosid.provisioning.rules.BrokerProcessorEnablerQueryInspectorbrokerProcessorEnablerQueryInspectora broker processor enabler query inspector
Returnosid.provisioning.rules.BrokerProcessorEnablerQuerythe broker processor enabler query
ErrorsNULL_ARGUMENT brokerProcessorEnablerQueryInspector is null
UNSUPPORTED brokerProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.