OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.BrokerSearch
Implementsosid.OsidSearch
Used Byosid.provisioning.BrokerSearchSession
Description

The search interface for governing broker searches.

MethodsearchAmongBrokers
Description

Execute this search among the given list of brokers.

Parametersosid.id.IdListbrokerIds list of brokers
ErrorsNULL_ARGUMENT brokerIds is null
Compliancemandatory This method must be implemented.
MethodorderBrokerResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.BrokerSearchOrderbrokerSearchOrder broker search order
ErrorsNULL_ARGUMENT brokerSearchOrder is null
UNSUPPORTED brokerSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBrokerSearchRecord
Description

Gets the broker search record corresponding to the given broker search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypebrokerSearchRecordType a broker search record type
Returnosid.provisioning.records.BrokerSearchRecord the broker search record
ErrorsNULL_ARGUMENT brokerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(brokerSearchRecordType) is false
Compliancemandatory This method must be implemented.