OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.Pool
Implementsosid.OsidGovernator
osid.Subjugateable
Description

A Pool represents a set of Resources to be provisioned. The rule indicates how resources are provisioned.

MethodgetBrokerId
Description

Gets the broker Id.

Returnosid.id.Idthe broker Id
CompliancemandatoryThis method must be implemented.
MethodgetBroker
Description

Gets the broker.

Returnosid.provisioning.Brokerthe broker
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasSize
Description

Tests if a pool size is available.

Returnboolean true if a queue size is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSize
Description

Gets the size of the pool.

Returncardinalthe size
ErrorsILLEGAL_STATE hasSize() is false
CompliancemandatoryThis method must be implemented.
MethodgetPoolRecord
Description

Gets the pool record corresponding to the given Pool record Type. This method is used to retrieve an object implementing the requested record. The poolRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(poolRecordType) is true .

Parametersosid.type.TypepoolRecordTypethe type of pool record to retrieve
Returnosid.provisioning.records.PoolRecordthe pool record
ErrorsNULL_ARGUMENT poolRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolRecordType) is false
CompliancemandatoryThis method must be implemented.