OSID - osid.workflow.WorkflowEvent Service Interface Definition

Interface	osid.workflow.WorkflowEvent
Implements	`osid.OsidObject`
Description	A `WorkflowEvent` is a change in a workflow.
Method	getTimestamp
Description	Gets the timestamp of this event.
Return	`osid.calendaring.DateTime`		the timestamp
Compliance	`mandatory`		This method must be implemented.
Method	getProcessId
Description	Gets the `Id` of the process.
Return	`osid.id.Id`		the process `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProcess
Description	Gets the process.
Return	`osid.workflow.Process`		the process
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getWorkerId
Description	Gets the `Id` of the resource that caused this event.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getWorker
Description	Gets the resource that caused this event.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getWorkingAgentId
Description	Gets the `Id` of the agent that caused this event.
Return	`osid.id.Id`		the agent `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkingAgent
Description	Gets the agent that caused this event.
Return	`osid.authentication.Agent`		the agent
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getWorkId
Description	Gets the `Id` of the work.
Return	`osid.id.Id`		the work `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getWork
Description	Gets the work.
Return	`osid.workflow.Work`		the work
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	didCancel
Description	Tests if this work event indicates the work has been canceled the workflow and is not associated with a step at the time of this event.
Return	`boolean`		`true` if the work canceled, `false` if the work is associated with a step in this event
Compliance	`mandatory`		This method must be implemented.
Method	getStepId
Description	Gets the `Id` of the step at which the work is in at the time of this event.
Return	`osid.id.Id`		the step `Id`
Errors	ILLEGAL_STATE		`didComplete()` or `didCancel()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStep
Description	Gets the step at which the work is in at the time of this event.
Return	`osid.workflow.Step`		the step
Errors	ILLEGAL_STATE		`didComplete()` or `didCancel()` is `true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventRecord
Description	Gets the workflow event record corresponding to the given `WorkflowEvent` record `Type.` This method is used to retrieve an object implementing the requested record. The `workflowEventRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(workflowEventRecordType)` is `true` .
Parameters	`osid.type.Type`	`workFlowRecordType`	the type of workflow event record to retrieve
Return	`osid.workflow.records.WorkflowEventRecord`		the workflow event record
Errors	NULL_ARGUMENT		`workRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(workflowEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.