OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.PoolSearch
Implementsosid.OsidSearch
Used Byosid.provisioning.PoolSearchSession
Description

The search interface for governing pool searches.

MethodsearchAmongPools
Description

Execute this search among the given list of pools.

Parametersosid.id.IdListpoolIds list of pools
ErrorsNULL_ARGUMENT poolIds is null
Compliancemandatory This method must be implemented.
MethodorderPoolResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.PoolSearchOrderpoolSearchOrder pool search order
ErrorsNULL_ARGUMENT poolSearchOrder is null
UNSUPPORTED poolSearchOrder is not of this service
Compliancemandatory This 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.TypepoolSearchRecordType a pool search record type
Returnosid.provisioning.records.PoolSearchRecord the pool search record
ErrorsNULL_ARGUMENT poolSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(poolSearchRecordType) is false
Compliancemandatory This method must be implemented.