Package com.appiancorp.suiteapi.autoscale.process.instance

Enum Class ProcessState

java.lang.Object
java.lang.Enum<ProcessState>
com.appiancorp.suiteapi.autoscale.process.instance.ProcessState
All Implemented Interfaces:
Serializable, Comparable<ProcessState>, Constable
public enum ProcessState extends Enum<ProcessState>
ProcessState represents the state of a process. Not all process states are visible in all environments. Note: Only process models with autoscaling mode enabled are compatible with this enum.

  • Enum Constant Details

    • ACTIVE

      public static final ProcessState ACTIVE
      Active process. The process has started and is either currently running or it has started running and is eligible to continue to run. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • ARCHIVED_AND_DELETED

      public static final ProcessState ARCHIVED_AND_DELETED
      The process has been archived and deleted. You may not be able to distinguish anything further about this process. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • CANCELLED

      public static final ProcessState CANCELLED
      The process has been cancelled. It cannot be restarted. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • COMPLETED

      public static final ProcessState COMPLETED
      Process has completed, but has not yet been deleted. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • STOPPED

      public static final ProcessState STOPPED
      The process has been stopped without completing. It is no longer in an Active state. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • DELETED

      public static final ProcessState DELETED
      The process has been deleted. You may not be able to distinguish anything further about this process. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • ERROR_RETRIEVING_STATE

      public static final ProcessState ERROR_RETRIEVING_STATE
      This status should never be returned, but would be if the pp!status could not be retrieved from storage, such as due to a connection error. A log message should be generated if this is returned. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • INVALID_STATUS_CODE

      public static final ProcessState INVALID_STATUS_CODE
      This status should never be returned, but would be if the pp!status were set to an invalid value. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • PAUSED

      public static final ProcessState PAUSED
      The process has been paused. It will not make further progress until resumed. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • PAUSED_BY_EXCEPTION

      public static final ProcessState PAUSED_BY_EXCEPTION
      The process is paused by an exception. It could be resumed if the cause of the exception is resolved. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • REQUESTED

      public static final ProcessState REQUESTED
      The process instance has been REQUESTED, but the process has not yet been picked up by the queue and started. This state allows one to distinguish a requested, but not yet started, process vs. one that has completed and deleted its data. (autoscaled process only) Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • TERMINATING

      public static final ProcessState TERMINATING
      The process is terminating, but the end node has not yet completed. Note: Only process models with autoscaling mode enabled are compatible with this constant.

    • UNFINISHED

      public static final ProcessState UNFINISHED
      The process is unfinished, in that the parent process ended before this process ended. Note: Only process models with autoscaling mode enabled are compatible with this constant.

  • Method Details

    • values

      public static ProcessState[] 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 ProcessState 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

    • getCode

      public int getCode()
      Note: Only process models with autoscaling mode enabled are compatible with this function.
      Returns:
      code number for this state

    • validToDelete

      public boolean validToDelete()

    • validToWaitOn

      public boolean validToWaitOn()

    • getProcessState

      public static ProcessState getProcessState(int code)
      Note: Only process models with autoscaling mode enabled are compatible with this function.
      Parameters:
      code -
      Returns:
      the code number converted into a ProcessState