OSID - osid.workflow.event.WorkflowEventForm Service Interface Definition

Interface	osid.workflow.event.WorkflowEventForm
Implements	`osid.OsidObjectForm`
Used By	`osid.workflow.event.WorkflowEventAdminSession`
Description	This is the form for creating and updating `WorkflowEvents`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `WorkflowEventAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTimestampMetadata
Description	Gets the metadata for a timestamp.
Return	`osid.Metadata`		metadata for the date
Compliance	`mandatory`		This method must be implemented.
Method	setTimestamp
Description	Sets the timestamp.
Parameters	`osid.calendaring.DateTime`	`date`	the new timestamp
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimestamp
Description	Clears the timestamp.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessMetadata
Description	Gets the metadata for a process.
Return	`osid.Metadata`		metadata for the process
Compliance	`mandatory`		This method must be implemented.
Method	setProcess
Description	Sets the process.
Parameters	`osid.id.Id`	`processId`	the new process
Errors	INVALID_ARGUMENT		`processId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`processId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcess
Description	Clears the process.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkerMetadata
Description	Gets the metadata for a worker.
Return	`osid.Metadata`		metadata for the worker
Compliance	`mandatory`		This method must be implemented.
Method	setWorker
Description	Sets the resource.
Parameters	`osid.id.Id`	`resourceId`	the new worker resource
Errors	INVALID_ARGUMENT		`resourceId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorker
Description	Clears the worker.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkingAgentMetadata
Description	Gets the metadata for a working agent.
Return	`osid.Metadata`		metadata for the worker
Compliance	`mandatory`		This method must be implemented.
Method	setWorkingAgent
Description	Sets the agent.
Parameters	`osid.id.Id`	`agentId`	the new working agent
Errors	INVALID_ARGUMENT		`agentId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWorkingAgent
Description	Clears the working agent.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkMetadata
Description	Gets the metadata for a work.
Return	`osid.Metadata`		metadata for the work
Compliance	`mandatory`		This method must be implemented.
Method	setWork
Description	Sets the work.
Parameters	`osid.id.Id`	`workId`	the new work
Errors	INVALID_ARGUMENT		`workId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`workId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWork
Description	Clears the work.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCanceledMetadata
Description	Gets the metadata for a canceled.
Return	`osid.Metadata`		metadata for the canceled
Compliance	`mandatory`		This method must be implemented.
Method	setCanceled
Description	Sets the canceled flag.
Parameters	`boolean`	`canceled`	the new canceled flag
Errors	INVALID_ARGUMENT		`canceled` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	cleaCanceled
Description	Clears the canceled flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStepMetadata
Description	Gets the metadata for a step.
Return	`osid.Metadata`		metadata for the step
Compliance	`mandatory`		This method must be implemented.
Method	setStep
Description	Sets the step.
Parameters	`osid.id.Id`	`stepId`	the new 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	cleaStep
Description	Clears the step.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventFormRecord
Description	Gets the `WorkflowEventFormRecord` corresponding to the given workflow event record `Type`.
Parameters	`osid.type.Type`	`workflowEventRecordType`	a workflow event record type
Return	`osid.workflow.event.records.WorkflowEventFormRecord`		the workflow event form record
Errors	NULL_ARGUMENT		`workflowEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(workflowEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.