OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerConstrainerEnablerSearchSession
Implementsosid.provisioning.rules.BrokerConstrainerEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetBrokerConstrainerEnablerSearch
Description

Gets a broker constrainer enabler search.

Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchthe broker constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablerSearchOrder
Description

Gets a broker constrainer enabler search order. The BrokerConstrainerEnablerSearchOrder is supplied to a BrokerConstrainerEnablerSearch to specify the ordering of results.

Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchOrderthe broker constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablersBySearch
Description

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

Parametersosid.provisioning.rules.BrokerConstrainerEnablerQuerybrokerConstrainerEnablerQuerythe broker constrainer enabler query
osid.provisioning.rules.BrokerConstrainerEnablerSearchbrokerConstrainerEnablerSearchthe broker constrainer enabler search
Returnosid.provisioning.rules.BrokerConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT brokerConstrainerEnablerQuery or brokerConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerConstrainerEnablerQuery or brokerConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerEnablerQueryFromInspector
Description

Gets a broker constrainer enabler query from an inspector. The inspector is available from a BrokerConstrainerEnablerSearchResults.

Parametersosid.provisioning.rules.BrokerConstrainerEnablerQueryInspectorbrokerConstrainerEnablerQueryInspectora broker constrainer enabler query inspector
Returnosid.provisioning.rules.BrokerConstrainerEnablerQuerythe broker constrainer enabler query
ErrorsNULL_ARGUMENT brokerConstrainerEnablerQueryInspector is null
UNSUPPORTED brokerConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.