Interface ITaskSwitchEvent


public interface ITaskSwitchEvent
A task switch is an event where tasks are joined and new tasks are created.
Since:
18.07.2007
API:
This is a public API.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the case this task switch event belongs to
    Gets the task that were ended by this task switch event.
    The timestamp when the tasks were joined and the new tasks were created.
    long
    The identifier of the task switch event
    Gets the task that were started by this task switch event.
    Gets the task element this task switch event was executed on
  • Method Details

    • getExecutionTimestamp

      Date getExecutionTimestamp()
      The timestamp when the tasks were joined and the new tasks were created.
      Returns:
      execution timestamp
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
    • getCase

      ICase getCase()
      Gets the case this task switch event belongs to
      Returns:
      case
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadOwnCaseOfTask PERMISSION OR OWNS CaseRead PERMISSION OR OWNS CaseRead@SYSTEM PERMISSION
    • getTaskElement

      ITaskElement getTaskElement()
      Gets the task element this task switch event was executed on
      Returns:
      the task switch element
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
    • getEndedTasks

      List<ITask> getEndedTasks()
      Gets the task that were ended by this task switch event. The list may be empty if this is the first task switch event on a case.
      Returns:
      list with the ended tasks
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskReadOwnCaseTasks PERMISSION OR OWNS TaskReadAll PERMISSION OR OWNS TaskReadAll@SYSTEM PERMISSION
    • getStartedTasks

      List<ITask> getStartedTasks()
      Gets the task that were started by this task switch event. The list may be empty if no task were started.
      Returns:
      list with the ended tasks
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskReadOwnCaseTasks PERMISSION OR OWNS TaskReadAll PERMISSION OR OWNS TaskReadAll@SYSTEM PERMISSION
    • getId

      long getId()
      The identifier of the task switch event
      Returns:
      the identifier
      API:
      This public API is available in Java.