com.modeliosoft.modelio.cms.api

Interface ICodeReverser

public interface ICodeReverser

Interface that code generation modules can implement so that the code is reversed before elements are committed.

The sequence is :

• The beginReverseSession() method is called.
• A transaction is created.
• The reverseCode(MObject) method is called once for each CMS node that may be committed.
• The transaction is closed.
• The endReverseSession() method is called.

Method Summary

Modifier and Type	Method and Description
void	beginReverseSession() Tells that a reverse session begins so that the ICodeReverser can initialize itself.
void	endReverseSession() Called when all elements that may be committed have been reversed.
void	reverseCode(MObject cmsNode) Reverse the given CMS node element.

Method Detail

beginReverseSession

void beginReverseSession()

Tells that a reverse session begins so that the ICodeReverser can initialize itself.

reverseCode

void reverseCode(MObject cmsNode)
          throws ReverseFailedException

Reverse the given CMS node element.

This method will be called once and only once for each CMS node that may be committed.

The Subversion has already open a transaction so that the code reverser does not have to create one.

Parameters:

cmsNode - the element whose generated code must be reversed.

Throws:

ReverseFailedException - if the reverse fails

endReverseSession

void endReverseSession()

Called when all elements that may be committed have been reversed.

The ICodeReverser may then dispose all resources allocated in beginReverseSession().

Thrown RuntimeExceptions are caught and printed to the console. It allows other code reversers to dispose their resources.