TerminationReasonEnum (LSPS 3.3 SDK)

java.lang.Object
- java.lang.Enum<TerminationReasonEnum>
- - com.whitestein.lsps.engine.TerminationReasonEnum

All Implemented Interfaces:

Serializable, Comparable<TerminationReasonEnum>
```
public enum TerminationReasonEnum
extends Enum<TerminationReasonEnum>
```
Enumeration of reasons of a task termination

Author:

bhl

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COMPLETED` Task was completed.
`PLAN_DEACTIVATED` Task was interrupted because parent plan was deactivated.
`PROCESS_DEACTIVATED` Task was interrupted because parent process was deactivated.
`PROCESS_MODEL_UPDATE` Task was interrupted because model was updated.
`TERMINATED_BY_CANCEL` Task was interrupted by a cancel event.
`TERMINATED_BY_CONDITION` Task was interrupted by a condition.
`TERMINATED_BY_ERROR` Task was interrupted by an error.
`TERMINATED_BY_ESCALATION` Task was interrupted by a received escalation.
`TERMINATED_BY_PARALLEL_COMPLETITION` Task was interrupted by parallel completion.
`TERMINATED_BY_SIGNAL` Task was interrupted by a received signal.
`TERMINATED_BY_TIMEOUT` Task was interrupted by a timeout.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Returns the escalation description.
`boolean`	`isAccomplished()` Returns true if the execution was successfully accomplished.
`static TerminationReasonEnum`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TerminationReasonEnum[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - COMPLETED
```
public static final TerminationReasonEnum COMPLETED
```
    Task was completed.
  - TERMINATED_BY_TIMEOUT
```
public static final TerminationReasonEnum TERMINATED_BY_TIMEOUT
```
    Task was interrupted by a timeout.
  - TERMINATED_BY_SIGNAL
```
public static final TerminationReasonEnum TERMINATED_BY_SIGNAL
```
    Task was interrupted by a received signal.
  - TERMINATED_BY_ESCALATION
```
public static final TerminationReasonEnum TERMINATED_BY_ESCALATION
```
    Task was interrupted by a received escalation.
  - TERMINATED_BY_CONDITION
```
public static final TerminationReasonEnum TERMINATED_BY_CONDITION
```
    Task was interrupted by a condition.
  - TERMINATED_BY_ERROR
```
public static final TerminationReasonEnum TERMINATED_BY_ERROR
```
    Task was interrupted by an error.
  - TERMINATED_BY_CANCEL
```
public static final TerminationReasonEnum TERMINATED_BY_CANCEL
```
    Task was interrupted by a cancel event.
  - TERMINATED_BY_PARALLEL_COMPLETITION
```
public static final TerminationReasonEnum TERMINATED_BY_PARALLEL_COMPLETITION
```
    Task was interrupted by parallel completion.
  - PROCESS_DEACTIVATED
```
public static final TerminationReasonEnum PROCESS_DEACTIVATED
```
    Task was interrupted because parent process was deactivated.
  - PLAN_DEACTIVATED
```
public static final TerminationReasonEnum PLAN_DEACTIVATED
```
    Task was interrupted because parent plan was deactivated.
  - PROCESS_MODEL_UPDATE
```
public static final TerminationReasonEnum PROCESS_MODEL_UPDATE
```
    Task was interrupted because model was updated.
- Method Detail
  - values
```
public static TerminationReasonEnum[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (TerminationReasonEnum c : TerminationReasonEnum.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TerminationReasonEnum valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getDescription
```
public String getDescription()
```
    Returns the escalation description.
    
    Returns:
    
    the escalation description
  - isAccomplished
```
public boolean isAccomplished()
```
    Returns true if the execution was successfully accomplished.
    
    Returns:
    
    true if the execution was successfully accomplished

Enum TerminationReasonEnum

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

COMPLETED

TERMINATED_BY_TIMEOUT

TERMINATED_BY_SIGNAL

TERMINATED_BY_ESCALATION

TERMINATED_BY_CONDITION

TERMINATED_BY_ERROR

TERMINATED_BY_CANCEL

TERMINATED_BY_PARALLEL_COMPLETITION

PROCESS_DEACTIVATED

PLAN_DEACTIVATED

PROCESS_MODEL_UPDATE

Method Detail

values

valueOf

getDescription

isAccomplished