OSID - osid.provisioning.Pool Service Interface Definition

Interface	osid.provisioning.Pool
Implements	`osid.OsidGovernator`
Implements	`osid.Subjugateable`
Used By	`osid.provisioning.PoolAdminSession`
	`osid.provisioning.PoolList`
	`osid.provisioning.PoolLookupSession`
	`osid.provisioning.Provisionable`
	`osid.provisioning.Request`
Description	A `Pool` represents a set of `Resources` to be provisioned. The rule indicates how resources are provisioned.
Method	getBrokerId
Description	Gets the broker `Id` .
Return	`osid.id.Id`		the broker `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getBroker
Description	Gets the broker.
Return	`osid.provisioning.Broker`		the broker
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSupplierIds
Description	Gets the `Ids` of the suppliers.
Return	`osid.id.IdList`		the supplier `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSuppliers
Description	Gets the suppliers.
Return	`osid.resource.ResourceList`		the suppliers
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasSize
Description	Tests if a pool size is available.
Return	`boolean`		`true` if a queue size is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSize
Description	Gets the size of the pool.
Return	`cardinal`		the size
Errors	ILLEGAL_STATE		`hasSize()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPoolRecord
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` .
Parameters	`osid.type.Type`	`poolRecordType`	the type of pool record to retrieve
Return	`osid.provisioning.records.PoolRecord`		the pool record
Errors	NULL_ARGUMENT		`poolRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(poolRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.