Package com.bonitasoft.processbuilder.enums

Enum Class StepProcessInstanceStateType

java.lang.Object
java.lang.Enum<StepProcessInstanceStateType>
com.bonitasoft.processbuilder.enums.StepProcessInstanceStateType
All Implemented Interfaces:
Serializable, Comparable<StepProcessInstanceStateType>, Constable
public enum StepProcessInstanceStateType extends Enum<StepProcessInstanceStateType>
Defines the possible lifecycle states for a Process Step Instance (PBStepProcessInstance).

  • 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
    CANCELED
    The step was bypassed or manually terminated.
    COMPLETED
    The human task has been successfully completed by the user (e.g., the form was submitted).
    ENDED
    The step execution finished successfully, meaning all associated actions (connectors, notifications, redirections) have been successfully processed.
    FAILED
    The step failed due to a system error (e.g., connector failure).
    PENDING
    The step is a user task awaiting assignment or completion by an actor.
    RUNNING
    The step is currently being executed or is waiting for execution in the engine.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,String>
    getAllData()
    Retrieves all step instance states as a read-only Map where the key is the technical key and the value is the description.
    static List<String>
    getAllKeysList()
    Retrieves all technical keys as a read-only List of Strings.
    String
    getDescription()
    Gets the human-readable description of the state.
    String
    getKey()
    Gets the technical key of the state.
    static boolean
    isValid(String input)
    Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
    static StepProcessInstanceStateType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static StepProcessInstanceStateType[]
    values()
    Returns an array containing the constants of this enum class, 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 StepProcessInstanceStateType RUNNING
      The step is currently being executed or is waiting for execution in the engine.

    • PENDING

      public static final StepProcessInstanceStateType PENDING
      The step is a user task awaiting assignment or completion by an actor.

    • FAILED

      public static final StepProcessInstanceStateType FAILED
      The step failed due to a system error (e.g., connector failure).

    • COMPLETED

      public static final StepProcessInstanceStateType COMPLETED
      The human task has been successfully completed by the user (e.g., the form was submitted). The step's subsequent actions are now being processed.

    • ENDED

      public static final StepProcessInstanceStateType ENDED
      The step execution finished successfully, meaning all associated actions (connectors, notifications, redirections) have been successfully processed.

    • CANCELED

      public static final StepProcessInstanceStateType CANCELED
      The step was bypassed or manually terminated.

  • Method Details

    • values

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

    • valueOf

      public static StepProcessInstanceStateType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getKey

      public String getKey()
      Gets the technical key of the state.
      Returns:
      The technical key (String).

    • getDescription

      public String getDescription()
      Gets the human-readable description of the state.
      Returns:
      The description (String).

    • isValid

      public static boolean isValid(String input)
      Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
      Parameters:
      input - The string to validate.
      Returns:
      true if the string is a valid enum constant, false otherwise.

    • getAllData

      public static Map<String,String> getAllData()
      Retrieves all step instance states as a read-only Map where the key is the technical key and the value is the description.
      Returns:
      A map containing all process state data (Key -> Description).

    • getAllKeysList

      public static List<String> getAllKeysList()
      Retrieves all technical keys as a read-only List of Strings.
      Returns:
      A list containing all technical keys.