Enum Class ProcessState
- All Implemented Interfaces:
Serializable
,Comparable<ProcessState>
,Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionActive process.The process has been archived and deleted.The process has been cancelled.Process has completed, but has not yet been deleted.The process has been deleted.This status should never be returned, but would be if the pp!This status should never be returned, but would be if the pp!The process has been paused.The process is paused by an exception.The process instance has been REQUESTED, but the process has not yet been picked up by the queue and started.The process has been stopped without completing.The process is terminating, but the end node has not yet completed.The process is unfinished, in that the parent process ended before this process ended. -
Method Summary
Modifier and TypeMethodDescriptionint
getCode()
Note: Only process models with autoscaling mode enabled are compatible with this function.static ProcessState
getProcessState
(int code) Note: Only process models with autoscaling mode enabled are compatible with this function.boolean
static ProcessState
Returns the enum constant of this class with the specified name.static ProcessState[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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
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
The process has been cancelled. It cannot be restarted. Note: Only process models with autoscaling mode enabled are compatible with this constant. -
COMPLETED
Process has completed, but has not yet been deleted. Note: Only process models with autoscaling mode enabled are compatible with this constant. -
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
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
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
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
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
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
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. (EPEx only) Note: Only process models with autoscaling mode enabled are compatible with this constant. -
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
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
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
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 nameNullPointerException
- 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() -
getProcessState
Note: Only process models with autoscaling mode enabled are compatible with this function.- Parameters:
code
-- Returns:
- the code number converted into a ProcessState
-