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.


Namespace: FileNet.Api.Action
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
<SerializableAttribute>
Public Class PendingAction
    Implements ISerializable
C#
[SerializableAttribute]
public class PendingAction : ISerializable
C++
[SerializableAttribute]
ref class PendingAction : ISerializable
J#
/** @attribute SerializableAttribute() */
public class PendingAction implements ISerializable
JScript
public 
   SerializableAttribute
class PendingAction extends ISerializable

Inheritance Hierarchy

System.Object
   FileNet.Api.Action.PendingAction
      Derived types

Thread Safety

Public static (Shared in Visual Basic)staticShared members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

See Also