public final class LifecycleChangeFlags
extends java.lang.Object
implements java.io.Serializable
flags
parameter of a document or a task's changeState
method.changeState
,
Serialized FormModifier and Type | Field and Description |
---|---|
static LifecycleChangeFlags |
CLEAR_EXCEPTION
Remove the document or task from the exception state, and set the document's IsInExceptionState property to
false . |
static int |
CLEAR_EXCEPTION_AS_INT
An
int value associated with the CLEAR_EXCEPTION instance of this class. |
static LifecycleChangeFlags |
DEMOTE
Demote the document’s current lifecycle state to the previous state in its document lifecycle policy, and set the document's
CurrentState property to the name of the previous state, unless the CanBeDemoted property of the document’s
current lifecycle state (
DocumentState object) is set to false . |
static int |
DEMOTE_AS_INT
An
int value associated with the DEMOTE instance of this class. |
static LifecycleChangeFlags |
PROMOTE
Promote the document’s current lifecycle state to the next state in its document lifecycle policy and set the document's
CurrentState property to the name of the next state.
|
static int |
PROMOTE_AS_INT
An
int value associated with the PROMOTE instance of this class. |
static LifecycleChangeFlags |
RESET
Reset the document’s current lifecycle state to the initial state in its document lifecycle policy, and set the document's
CurrentState property to the name of the initial state.
|
static int |
RESET_AS_INT
An
int value associated with the RESET instance of this class. |
static LifecycleChangeFlags |
SET_EXCEPTION
Place the document into the exception state and set its IsInExceptionState property to
true . |
static int |
SET_EXCEPTION_AS_INT
An
int value associated with the SET_EXCEPTION instance of this class. |
Modifier and Type | Method and Description |
---|---|
static LifecycleChangeFlags |
getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.
|
int |
getValue()
Returns the internal integer value associated with a specific instance of this class.
|
java.lang.String |
toString()
Returns a
String representation of this enumeration instance. |
public static final int SET_EXCEPTION_AS_INT
int
value associated with the SET_EXCEPTION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final LifecycleChangeFlags SET_EXCEPTION
true
.
Place the task into the exception state.
public static final int PROMOTE_AS_INT
int
value associated with the PROMOTE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final LifecycleChangeFlags PROMOTE
Promote the task's current state to the next state.
public static final int CLEAR_EXCEPTION_AS_INT
int
value associated with the CLEAR_EXCEPTION instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final LifecycleChangeFlags CLEAR_EXCEPTION
false
.public static final int DEMOTE_AS_INT
int
value associated with the DEMOTE instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final LifecycleChangeFlags DEMOTE
DocumentState
object) is set to false
.
Demote the task's current state to the previous state.
public static final int RESET_AS_INT
int
value associated with the RESET instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.public static final LifecycleChangeFlags RESET
This flag does not apply to CmTask
objects.
public int getValue()
getInstanceFromInt(int)
public java.lang.String toString()
String
representation of this enumeration instance.toString
in class java.lang.Object
public static LifecycleChangeFlags getInstanceFromInt(int value)
value
- The integer value. (See the *_AS_INT fields.)EngineRuntimeException
- If an enumeration instance with the given
ordinal value does not exist.getValue()
© Copyright IBM Corporation 2006, 2015. All rights reserved.