Interface TaskExecution

public interface TaskExecution
Contains internal, non-configurable information about a planned task

All configurable values can be found in the TaskDefinition. An object of TaskExecution only exists for already saved tasks.

This is just a snapshot, changes from other users or the TaskPlanner are not reflected in one TaskExecution instance.

See TaskDefinition on how to create new tasks.

Since:
taskplanner 3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    ExecutionHistory
    getExecutionHistory()
    Returns the execution history of this task.
    This contains information about past and possibly current executions.
    long
    getLastModified()
    Gets the time in ms since January 1, 1970 00:00:00.000 GMT when this task was last changed.
    This only counts modifications of the settings, not manual or automatic executions.
    com.inet.id.GUID
    getOwnerId()
    Gets the ID of the user owning this task.
    Map<String,String>
    getStateProperties()
    Returns a live, modifiable map of properties for this task's execution that enables task components to maintain state, for example, triggers might store what they have already checked.
    com.inet.id.GUID
    getTaskID()
    Get the unique ID of this task.
    boolean
    isRunning()
    Checks whether this task is currently running (one or more executions).

  • Method Details

    • getTaskID

      com.inet.id.GUID getTaskID()
      Get the unique ID of this task. This can be used to read, update, execute or delete this task.
      Returns:
      the unique ID of this task which can be used to read, update, execute or delete this task.
      Since:
      taskplanner 3.0

    • getOwnerId

      com.inet.id.GUID getOwnerId()
      Gets the ID of the user owning this task.
      Returns:
      the ID of the task owner.
      Since:
      taskplanner 3.2

    • getLastModified

      long getLastModified()
      Gets the time in ms since January 1, 1970 00:00:00.000 GMT when this task was last changed.
      This only counts modifications of the settings, not manual or automatic executions.
      Returns:
      last modified date in ms since January 1, 1970 00:00:00.000 GMT.
      Since:
      taskplanner 3.0

    • getExecutionHistory

      ExecutionHistory getExecutionHistory()
      Returns the execution history of this task.
      This contains information about past and possibly current executions.
      Returns:
      the executionHistory
      Since:
      taskplanner 3.0

    • isRunning

      boolean isRunning()
      Checks whether this task is currently running (one or more executions).

      Note that in a cloud environment with many nodes, a task may be running on any node and this returns true even if the task is running on another node. Keep in mind that if another node starts this task, no guarantees or assumptions can be made about when the return value of this method on this node changes from false to true. However, it is guaranteed that the execution on the other node is reflected in getExecutionHistory() at the same time as this method reflects that change.

      Note that this object is a snapshot which does not reflect future changes, so the return value will never change.

      Returns:
      true if this task is running; otherwise, false
      Since:
      taskplanner 3.0

    • getStateProperties

      Map<String,String> getStateProperties()
      Returns a live, modifiable map of properties for this task's execution that enables task components to maintain state, for example, triggers might store what they have already checked.
      Returns:
      map of state properties, never null
      Since:
      taskplanner 4.1