org.osid.provisioning

Interface Pool

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable, Subjugateable

public interface Pool
extends OsidGovernator, Subjugateable

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

Method Summary

Methods

Modifier and Type	Method and Description
Broker	getBroker() Gets the broker.
Id	getBrokerId() Gets the broker Id.
PoolRecord	getPoolRecord(Type poolRecordType) Gets the pool record corresponding to the given Pool record Type.
long	getSize() Gets the size of the pool.
boolean	hasSize() Tests if a pool size is available.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getBrokerId

Id getBrokerId()

Gets the broker Id.

Returns:

the broker Id

Compliance:

mandatory - This method must be implemented.

getBroker

Broker getBroker()
                 throws OperationFailedException

Gets the broker.

Returns:

the broker

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasSize

boolean hasSize()

Tests if a pool size is available.

Returns:

true if a queue size is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSize

long getSize()

Gets the size of the pool.

Returns:

the size

Throws:

IllegalStateException - hasSize() is false

Compliance:

mandatory - This method must be implemented.

getPoolRecord

PoolRecord getPoolRecord(Type poolRecordType)
                         throws OperationFailedException

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 .

Parameters:

poolRecordType - the type of pool record to retrieve

Returns:

the pool record

Throws:

NullArgumentException - poolRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolRecordType) is false

Compliance:

mandatory - This method must be implemented.