Class PendingAction
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- All Implemented Interfaces:
- java.io.Serializable
- Direct Known Subclasses:
- ApplySecurityTemplate, ChangeClass, ChangeState, Checkin, Checkout, Create, Delete, DemoteVersion, Freeze, InstallAddOn, Lock, MoveContent, PromoteVersion, RaiseEvent, Recover, TakeFederatedOwnership, Unlock, Update
public class PendingAction extends java.lang.Object implements java.io.Serializable
Provides the base class for all of the other classes in this package.A pending action represents an intended change that has not yet been committed to an object on the server. When you call a method that changes an underlying object, a subclass of
PendingAction
is created that corresponds to the action. For example, callingDocument.checkout
creates aCheckout
subclass. The pending action is added to the underlying object's ordered list of pending actions (an automatically-generatedPendingActions
collection). For each subsequent action (such as locking and unlocking, changing the class, freezing, and so on) taken on the object, an item is added to the pending actions list. When you commit the object, for example, by calling thesave
method or, in the case of batch operations, by committing the batch, the underlying object (and its collection of pending actions) is sent to the server and changes are written to the repository in the order in which they occur in the object's pending actions list.A
PendingAction
object has a parameter bag that accompanies the action taken on the underlying object. ThePendingAction
class providesget
andput
methods for retrieving and setting parameters in the parameter bag. For example, if you change the class of an object, the identity of the new class is communicated as a parameter. (Note: Parameter names specified as input to these methods may not be documented completely. It is expected that you will use the type-safe subclasses instead of directly working with the underlyingPendingAction
objects. The names of valid parameters can be deduced from the formal arguments of constructors forPendingAction
subclasses.)You can retrieve an object's accumulated pending actions by calling its
getPendingActions
method.- See Also:
- Serialized Form
-
-
Method Summary
Methods Modifier and Type Method and Description BinaryList
getBinaryListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.byte[]
getBinaryValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.BooleanList
getBooleanListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.lang.Boolean
getBooleanValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.DateTimeList
getDateTimeListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.util.Date
getDateTimeValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.EngineObject
getEngineObjectValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.Float64List
getFloat64ListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.lang.Double
getFloat64Value(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.IdList
getIdListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.Id
getIdValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.Integer32List
getInteger32ListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.lang.Integer
getInteger32Value(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.lang.Object
getObjectValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.StringList
getStringListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.java.lang.String
getStringValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.void
putObjectValue(java.lang.String name, java.lang.Object v)
Adds an object as the value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, BinaryList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, java.lang.Boolean v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, BooleanList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, byte[] v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, java.util.Date v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, DateTimeList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, java.lang.Double v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, EngineObject v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, Float64List v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, Id v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, IdList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, java.lang.Integer v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, Integer32List v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, java.lang.String v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.void
putValue(java.lang.String name, StringList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.java.lang.String
toString()
Returns aString
representation of thisPendingAction
instance.
-
-
-
Method Detail
-
putObjectValue
public void putObjectValue(java.lang.String name, java.lang.Object v)
Adds an object as the value for the named parameter to the parameter bag for thisPendingAction
object. If the named parameter already exists, it is overwritten with the new value.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AnObject
that specifies the value for the parameter.
-
getObjectValue
public java.lang.Object getObjectValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
Object
. Returnsnull
if the parameter cannot be found in the parameter bag.
-
getStringValue
public java.lang.String getStringValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
String
. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, java.lang.String v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AString
that specifies the value for the parameter.
-
getBooleanValue
public java.lang.Boolean getBooleanValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
Boolean
. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, java.lang.Boolean v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- ABoolean
that specifies the value for the parameter.
-
getFloat64Value
public java.lang.Double getFloat64Value(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
Double
. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, java.lang.Double v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to retrieve.v
- ADouble
that specifies the value for the parameter.
-
getInteger32Value
public java.lang.Integer getInteger32Value(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
Integer
. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, java.lang.Integer v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to retrieve.v
- AnInteger
that specifies the value for the parameter.
-
getIdValue
public Id getIdValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
Id
object. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, Id v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AnId
object that specifies the value for the parameter.
-
getBinaryValue
public byte[] getBinaryValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an array of bytes. Returns
null
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, byte[] v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the property bag.v
- An array of bytes that specifies the value for the parameter.
-
getDateTimeValue
public java.util.Date getDateTimeValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
Date
object. Returnsnull
if the parameter cannot be found in the parameter bag. - Throws:
- if the parameter is not of the type being requested.java.lang.ClassCastException
-
putValue
public void putValue(java.lang.String name, java.util.Date v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- ADate
object that specifies the value for the parameter.
-
getEngineObjectValue
public EngineObject getEngineObjectValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
EngineObject
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, EngineObject v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the property bag.v
- AnEngineObject
object that specifies the value for the parameter.
-
getStringListValue
public StringList getStringListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
StringList
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, StringList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AStringList
that specifies the value for the parameter.
-
getBooleanListValue
public BooleanList getBooleanListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
containing the parameter name.- Returns:
- The value of the parameter as a
BooleanList
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, BooleanList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- ABooleanList
that specifies the value for the parameter.
-
getInteger32ListValue
public Integer32List getInteger32ListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
Integer32List
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, Integer32List v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AnInteger32List
that specifies the value for the parameter.
-
getFloat64ListValue
public Float64List getFloat64ListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
Float64List
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, Float64List v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AFloat64List
that specifies the value for the parameter.
-
getDateTimeListValue
public DateTimeList getDateTimeListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
DateTimeList
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, DateTimeList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- ADateTimeList
that specifies the value for the parameter.
-
getBinaryListValue
public BinaryList getBinaryListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as a
BinaryList
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, BinaryList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- ABinaryList
that specifies the value for the parameter.
-
getIdListValue
public IdList getIdListValue(java.lang.String name)
Locates the named parameter in the parameter bag and returns the value of the object it holds.- Parameters:
name
- AString
that specifies the parameter name to retrieve.- Returns:
- The value of the parameter as an
IdList
object. Returnsnull
if the parameter cannot be found in the parameter bag.
-
putValue
public void putValue(java.lang.String name, IdList v)
Adds a value for the named parameter to the parameter bag for thisPendingAction
object.- Parameters:
name
- AString
that specifies the parameter name to add to the parameter bag.v
- AnIdList
that specifies the value for the parameter.
-
toString
public java.lang.String toString()
Returns aString
representation of thisPendingAction
instance. The string (in the format �Class= Values= �) consists of the name of the class of which thisPendingAction
is an instance and the parameter values from its parameter bag. For example, for a pending action for creating an object, this method returns the class name, Create, followed by the parameter values for class ID, object ID, and so on.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A
String
representation of thisPendingAction
instance.
-
-