OSID - osid.workflow.ProcessForm Service Interface Definition

Interface	osid.workflow.ProcessForm
Implements	`osid.OsidGovernatorForm`
Implemented By	`osid.workflow.batch.ProcessBatchForm`
Used By	`osid.workflow.ProcessAdminSession`
Description	This is the form for creating and updating `Processes`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `ProcessAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getOwnersMetadata
Description	Gets the metadata for the owners.
Return	`osid.Metadata`		metadata for the owners
Compliance	`mandatory`		This method must be implemented.
Method	setOwners
Description	Sets the owners.
Parameters	`osid.id.IdList`	`ownerIds`	the new owners
Errors	INVALID_ARGUMENT		`ownerIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`ownerIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOwners
Description	Removes the owners.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEnabledMetadata
Description	Gets the metadata for the enabled flag.
Return	`osid.Metadata`		metadata for the enabled flag
Compliance	`mandatory`		This method must be implemented.
Method	setEnabled
Description	Sets the enabled flag.
Parameters	`boolean`	`enabled`	the new enabled flag
Errors	INVALID_ARGUMENT		`enabled` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearEnabled
Description	Removes the enabled flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInitialStepMetadata
Description	Gets the metadata for the initial step.
Return	`osid.Metadata`		metadata for the initial step
Compliance	`mandatory`		This method must be implemented.
Method	setInitialStep
Description	Sets the initial step.
Parameters	`osid.id.Id`	`stepId`	the new initial step
Errors	INVALID_ARGUMENT		`stepId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stepId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInitialStep
Description	Removes the initial step.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInitialStateMetadata
Description	Gets the metadata for the initial state.
Return	`osid.Metadata`		metadata for the initial state
Compliance	`mandatory`		This method must be implemented.
Method	setInitialState
Description	Sets the initial state.
Parameters	`osid.id.Id`	`stateId`	the new initial state
Errors	INVALID_ARGUMENT		`stateId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`stateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInitialState
Description	Removes the initial state.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessFormRecord
Description	Gets the `ProcessFormRecord` corresponding to the given process record `Type`.
Parameters	`osid.type.Type`	`processRecordType`	a process record type
Return	`osid.workflow.records.ProcessFormRecord`		the process form record
Errors	NULL_ARGUMENT		`processRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(processRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.