Package com.bonitasoft.processbuilder.enums

Enum Class ProcessInstanceStateType

java.lang.Object
java.lang.Enum<ProcessInstanceStateType>
com.bonitasoft.processbuilder.enums.ProcessInstanceStateType
All Implemented Interfaces:
Serializable, Comparable<ProcessInstanceStateType>, Constable
public enum ProcessInstanceStateType extends Enum<ProcessInstanceStateType>
Defines the possible lifecycle states for a Process Instance (PBProcessInstance). Includes execution, termination, and future placeholder states.

  • 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
    Future state: The instance is moved to historical records for dashboard performance.
    CANCELED
    The instance was manually terminated before completion.
    COMPLETED
    The instance has successfully completed its final step.
    FAILED
    The instance failed due to a severe system or business error.
    ORPHAN
    The process instance is orphaned because its parent Bonita process definition was deleted.
    PAUSED
    Future state: The instance has been manually suspended and is awaiting restart.
    RUNNING
    The instance is currently active and processing steps.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Map<String,String>
    getAllData()
    Retrieves all process 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 ProcessInstanceStateType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ProcessInstanceStateType[]
    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 ProcessInstanceStateType RUNNING
      The instance is currently active and processing steps.

    • COMPLETED

      public static final ProcessInstanceStateType COMPLETED
      The instance has successfully completed its final step.

    • CANCELED

      public static final ProcessInstanceStateType CANCELED
      The instance was manually terminated before completion.

    • FAILED

      public static final ProcessInstanceStateType FAILED
      The instance failed due to a severe system or business error.

    • PAUSED

      public static final ProcessInstanceStateType PAUSED
      Future state: The instance has been manually suspended and is awaiting restart.

    • ARCHIVED

      public static final ProcessInstanceStateType ARCHIVED
      Future state: The instance is moved to historical records for dashboard performance.

    • ORPHAN

      public static final ProcessInstanceStateType ORPHAN
      The process instance is orphaned because its parent Bonita process definition was deleted.

      This state indicates that the process instance can no longer be managed through standard Bonita workflows because the underlying process definition no longer exists. These instances typically require manual intervention or cleanup procedures.

  • Method Details

    • values

      public static ProcessInstanceStateType[] 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 ProcessInstanceStateType 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 process 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.