Package com.bonitasoft.processbuilder.enums

Enum Class ProcessStateType

java.lang.Object
java.lang.Enum<ProcessStateType>
com.bonitasoft.processbuilder.enums.ProcessStateType
All Implemented Interfaces:
Serializable, Comparable<ProcessStateType>, Constable
public enum ProcessStateType extends Enum<ProcessStateType>
Defines the possible lifecycle states for a Process Definition (PBProcess). Includes main execution states and an optional health indicator.

  • 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
    ARCHIVED
    The process definition is marked as historical and is no longer used.
    DRAFT
    The process definition is currently being edited and is not available for execution.
    HEALTHY
    The optional indicator state: the process definition is fully operational and healthy.
    IN_ERROR
    The optional indicator state: the process definition has known operational issues (e.g., failed instances).
    RUNNING
    The process definition is active and ready to be instantiated.
    STOPPED
    The process definition has been disabled and cannot be instantiated.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,String>
    getAllData()
    Retrieves all process 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 ProcessStateType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ProcessStateType[]
    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

    • DRAFT

      public static final ProcessStateType DRAFT
      The process definition is currently being edited and is not available for execution.

    • RUNNING

      public static final ProcessStateType RUNNING
      The process definition is active and ready to be instantiated.

    • STOPPED

      public static final ProcessStateType STOPPED
      The process definition has been disabled and cannot be instantiated.

    • ARCHIVED

      public static final ProcessStateType ARCHIVED
      The process definition is marked as historical and is no longer used.

    • HEALTHY

      public static final ProcessStateType HEALTHY
      The optional indicator state: the process definition is fully operational and healthy.

    • IN_ERROR

      public static final ProcessStateType IN_ERROR
      The optional indicator state: the process definition has known operational issues (e.g., failed instances).

  • Method Details

    • values

      public static ProcessStateType[] 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 ProcessStateType 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 (e.g., " draft ", "Running").
      Returns:
      true if the string is a valid enum constant, false otherwise.

    • getAllData

      public static Map<String,String> getAllData()
      Retrieves all process 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.