OSID - osid.provisioning.QueueForm Service Interface Definition

Interface	osid.provisioning.QueueForm
Implements	`osid.OsidGovernatorForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.provisioning.batch.QueueBatchForm`
Used By	`osid.provisioning.QueueAdminSession`
Description	This is the form for creating and updating `Queues`.Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `QueueAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints. Some data may be automatically derived from the queue segments.
Method	getCanSpecifyProvisionableMetadata
Description	Gets the metadata for the can request provisionables flag.
Return	`osid.Metadata`		metadata for the can request provisionables flag
Compliance	`mandatory`		This method must be implemented.
Method	setCanSpecifyProvisionable
Description	Sets the can request provisionables flag.
Parameters	`cardinal`	`canRequest`	the new can request provisionables flag
Errors	INVALID_ARGUMENT		`canRequest` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCanSpecifyProvisionable
Description	Removes the can request provisionables flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getManagersMetadata
Description	Gets the metadata for the managers.
Return	`osid.Metadata`		metadata for the managers
Compliance	`mandatory`		This method must be implemented.
Method	setManagers
Description	Sets the managers.
Parameters	`osid.id.IdList`	`managerIds`	the manager `Ids`
Errors	INVALID_ARGUMENT		`managerIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`managerIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearManagers
Description	Removes the managers.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueFormRecord
Description	Gets the `QueueFormRecord` corresponding to the given queue record `Type`.
Parameters	`osid.type.Type`	`queueRecordType`	a queue record type
Return	`osid.provisioning.records.QueueFormRecord`		the queue form record
Errors	NULL_ARGUMENT		`queueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.