Interface | osid.provisioning.Pool | ||
---|---|---|---|
Implements | osid.OsidGovernator | ||
osid.Subjugateable | |||
Description |
A | ||
Method | getBrokerId | ||
Description |
Gets the broker | ||
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 | 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 | ||
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. |