OSID - osid.provisioning.rules.QueueConstrainer Service Interface Definition

Interface	osid.provisioning.rules.QueueConstrainer
Implements	`osid.OsidConstrainer`
Description	A `QueueConstrainer` describes the rules for constraining the provisioning requests in a queue.
Method	hasSizeLimit
Description	Tests if this queue limits the number of requests.
Return	`boolean`		`true` if a queue size limit is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSizeLimit
Description	Gets the size limit of the queue.
Return	`cardinal`		the size limit
Errors	ILLEGAL_STATE		`hasSizeLimit()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	requiresProvisions
Description	Tests if a provision must exist before entering this queue.
Return	`boolean`		`true` if a provision is required, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRequiredProvisionPoolIds
Description	Gets the pool `Ids` for the required provisions.
Return	`osid.id.IdList`		the `Ids` of the pools
Errors	ILLEGAL_STATE		`requiresProvisions()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiredProvisionPools
Description	Gets the pools for the required provisions.
Return	`osid.provisioning.PoolList`		the pools
Errors	ILLEGAL_STATE		`requiresProvisions()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerRecord
Description	Gets the queue constrainer record corresponding to the given `QueueConstrainer` record `Type.` This method is used to retrieve an object implementing the requested record. The `queueConstrainerRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(queueConstrainerRecordType)` is `true` .
Parameters	`osid.type.Type`	`queueConstrainerRecordType`	the type of queue constrainer record to retrieve
Return	`osid.provisioning.rules.records.QueueConstrainerRecord`		the queue constrainer record
Errors	NULL_ARGUMENT		`queueConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.