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.
The following tables list the members exposed by PendingAction.
Protected Constructors
Protected Fields
Public Methods
| Name | Description |
---|
 | Equals | Determines whether the specified Object is equal to the current Object. (inherited from Object) |
 | GetBinaryListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetBinaryValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetBooleanListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetBooleanValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetDateTimeListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetDateTimeValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetEngineObjectValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetFloat64ListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetFloat64Value | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetHashCode | Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (inherited from Object) |
 | GetIdListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetIdValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetInteger32ListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetInteger32Value | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetObjectData | This method is exposed to satisfy the ISerializable interface. |
 | GetObjectValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetStringListValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetStringValue | Locates the named parameter in the parameter bag and returns the value of the object it holds. |
 | GetType | Gets the Type of the current instance. (inherited from Object) |
 | PutObjectValue | Adds an object as the value for the named parameter to the parameter bag for this PendingAction object. If the named parameter already exists, it is overwritten with the new value. |
 | PutValue | Overloaded. Adds a value for the named parameter to the parameter bag for this PendingAction object. |
 | ToString | Overridden. Returns a 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. |
Top
Protected Methods
| Name | Description |
---|
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object) |
 | MemberwiseClone | Creates a shallow copy of the current Object. (inherited from Object) |
Top
Explicit Interface Implementations
| Name | Description |
---|
  | PendingAction | Overloaded. Initializes a new instance of the PendingAction class. |
Top
See Also