Class TaskEvent


  • public class TaskEvent
    extends java.lang.Object
    Event when a task was added, modified, deleted, activated, deactivated, started or execution finished.
    Since:
    taskplanner 3.0
    • Constructor Detail

      • TaskEvent

        public TaskEvent​(@Nonnull
                         TaskEvent.TaskEventType type,
                         @Nonnull
                         com.inet.id.GUID taskID)
        Creates a new TaskEvent instance.
        Parameters:
        type - the type for this event
        taskID - the task the event is for
        Throws:
        java.lang.IllegalArgumentException - if type or taskID is null.
        Since:
        taskplanner 3.0
      • TaskEvent

        public TaskEvent​(@Nonnull
                         TaskEvent.TaskEventType type,
                         @Nonnull
                         com.inet.id.GUID taskID,
                         @Nonnull
                         com.inet.id.GUID executionID)
        Creates a new TaskEvent instance.
        Parameters:
        type - the type for this event
        taskID - the task the event is for
        executionID - ID of the execution the event is about
        Throws:
        java.lang.IllegalArgumentException - if type or taskID is null.
        Since:
        taskplanner 22.10
      • TaskEvent

        public TaskEvent​(int progress,
                         @Nonnull
                         com.inet.id.GUID taskID,
                         @Nonnull
                         com.inet.id.GUID executionID)
        Creates a new TaskEvent instance with a fixed type of TaskEvent.TaskEventType.PROGRESS
        Parameters:
        progress - the progress of the current execution of the task, a value in range of [0..100]
        taskID - the task the event is for
        executionID - ID of the execution the event is about
        Throws:
        java.lang.IllegalArgumentException - if type or taskID is null.
        Since:
        taskplanner 22.10
    • Method Detail

      • getType

        @Nonnull
        public TaskEvent.TaskEventType getType()
        Get the type of this event.
        Returns:
        the type of this event
        Since:
        taskplanner 3.0
      • getTaskID

        @Nonnull
        public com.inet.id.GUID getTaskID()
        Get the ID of the task this event is about.
        Returns:
        ID of the corresponding task.
        Since:
        taskplanner 3.0
      • getProgress

        public int getProgress()
        Returns the progress of the current task execution in case getType() returns TaskEvent.TaskEventType.PROGRESS
        Returns:
        the progress of the current task execution, a percentage value in range [0..100]
        Since:
        taskplanner 3.0
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object