OSID Logo
OSID Specifications
provisioning package
Version 3.0.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.IdListbrokerIdslist of brokers
ErrorsNULL_ARGUMENTbrokerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBrokerResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.BrokerSearchOrderbrokerSearchOrderbroker search order
ErrorsNULL_ARGUMENTbrokerSearchOrder is null
UNSUPPORTEDbrokerSearchOrder is not of this service
CompliancemandatoryThis 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.TypebrokerSearchRecordTypea broker search record type
Returnosid.provisioning.records.BrokerSearchRecordthe broker search record
ErrorsNULL_ARGUMENTbrokerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(brokerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.