com.filenet.api.action
Class ChangeState

java.lang.Object
  extended by com.filenet.api.action.PendingAction
      extended by com.filenet.api.action.ChangeState
All Implemented Interfaces:
java.io.Serializable

public class ChangeState
extends PendingAction

Represents a pending action for changing the lifecycle policy state of a document. When a document calls the changeState method, the API automatically creates an instance of the ChangeState class and adds it to the underlying object's collection of PendingAction objects.

See Also:
Serialized Form

Constructor Summary
ChangeState(LifecycleChangeFlags lifecycleAction)
          Creates a new instance of a ChangeState pending action object.
 
Method Summary
 LifecycleChangeFlags getLifecycleAction()
          Returns the new lifecycle state for the underlying object of this pending action.
 
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ChangeState

public ChangeState(LifecycleChangeFlags lifecycleAction)
Creates a new instance of a ChangeState pending action object.

Parameters:
lifecycleAction - A LifecycleChangeFlags constant specifying the new lifecycle policy state.
Throws:
E_BAD_PARAMETER - when you call the save method:
  • If the lifecycleAction parameter is null.
  • If the lifecycleAction parameter is PROMOTE, DEMOTE, or RESET, and the document has no document lifecycle policy defined.
  • If the lifecycleAction parameter is PROMOTE, DEMOTE, RESET, or SET_EXCEPTION, and the document is already in an exception state.
  • If the lifecycleAction parameter is CLEAR_EXCEPTION and the document is not in an exception state.
E_NOT_SUPPORTED - if the document is a reservation object. Thrown when you call the save method.
Method Detail

getLifecycleAction

public LifecycleChangeFlags getLifecycleAction()
Returns the new lifecycle state for the underlying object of this pending action.

Returns:
A LifecycleChangeFlags constant specifying the new lifecycle policy state.


© Copyright IBM Corporation 2006, 2008. All rights reserved.