Package org.alfresco.module.org_alfresco_module_rm.bulk

Interface BulkMonitor<T>

All Known Subinterfaces:

HoldBulkMonitor

All Known Implementing Classes:

DefaultHoldBulkMonitor

public interface BulkMonitor<T>

An interface for monitoring the progress of a bulk operation

Method Summary

Modifier and Type	Method	Description
void	cancelBulkOperation(String bulkStatusId, BulkCancellationRequest bulkCancellationRequest)	Cancel a bulk operation
BulkCancellationRequest	getBulkCancellationRequest(String bulkStatusId)	Get the bulk cancellation request
T	getBulkStatus(String bulkStatusId)	Get the bulk status
boolean	isCancelled(String bulkStatusId)	Check if a bulk operation is cancelled
void	registerProcess(NodeRef nodeRef, String processId, BulkOperation bulkOperation)	Register a process
void	updateBulkStatus(T bulkStatus)	Update the bulk status

Method Details

updateBulkStatus

void updateBulkStatus(T bulkStatus)

Update the bulk status

Parameters:

bulkStatus - the bulk status

registerProcess

void registerProcess(NodeRef nodeRef,
 String processId,
 BulkOperation bulkOperation)

Register a process

Parameters:

nodeRef - the node reference

processId - the process id

bulkOperation - the bulk operation

getBulkStatus

T getBulkStatus(String bulkStatusId)

Get the bulk status

Parameters:

bulkStatusId - the bulk status id

Returns:

the bulk status

cancelBulkOperation

void cancelBulkOperation(String bulkStatusId,
 BulkCancellationRequest bulkCancellationRequest)

Cancel a bulk operation

Parameters:

bulkStatusId -

bulkCancellationRequest -

isCancelled

boolean isCancelled(String bulkStatusId)

Check if a bulk operation is cancelled

Parameters:

bulkStatusId -

Returns:

true if the bulk operation is cancelled

getBulkCancellationRequest

BulkCancellationRequest getBulkCancellationRequest(String bulkStatusId)

Get the bulk cancellation request

Parameters:

bulkStatusId -

Returns:

cancellation reason