org.eclipse.emf.emfstore.client

Interface ESCompositeOperationHandle

All Known Implementing Classes:

ESCompositeOperationHandleImpl

public interface ESCompositeOperationHandle

A CompositeOperationHandle allows to control a composite operation during the recording process.

Since:

1.7

Author:

Johannes Faltermeier

Method Summary

Modifier and Type	Method and Description
void	abort() Aborts the composite operation.
void	end(String name, String description, ESModelElementId modelElementId) Completes a composite operation.
boolean	isValid() Returns whether the handle is still valid.

Method Detail

isValid

boolean isValid()

Returns whether the handle is still valid.

Returns:

false if the composite operation has completed or was aborted, true otherwise.

abort

void abort()
    throws ESInvalidCompositeOperationException

Aborts the composite operation. The state before starting the composite operation will be recovered.

Throws:

ESInvalidCompositeOperationException - if the handle is invalid

end

void end(String name,
         String description,
         ESModelElementId modelElementId)
  throws ESInvalidCompositeOperationException

Completes a composite operation.

Parameters:

name - the name for the operation

description - the description of the operation

modelElementId - the id of the model element that is most important for the operation

Throws:

ESInvalidCompositeOperationException - if the handle is invalid