Interface HistoryEntry

public interface HistoryEntry
Holds information about one execution of a TaskExecution.
The execution may, but does not need to, be already finished.
Since:
taskplanner 3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    List<String>
    getErrors()
    Returns the list of errors of this execution.
    int
    getExecutedSeriesCount()
    Returns the number of series data sets that were executed if the task has a series configured.
    long
    getExecutionFinishTime()
    Returns the executionFinishTime of this Execution in milliseconds since January 1, 1970, 00:00:00 GMT.
    The value can be 0 if the execution is still running or -1 if the execution did not finish normally.
    com.inet.id.GUID
    getExecutionId()
    Get the ID uniquely identifying this execution.
    long
    getExecutionStartTime()
    Returns the time when execution was started in milliseconds since January 1, 1970, 00:00:00 GMT.
    int
    getProgress()
    Returns the progress of the task [0..100].
    List<String>
    getSkippedResultActions()
    Returns the list of IDs of result actions that were not executed because their conditions were not fulfilled.
    default boolean
    isManualExecution()
    Returns whether this execution was started manually (for example via the web GUI or API execution call).

  • Method Details

    • getErrors

      List<String> getErrors()
      Returns the list of errors of this execution.
      Returns:
      the list of errors.
      Since:
      taskplanner 3.0

    • getSkippedResultActions

      List<String> getSkippedResultActions()
      Returns the list of IDs of result actions that were not executed because their conditions were not fulfilled.
      Returns:
      the ids of result actions that were skipped.
      Since:
      taskplanner 3.0

    • getExecutedSeriesCount

      int getExecutedSeriesCount()
      Returns the number of series data sets that were executed if the task has a series configured. If no series is defined, -1 is returned.
      Returns:
      the number of series data sets, or -1 if the task has no series.
      Since:
      taskplanner 3.0

    • getExecutionStartTime

      long getExecutionStartTime()
      Returns the time when execution was started in milliseconds since January 1, 1970, 00:00:00 GMT.
      Returns:
      the executionStartTime
      Since:
      taskplanner 3.0

    • getExecutionFinishTime

      long getExecutionFinishTime()
      Returns the executionFinishTime of this Execution in milliseconds since January 1, 1970, 00:00:00 GMT.
      The value can be 0 if the execution is still running or -1 if the execution did not finish normally.
      Returns:
      the executionFinishTime
      Since:
      taskplanner 3.0

    • getProgress

      int getProgress()
      Returns the progress of the task [0..100]. -1 means that the task has no progress, e.g. when not running.
      Returns:
      the progress of the task.
      Since:
      taskplanner 3.0

    • getExecutionId

      com.inet.id.GUID getExecutionId()
      Get the ID uniquely identifying this execution. There can be many executions for one and the same task.
      Returns:
      the ID, not null.
      Since:
      taskplanner 22.10

    • isManualExecution

      default boolean isManualExecution()
      Returns whether this execution was started manually (for example via the web GUI or API execution call).
      Returns:
      true if this execution was started manually, otherwise false
      Since:
      taskplanner 26.10