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

The search interface for governing pool searches.

MethodsearchAmongPools
Description

Execute this search among the given list of pools.

Parametersosid.id.IdListpoolIdslist of pools
ErrorsNULL_ARGUMENT poolIds is null
CompliancemandatoryThis method must be implemented.
MethodorderPoolResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.PoolSearchOrderpoolSearchOrderpool search order
ErrorsNULL_ARGUMENT poolSearchOrder is null
UNSUPPORTED poolSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPoolSearchRecord
Description

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

Parametersosid.type.TypepoolSearchRecordTypea pool search record type
Returnosid.provisioning.records.PoolSearchRecordthe pool search record
ErrorsNULL_ARGUMENT poolSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolSearchRecordType) is false
CompliancemandatoryThis method must be implemented.