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

Interface	osid.provisioning.rules.QueueConstrainerForm
Implements	`osid.OsidConstrainerForm`
Used By	`osid.provisioning.rules.QueueConstrainerAdminSession`
Description	This is the form for creating and updating `QueueConstrainers`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `QueueConstrainerAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getSizeLimitMetadata
Description	Gets the metadata for the size limit.
Return	`osid.Metadata`		metadata for the size limit
Compliance	`mandatory`		This method must be implemented.
Method	setSizeLimit
Description	Sets the size limit.
Parameters	`cardinal`	`limit`	the new limit
Errors	INVALID_ARGUMENT		`limit` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearSizeLimit
Description	Removes the size limit.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiresProvisionsMetadata
Description	Gets the metadata for the requires provisions flag.
Return	`osid.Metadata`		metadata for the requires provisions flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequiresProvisions
Description	Sets the requires provisions flag.
Parameters	`cardinal`	`requiresProvisions`	the new requires provisions
Errors	INVALID_ARGUMENT		`requiresProvisions` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresProvisions
Description	Removes the requires provisions flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiredProvisionPoolsMetadata
Description	Gets the metadata for the required pools.
Return	`osid.Metadata`		metadata for the required pools
Compliance	`mandatory`		This method must be implemented.
Method	setRequiredProvisionPools
Description	Sets the required provision pools.
Parameters	`osid.id.Id[]`	`poolIds`	the new pools
Errors	INVALID_ARGUMENT		`poolIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`poolIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiredProvisionPools
Description	Clears the required provision pools.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueConstrainerFormRecord
Description	Gets the `QueueConstrainerFormRecord` corresponding to the given queue constrainer record `Type`.
Parameters	`osid.type.Type`	`queueConstrainerRecordType`	a queue constrainer record type
Return	`osid.provisioning.rules.records.QueueConstrainerFormRecord`		the queue constrainer form 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.