Base class for mass operation handlers.
Inheritance Hierarchy
kCura.MassOperationHandlers.MassOperationHandler
Namespace: kCura.MassOperationHandlers
Assembly: kCura.EventHandler (in kCura.EventHandler.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax
The MassOperationHandler type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | BatchIDs |
Gets and/or sets a list of integer values indicating ids included in a current batch.
|
| Helper |
Gets and/or sets the Helper property of the mass operation handler which returns IMOHHelper object from Relativity.API.
|
| LayoutMask |
Gets and/or sets a layout mask for a current mass operation handler.
|
| MassActionTableName |
Gets and/or sets a name of a temporary table where all ids will be stored for batching work of a particular mass operation handler.
|
| Name |
Gets a name of a mass operation handler.
|
Methods
| Name | Description | |
|---|---|---|
 | ChangeStatus |
Method which will update a status of a mass operation handler execution process.
|
| DoBatch |
Abstract method which will execute a batch.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IncrementCount |
Method which will update the current count of the executing batch.
|
| IsCancelled |
Method which returns True if a user clicked Cancel button on currently executing batch.
|
| PostMassOperation |
Abstract method which will be executed after DoBatch() method.
|
| PreMassOperation |
Abstract method which will be executed prior to DoBatch() method.)
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateLayout |
Abstract method which will execute validation of a layout attached to a mass operation handler.
|
| ValidateSelection |
Abstract method which will execute validation of a batch set to be processed.
|
Events
| Name | Description | |
|---|---|---|
 | CheckCancelled |
Raises an event of a Cancel button click action on currently executing batch.
|
| UpdateCount |
Raises an event to update the current count of executing batch.
|
| UpdateStatus |
Raises an event to update a status of a mass operation handler execution process.
|
Remarks
See Also