OSID - osid.subscription.DispatchForm Service Interface Definition

Interface	osid.subscription.DispatchForm
Implements	`osid.OsidGovernatorForm`
Implemented By	`osid.subscription.batch.DispatchBatchForm`
Used By	`osid.subscription.DispatchAdminSession`
Description	This is the form for creating and updating `Dispatches` . Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `DispatchAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getEditorsMetadata
Description	Gets the metadata for the editors.
Return	`osid.Metadata`		metadata for the editors
Compliance	`mandatory`		This method must be implemented.
Method	setEditors
Description	Sets the editors.
Parameters	`osid.id.IdList`	`editorIds`	the new editors
Errors	INVALID_ARGUMENT		`editorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`editorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEditors
Description	Removes the editors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchFormRecord
Description	Gets the `DispatchFormRecord` corresponding to the given dispatch record `Type` .
Parameters	`osid.type.Type`	`dispatchRecordType`	the dispatch record type
Return	`osid.subscription.records.DispatchFormRecord`		the dispatch form record
Errors	NULL_ARGUMENT		`dispatchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(dispatchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.