LifecycleChangeFlags

java.lang.Object
- com.filenet.api.constants.LifecycleChangeFlags

All Implemented Interfaces:

java.io.Serializable
```
public final class LifecycleChangeFlags
extends java.lang.Object
implements java.io.Serializable
```
Provides a set of constants that specify how to change a document's current lifecycle state or exception-state status, or an task's current state or exception-state status. These constants are used by the flags parameter of a document or a task's changeState method.

See Also:

changeState, Serialized Form

Field Summary

Fields
Modifier 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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

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

- Field Detail
  - SET_EXCEPTION_AS_INT
```
public static final int SET_EXCEPTION_AS_INT
```
    An 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.
    
    See Also:
    
    Constant Field Values
  - SET_EXCEPTION
```
public static final LifecycleChangeFlags SET_EXCEPTION
```
    Place the document into the exception state and set its IsInExceptionState property to true.
    Place the task into the exception state.
  - CLEAR_EXCEPTION_AS_INT
```
public static final int CLEAR_EXCEPTION_AS_INT
```
    An 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.
    
    See Also:
    
    Constant Field Values
  - CLEAR_EXCEPTION
```
public static final LifecycleChangeFlags CLEAR_EXCEPTION
```
    Remove the document or task from the exception state, and set the document's IsInExceptionState property to false.
  - RESET_AS_INT
```
public static final int RESET_AS_INT
```
    An 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.
    
    See Also:
    
    Constant Field Values
  - RESET
```
public static final 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.
    This flag does not apply to CmTask objects.
  - PROMOTE_AS_INT
```
public static final int PROMOTE_AS_INT
```
    An 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.
    
    See Also:
    
    Constant Field Values
  - PROMOTE
```
public static final 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.
    Promote the task's current state to the next state.
  - DEMOTE_AS_INT
```
public static final int DEMOTE_AS_INT
```
    An 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.
    
    See Also:
    
    Constant Field Values
  - DEMOTE
```
public static final 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.
    Demote the task's current state to the previous state.
- Method Detail
  - getValue
```
public int getValue()
```
    Returns the internal integer value associated with a specific instance of this class.
    
    Returns:
    
    The enumeration instance's ordinal value.
    
    See Also:
    
    getInstanceFromInt(int)
  - toString
```
public java.lang.String toString()
```
    Returns a String representation of this enumeration instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The enumeration instance's description.
  - getInstanceFromInt
```
public static LifecycleChangeFlags getInstanceFromInt(int value)
```
    Returns an instance of this class using its associated integer value.
    
    Parameters:
    
    value - The integer value. (See the *_AS_INT fields.)
    
    Returns:
    
    The enumeration instance with the given ordinal value.
    
    Throws:
    
    EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
    
    See Also:
    
    getValue()

Methods inherited from class java.lang.Object

SET_EXCEPTION_AS_INT

SET_EXCEPTION

CLEAR_EXCEPTION_AS_INT

CLEAR_EXCEPTION

RESET_AS_INT

RESET

PROMOTE_AS_INT

PROMOTE

DEMOTE_AS_INT

DEMOTE

getValue

toString

getInstanceFromInt