Interface WorkflowEvent

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface WorkflowEvent extends OsidObject

A WorkflowEvent is a change in a workflow.

  • Method Details

    • getTimestamp

      DateTime getTimestamp()
      Gets the timestamp of this event.
      Returns:
      the timestamp
      Compliance:
      mandatory - This method must be implemented.

    • getProcessId

      Id getProcessId()
      Gets the Id of the process.
      Returns:
      the process Id
      Compliance:
      mandatory - This method must be implemented.

    • getProcess

      Process getProcess() throws OperationFailedException
      Gets the process.
      Returns:
      the process
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getWorkerId

      Id getWorkerId()
      Gets the Id of the resource that caused this event.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getWorker

      Resource getWorker() throws OperationFailedException
      Gets the resource that caused this event.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getWorkingAgentId

      Id getWorkingAgentId()
      Gets the Id of the agent that caused this event.
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getWorkingAgent

      Agent getWorkingAgent() throws OperationFailedException
      Gets the agent that caused this event.
      Returns:
      the agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getWorkId

      Id getWorkId()
      Gets the Id of the work.
      Returns:
      the work Id
      Compliance:
      mandatory - This method must be implemented.

    • getWork

      Work getWork() throws OperationFailedException
      Gets the work.
      Returns:
      the work
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • didCancel

      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.
      Returns:
      true if the work canceled, false if the work is associated with a step in this event
      Compliance:
      mandatory - This method must be implemented.

    • getStepId

      Id getStepId()
      Gets the Id of the step at which the work is in at the time of this event.
      Returns:
      the step Id
      Throws:
      IllegalStateException - didCancel() is true
      Compliance:
      mandatory - This method must be implemented.

    • getStep

      Step getStep() throws OperationFailedException
      Gets the step at which the work is in at the time of this event.
      Returns:
      the step
      Throws:
      IllegalStateException - didCancel() is true
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getWorkflowEventRecord

      WorkflowEventRecord getWorkflowEventRecord(Type workFlowRecordType) throws OperationFailedException
      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:
      workFlowRecordType - the type of workflow event record to retrieve
      Returns:
      the workflow event record
      Throws:
      NullArgumentException - workRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(workflowEventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.