OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorSearchSession
Implementsosid.provisioning.rules.BrokerProcessorQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetBrokerProcessorSearch
Description

Gets a broker processor search.

Returnosid.provisioning.rules.BrokerProcessorSearchthe broker processor search
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorSearchOrder
Description

Gets a broker processor search order. The BrokerProcessorSearchOrder is supplied to a BrokerProcessorSearch to specify the ordering of results.

Returnosid.provisioning.rules.BrokerProcessorSearchOrderthe broker processor search order
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorsBySearch
Description

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

Parametersosid.provisioning.rules.BrokerProcessorQuerybrokerProcessorQuerythe broker processor query
osid.provisioning.rules.BrokerProcessorSearchbrokerProcessorSearchthe broker processor search
Returnosid.provisioning.rules.BrokerProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT brokerProcessorQuery or brokerProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerProcessorQuery or brokerProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorQueryFromInspector
Description

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

Parametersosid.provisioning.rules.BrokerProcessorQueryInspectorbrokerProcessorQueryInspectora broker processor query inspector
Returnosid.provisioning.rules.BrokerProcessorQuerythe broker processor query
ErrorsNULL_ARGUMENT brokerProcessorQueryInspector is null
UNSUPPORTED brokerProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.