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

The search interface for governing broker constrainer searches.

MethodsearchAmongBrokerConstrainers
Description

Execute this search among the given list of broker constrainers.

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

Specify an ordering to the search results.

Parametersosid.provisioning.rules.BrokerConstrainerSearchOrderbrokerConstrainerSearchOrderbroker constrainer search order
ErrorsNULL_ARGUMENT brokerConstrainerSearchOrder is null
UNSUPPORTED brokerConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBrokerConstrainerSearchRecord
Description

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

Parametersosid.type.TypebrokerConstrainerSearchRecordTypea broker constrainer search record type
Returnosid.provisioning.rules.records.BrokerConstrainerSearchRecordthe broker constrainer search record
ErrorsNULL_ARGUMENT brokerConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(brokerConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.