|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.action.PendingAction
public class PendingAction
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, calling Document.checkout
creates a Checkout
subclass. The pending
action is added to the underlying object’s ordered list of pending actions
(an automatically-generated PendingActions
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 the save
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. The PendingAction
class provides
get
and put
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 underlying PendingAction
objects. The names of valid
parameters can be deduced from the formal arguments of constructors for
PendingAction
subclasses.)
You can retrieve an object’s accumulated pending actions by calling its
getPendingActions
method.
Method Summary | |
---|---|
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 this PendingAction object. |
void |
putValue(java.lang.String name,
BinaryList v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
java.lang.Boolean v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
BooleanList v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
byte[] v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
java.util.Date v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
DateTimeList v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
java.lang.Double v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
EngineObject v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
Float64List v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
Id v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
IdList v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
java.lang.Integer v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
Integer32List v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
java.lang.String v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
void |
putValue(java.lang.String name,
StringList v)
Adds a value for the named parameter to the parameter bag for this PendingAction object. |
java.lang.String |
toString()
Returns a String representation of this PendingAction
instance. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public void putObjectValue(java.lang.String name, java.lang.Object v)
PendingAction
object. If the named parameter already
exists, it is overwritten with the new value.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- An Object
that specifies the value for the parameter.public java.lang.Object getObjectValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Object
. Returns null
if the parameter cannot be found in the parameter bag.public java.lang.String getStringValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
String
. Returns null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, java.lang.String v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A String
that specifies the value for the parameter.public java.lang.Boolean getBooleanValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Boolean
. Returns null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, java.lang.Boolean v)
PendingAction
object.
name
- A String
that specifies the parameter name to add
to the parameter bag.
v
- A Boolean
that specifies the value for the parameter.public java.lang.Double getFloat64Value(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Double
. Returns null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, java.lang.Double v)
PendingAction
object.
name
- A String
that specifies the parameter name to retrieve.
v
- A Double
that specifies the value for the parameter.public java.lang.Integer getInteger32Value(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Integer
. Returns null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type
being requested.public void putValue(java.lang.String name, java.lang.Integer v)
PendingAction
object.
name
- A String
that specifies the parameter name to retrieve.
v
- An Integer
that specifies the value for the parameter.public Id getIdValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Id
object. Returns
null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, Id v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.v
- An Id
object that specifies the value for the parameter.public byte[] getBinaryValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, byte[] v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the property bag.
v
- An array of bytes that specifies the value for the parameter.public java.util.Date getDateTimeValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Date
object. Returns null
if the parameter cannot be found in the parameter bag.
java.lang.ClassCastException
- if the parameter is not of the type being requested.public void putValue(java.lang.String name, java.util.Date v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A Date
object that specifies the value for the parameter.public EngineObject getEngineObjectValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
EngineObject
object. Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, EngineObject v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the property bag.
v
- An EngineObject
object that specifies the value for the parameter.public StringList getStringListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
StringList
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, StringList v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A StringList
that specifies the value for the parameter.public BooleanList getBooleanListValue(java.lang.String name)
name
- A String
containing the parameter name.
BooleanList
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, BooleanList v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A BooleanList
that specifies the value for the parameter.public Integer32List getInteger32ListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Integer32List
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, Integer32List v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- An Integer32List
that specifies the value for the parameter.public Float64List getFloat64ListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
Float64List
object. Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, Float64List v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A Float64List
that specifies the value for the parameter.public DateTimeList getDateTimeListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
DateTimeList
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, DateTimeList v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A DateTimeList
that specifies the value for the parameter.public BinaryList getBinaryListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
BinaryList
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, BinaryList v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- A BinaryList
that specifies the value for the parameter.public IdList getIdListValue(java.lang.String name)
name
- A String
that specifies the parameter name to retrieve.
IdList
object.
Returns null
if the parameter cannot be found in the parameter bag.public void putValue(java.lang.String name, IdList v)
PendingAction
object.
name
- A String
that specifies the parameter name to add to the parameter bag.
v
- An IdList
that specifies the value for the parameter.public java.lang.String toString()
String
representation of this PendingAction
instance. The string (in the format “Class= Values= ”) consists of the
name of the class of which this PendingAction
is an instance
and the parameter values from its parameter bag. For example, for
a “create” pending action, this method returns the class name, Create,
followed by the parameter values for class ID, object ID, and so on.
toString
in class java.lang.Object
String
representation of this PendingAction
instance.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |