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

The search interface for governing pool constrainer searches.

MethodsearchAmongPoolConstrainers
Description

Execute this search among the given list of pool constrainers.

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

Specify an ordering to the search results.

Parametersosid.provisioning.rules.PoolConstrainerSearchOrderpoolConstrainerSearchOrderpool constrainer search order
ErrorsNULL_ARGUMENT poolConstrainerSearchOrder is null
UNSUPPORTED poolConstrainerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerSearchRecord
Description

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

Parametersosid.type.TypepoolConstrainerSearchRecordTypea pool constrainer search record type
Returnosid.provisioning.rules.records.PoolConstrainerSearchRecordthe pool constrainer search record
ErrorsNULL_ARGUMENT poolConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.