Adds an item to the batch to be updated by this instance. The item is referenced by a BatchItemHandle instance, and the batch is a list of BatchItemHandle instances.


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

Syntax

Visual Basic (Declaration)
Public Overridable Function Add( _ 
   ByVal object_Renamed As IIndependentlyPersistableObject,  _ 
   ByVal filter As PropertyFilter _ 
) As IBatchItemHandle
C#
public virtual IBatchItemHandle Add(
   IIndependentlyPersistableObject object_Renamed,
   PropertyFilter filter
)
C++
public:
 virtual IBatchItemHandle Add(
   IIndependentlyPersistableObject object_Renamed,
   PropertyFilter filter
)
J#
public virtual IBatchItemHandle Add(
   IIndependentlyPersistableObject object_Renamed,
   PropertyFilter filter
)
JScript
public virtual  function Add(
   object_Renamed : IIndependentlyPersistableObject,
   filter : PropertyFilter
) : IBatchItemHandle

Parameters

object_Renamed
An IndependentlyPersistableObject instance for the persisted object to update.
filter
A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.

Return Value

A BatchItemHandle instance representing the object added to the batch.

See Also