public interface WorkflowEvent extends OsidObject
A WorkflowEvent
is a change in a workflow.
Modifier and Type | Method and Description |
---|---|
boolean |
didCancel()
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.
|
Process |
getProcess()
Gets the process.
|
Id |
getProcessId()
Gets the
Id of the process. |
Step |
getStep()
Gets the step at which the work is in at the time of this event.
|
Id |
getStepId()
Gets the
Id of the step at which the work is in at the
time of this event. |
DateTime |
getTimestamp()
Gets the timestamp of this event.
|
Work |
getWork()
Gets the work.
|
Resource |
getWorker()
Gets the resource that caused this event.
|
Id |
getWorkerId()
Gets the
Id of the resource that caused this event. |
WorkflowEventRecord |
getWorkflowEventRecord(Type workFlowRecordType)
Gets the workflow event record corresponding to the given
WorkflowEvent record Type. |
Id |
getWorkId()
Gets the
Id of the work. |
Agent |
getWorkingAgent()
Gets the agent that caused this event.
|
Id |
getWorkingAgentId()
Gets the
Id of the agent that caused this event. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DateTime getTimestamp()
mandatory
- This method must be implemented. Id getProcessId()
Id
of the process. Id
mandatory
- This method must be implemented. Process getProcess() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getWorkerId()
Id
of the resource that caused this event. Id
mandatory
- This method must be implemented. Resource getWorker() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getWorkingAgentId()
Id
of the agent that caused this event. Id
mandatory
- This method must be implemented. Agent getWorkingAgent() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getWorkId()
Id
of the work. Id
mandatory
- This method must be implemented. Work getWork() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean didCancel()
true
if the work canceled, false
if the work is associated with a step in this eventmandatory
- This method must be implemented. Id getStepId()
Id
of the step at which the work is in at the
time of this event. Id
IllegalStateException
- didComplete()
or
didCancel()
is true
mandatory
- This method must be implemented. Step getStep() throws OperationFailedException
IllegalStateException
- didComplete()
or
didCancel()
is true
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. WorkflowEventRecord getWorkflowEventRecord(Type workFlowRecordType) throws OperationFailedException
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
.workFlowRecordType
- the type of workflow event record to
retrieveNullArgumentException
- workRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(workflowEventRecordType)
is false
mandatory
- This method must be implemented.