OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.BrokerProcessorSearch
Implementsosid.OsidSearch
Description

The search interface for governing broker processor searches.

MethodsearchAmongBrokerProcessors
Description

Execute this search among the given list of broker processors.

Parametersosid.id.IdListdistributorIdslist of broker processors
ErrorsNULL_ARGUMENT distributorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBrokerProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.rules.BrokerProcessorSearchOrderbrokerProcessorSearchOrderbroker processor search order
ErrorsNULL_ARGUMENT brokerProcessorSearchOrder is null
UNSUPPORTED brokerProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerProcessorSearchRecord
Description

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

Parametersosid.type.TypebrokerProcessorSearchRecordTypea broker processor search record type
Returnosid.provisioning.rules.records.BrokerProcessorSearchRecordthe broker processor search record
ErrorsNULL_ARGUMENT brokerProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(brokerProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.