Enum WorkRequirementStatus

java.lang.Object
java.lang.Enum<WorkRequirementStatus>
co.yellowdog.platform.model.WorkRequirementStatus
All Implemented Interfaces:
Serializable, Comparable<WorkRequirementStatus>, java.lang.constant.Constable
public enum WorkRequirementStatus extends Enum<WorkRequirementStatus>
Describes the status of a work requirement.
The status of a work requirement provides an aggregated view of the statuses of the task groups within that requirement.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANCELLED
    The work requirement has been explicitly cancelled by the user.
    CANCELLING
    The work requirement is in the process of cancelling, once no task groups are currently executing the status will become CANCELLED.
    COMPLETED
    All task groups in the work requirement have been completed.
    FAILED
    All task groups in the work requirement have been finished but at least one has failed.
    HELD
    The work requirement has been held by the user and no further tasks will be executed until it is resumed.
    RUNNING
    The work requirement is in progress and its tasks can be executed.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isFinished()
    Returns true, if the status indicates the work requirement is finished; otherwise, false.
    static WorkRequirementStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static WorkRequirementStatus[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • RUNNING

      public static final WorkRequirementStatus RUNNING
      The work requirement is in progress and its tasks can be executed.

    • HELD

      public static final WorkRequirementStatus HELD
      The work requirement has been held by the user and no further tasks will be executed until it is resumed. Task group resources (e.g. Workers) will be released.

    • COMPLETED

      public static final WorkRequirementStatus COMPLETED
      All task groups in the work requirement have been completed.

    • FAILED

      public static final WorkRequirementStatus FAILED
      All task groups in the work requirement have been finished but at least one has failed.

    • CANCELLING

      public static final WorkRequirementStatus CANCELLING
      The work requirement is in the process of cancelling, once no task groups are currently executing the status will become CANCELLED.

    • CANCELLED

      public static final WorkRequirementStatus CANCELLED
      The work requirement has been explicitly cancelled by the user.

  • Method Details

    • values

      public static WorkRequirementStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static WorkRequirementStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • isFinished

      public boolean isFinished()
      Returns true, if the status indicates the work requirement is finished; otherwise, false.
      Returns:
      true, if the status indicates the work requirement is finished; otherwise, false