OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.BrokerSearchSession
Implementsosid.provisioning.BrokerQuerySession
Description

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

getBrokersByQuery() is the basic search method and returns a list of Brokers. A more advanced search may be performed with getBrokersBySearch(). It accepts a BrokerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBrokersBySearch() returns a BrokerSearchResults that can be used to access the resulting BrokerList or be used to perform a search within the result set through BrokerSearch.

This session defines views that offer differing behaviors for searching.

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

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

MethodgetBrokerSearch
Description

Gets a broker search.

Returnosid.provisioning.BrokerSearchthe broker search
CompliancemandatoryThis method must be implemented.
MethodgetBrokerSearchOrder
Description

Gets a broker search order. The BrokerSearchOrder is supplied to a BrokerSearch to specify the ordering of results.

Returnosid.provisioning.BrokerSearchOrderthe broker search order
CompliancemandatoryThis method must be implemented.
MethodgetBrokersBySearch
Description

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

Parametersosid.provisioning.BrokerQuerybrokerQuerythe broker query
osid.provisioning.BrokerSearchbrokerSearchthe broker search
Returnosid.provisioning.BrokerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT brokerQuery or brokerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED brokerQuery or brokerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerQueryFromInspector
Description

Gets a broker query from an inspector. The inspector is available from a BrokerSearchResults.

Parametersosid.provisioning.BrokerQueryInspectorbrokerQueryInspectora broker query inspector
Returnosid.provisioning.BrokerQuerythe broker query
ErrorsNULL_ARGUMENT brokerQueryInspector is null
UNSUPPORTED brokerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.