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

The search interface for governing pool processor searches.

MethodsearchAmongPoolProcessors
Description

Execute this search among the given list of pool processors.

Parametersosid.id.IdListpoolProcessorIdslist of pool processors
ErrorsNULL_ARGUMENT poolProcessorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPoolProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.rules.PoolProcessorSearchOrderpoolProcessorSearchOrderpool processor search order
ErrorsNULL_ARGUMENT poolProcessorSearchOrder is null
UNSUPPORTED poolProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorSearchRecord
Description

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

Parametersosid.type.TypepoolProcessorSearchRecordTypea pool processor search record type
Returnosid.provisioning.rules.records.PoolProcessorSearchRecordthe pool processor search record
ErrorsNULL_ARGUMENT poolProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.