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.19.0)

Syntax

C++

Copy

public class BCSBatchOperation : DisposableObject

Public Class BCSBatchOperation
	Inherits DisposableObject

public ref class BCSBatchOperation : public DisposableObject

type BCSBatchOperation =  
    class
        inherit DisposableObject
    end

The BCSBatchOperation type exposes the following members.

Constructors

	Name	Description
	BCSBatchOperation	Initializes a new instance of the BCSBatchOperation class.

Top

Properties

	Name	Description
	Argument	Obsolete. Gets the collection of named properties stored during a batch operation.
	Arguments	Gets the collection of named properties stored during a batch operation.
	BatchIndex	Gets the offset in the batch operation.
	BatchSize	Gets the number of items the batch operation is performed on.
	CountFailed	Gets the number of operations in the batch that failed.
	CountSucceeded	Gets the number of operations in the batch that succeeded.
	IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from DisposableObject.)
	IsFirstInBatch	Gets a value indicating whether the current item is the first in the batch operation.
	IsLastInBatch	Gets a value indicating whether the current item the last in the batch operation.
	Item	Gets or sets the named property stored during a batch operation.
	UnderlyingObject	Gets the underlying wrapped object. (Inherited from DisposableObject.)

Top

Methods

	Name	Description
	Abort	Aborts the batch operation. Uncommitted items in the batch are revoked.
	Abort(String)	Aborts the batch operation. Uncommitted items in the batch are revoked.
	AddDocumentToBatch	Adds a document with the specified ID property value to the batch.
	Dispose	Releases the underlying wrapped object explicitly. (Inherited from DisposableObject.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FailCurrent	Fails the current item in the batch operation.
	FailCurrent(String)	Fails the current item in the batch operation.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDispose	The method is called on Dispose. (Overrides DisposableObjectOnDispose.)
	PrintDetails	Adds a line of text to the details log.
	ThrowIfDisposed	Throws the ObjectDisposedException exception if the underlying object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (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.

Reference

BlueCieloECM.InnoCielo.Meridian.Scripting Namespace