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

Interface	osid.provisioning.rules.QueueProcessorForm
Implements	`osid.OsidProcessorForm`
Used By	`osid.provisioning.rules.QueueProcessorAdminSession`
Description	This is the form for creating and updating `QueueProcessors`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `QueueProcessorAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getAutomaticMetadata
Description	Gets the metadata for automatic processing.
Return	`osid.Metadata`		metadata for automatic processing
Compliance	`mandatory`		This method must be implemented.
Method	setAutomatic
Description	Sets automatic processing.
Parameters	`boolean`	`auto`	`true` for automatic processing, `false` for manual processing
Errors	INVALID_ARGUMENT		`auto` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearAutomatic
Description	Removes the automatic processing flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFifoMetadata
Description	Gets the metadata for first-in-first-out processing.
Return	`osid.Metadata`		metadata for fifo processing
Compliance	`mandatory`		This method must be implemented.
Method	setFifo
Description	Sets first-in-first-out processing
Parameters	`boolean`	`fifo`	`true` for fifo processing, `false` otherwise
Errors	INVALID_ARGUMENT		`fifo` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearFifo
Description	Removes the fifo flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRemovesProcessedQueueEntriesMetadata
Description	Gets the metadata for removal of procesed queue entries.
Return	`osid.Metadata`		metadata for removing processed queue entry processing
Compliance	`mandatory`		This method must be implemented.
Method	setRemovesProcessedQueueEntries
Description	Sets removal of peocesse queue entry processing
Parameters	`boolean`	`remove`	`true` for removing processed queue entries, `false` otherwise
Errors	INVALID_ARGUMENT		`remove` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRemovesProcessedQueueEntries
Description	Removes the remove processed queue entries flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueProcessorFormRecord
Description	Gets the `QueueProcessorFormRecord` corresponding to the given queue processor record `Type`.
Parameters	`osid.type.Type`	`queueProcessorRecordType`	a queue processor record type
Return	`osid.provisioning.rules.records.QueueProcessorFormRecord`		the queue processor form record
Errors	NULL_ARGUMENT		`queueProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(queueProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.