Click or drag to resize

BCSBatchOperation Class

Represents an object to manage a batch operation.
Inheritance Hierarchy
SystemObject
  BlueCieloECM.InnoCielo.MeridianDisposableObject
    BlueCieloECM.InnoCielo.Meridian.ScriptingBCSBatchOperation

Namespace:  BlueCieloECM.InnoCielo.Meridian.Scripting
Assembly:  BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.111.0)
Syntax
Copy
public class BCSBatchOperation : DisposableObject

The BCSBatchOperation type exposes the following members.

Constructors
  NameDescription
Public methodBCSBatchOperation
Initializes a new instance of the BCSBatchOperation class.
Top
Properties
  NameDescription
Public propertyArgument Obsolete.
Gets the collection of named properties stored during a batch operation.
Public propertyArguments
Gets the collection of named properties stored during a batch operation.
Public propertyBatchIndex
Gets the offset in the batch operation.
Public propertyBatchSize
Gets the number of items the batch operation is performed on.
Public propertyCountFailed
Gets the number of operations in the batch that failed.
Public propertyCountSucceeded
Gets the number of operations in the batch that succeeded.
Public propertyIsDisposed
Gets a value indicating whether the object has been disposed of.
(Inherited from DisposableObject.)
Public propertyIsFirstInBatch
Gets a value indicating whether the current item is the first in the batch operation.
Public propertyIsLastInBatch
Gets a value indicating whether the current item the last in the batch operation.
Public propertyItem
Gets or sets the named property stored during a batch operation.
Public propertyUnderlyingObject
Gets the underlying wrapped object.
(Inherited from DisposableObject.)
Top
Methods
  NameDescription
Public methodAbort
Aborts the batch operation. Uncommitted items in the batch are revoked.
Public methodAbort(String)
Aborts the batch operation. Uncommitted items in the batch are revoked.
Public methodAddDocumentToBatch
Adds a document with the specified ID property value to the batch.
Public methodDispose
Releases the underlying wrapped object explicitly.
(Inherited from DisposableObject.)
Public methodEquals (Inherited from Object.)
Public methodFailCurrent
Fails the current item in the batch operation.
Public methodFailCurrent(String)
Fails the current item in the batch operation.
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnDispose
The method is called on Dispose.
(Overrides DisposableObjectOnDispose.)
Public methodPrintDetails
Adds a line of text to the details log.
Protected methodThrowIfDisposed
Throws the ObjectDisposedException exception if the underlying object has been disposed.
(Inherited from DisposableObject.)
Public methodToString (Inherited from Object.)
Top
Remarks
Most operations on a document can be performed on multiple documents at a time. When responding to events, it may be required to take this into account.
See Also