com.modeliosoft.modelio.cms.api.contrib

Interface ICmsContributor

All Known Implementing Classes:

AbstractCmsContributor

public interface ICmsContributor

Interface for a contributor to the SVN Process Extension Model (PEM).

All registered PEM contributors are called before and after handled SVN operations.

A contributor may modify the SVN command before its execution.

You are strongly encouraged to subclass AbstractCmsContributor instead of directly implementing this interface.

Since:

3.5

Author:

cmarin

Method Summary

Modifier and Type	Method and Description
void	configAdd(org.modelio.vbasic.progress.IModelioProgress monitor, IAddConfig configuration) Called before a "add to version" operation is executed.
void	configCommit(org.modelio.vbasic.progress.IModelioProgress monitor, ICommitConfig configuration) Called before a commit operation is executed.
void	configGetLock(org.modelio.vbasic.progress.IModelioProgress monitor, IGetLockConfig configuration) Ask for the parameters and the confirmation of the locking of the given elements.
void	configMerge(org.modelio.vbasic.progress.IModelioProgress monitor, IMergeConfig configuration) Ask for the parameters and the confirmation of the update of the given elements.
void	configRemove(org.modelio.vbasic.progress.IModelioProgress monitor, IRemoveConfig configuration) Called before a "remove from version" operation is executed.
void	configRevert(org.modelio.vbasic.progress.IModelioProgress monitor, IRevertConfig revertConfig) Called before a revert operation is executed.
void	configUpdate(org.modelio.vbasic.progress.IModelioProgress monitor, IUpdateConfig configuration) Ask for the parameters and the confirmation of the update of the given elements.
java.lang.String	getId() An identifier that uniquely identifies the implementation class.
java.lang.String	getLabel() Get the contributor GUI label.
void	onAddFailed(IAddConfig config, java.lang.Throwable cause) Called after a "Add" has failed.
void	onAddSuccess(IAddResult details) Called after a successful add to version is finished.
void	onCommitFailed(ICommitConfig config, java.lang.Throwable cause) Called after a commit has failed.
void	onCommitSuccess(ICommitResult commitResult) Called after a commit is definitively finished and validated.
void	onGetLockFailed(IGetLockConfig config, java.lang.Throwable cause) Called after a "Get lock" has failed.
void	onGetLockSuccess(IGetLockResult lockResult) Called after a locking operation is finished.
void	onMergeFailed(IMergeConfig config, java.lang.Throwable cause) Called after a "Update" has failed.
void	onMergeSuccess(IMergeConfig config, IUpdateDetails mergeResult) Called after a successful update is finished
void	onRemoveFailed(IRemoveConfig config, java.lang.Throwable cause) Called after a "Remove" has failed.
void	onRemoveSuccess(IRemoveConfig details) Called after a successful remove from version is finished.
void	onRevertFailed(IRevertConfig config, java.lang.Throwable cause) Called after a "Revert" has failed.
void	onRevertSuccess(IRevertResult result) Called after a revert operation.
void	onUpdateFailed(IUpdateConfig config, java.lang.Throwable cause) Called after a "Update" has failed.
void	onUpdateSuccess(IUpdateDetails updateResult) Called after a successful update is finished

Method Detail

configAdd

void configAdd(org.modelio.vbasic.progress.IModelioProgress monitor,
               IAddConfig configuration)
        throws CmsContributorVetoException

Called before a "add to version" operation is executed.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - The add operation configuration. It may be modified by calling the appropriate methods on the ICommitConfig

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

configCommit

void configCommit(org.modelio.vbasic.progress.IModelioProgress monitor,
                  ICommitConfig configuration)
           throws CmsContributorVetoException

Called before a commit operation is executed.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - The commit configuration. It may be modified by calling the appropriate methods on the ICommitConfig

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

configGetLock

void configGetLock(org.modelio.vbasic.progress.IModelioProgress monitor,
                   IGetLockConfig configuration)
            throws CmsContributorVetoException

Ask for the parameters and the confirmation of the locking of the given elements.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - the elements to checkout.

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

configRemove

void configRemove(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IRemoveConfig configuration)
           throws CmsContributorVetoException

Called before a "remove from version" operation is executed.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - The add operation configuration. It may be modified by calling the appropriate methods on the ICommitConfig

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

configRevert

void configRevert(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IRevertConfig revertConfig)
           throws CmsContributorVetoException

Called before a revert operation is executed.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

revertConfig - The revert configuration. It may be modified by calling the appropriate methods on the IRevertCommand

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

configUpdate

void configUpdate(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IUpdateConfig configuration)
           throws CmsContributorVetoException

Ask for the parameters and the confirmation of the update of the given elements.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - the command containing the elements on which the update will be run.

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

getId

java.lang.String getId()

An identifier that uniquely identifies the implementation class.

This may return the implementation class qualified name, the module name.

Returns:

the contributor identifier.

getLabel

java.lang.String getLabel()

Get the contributor GUI label.

Returns:

a user friendly label to display in GUI.

onAddFailed

void onAddFailed(IAddConfig config,
                 java.lang.Throwable cause)

Called after a "Add" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.

onAddSuccess

void onAddSuccess(IAddResult details)

Called after a successful add to version is finished.

Parameters:

details - the result of the add to version.

onCommitFailed

void onCommitFailed(ICommitConfig config,
                    java.lang.Throwable cause)

Called after a commit has failed.

Parameters:

config - the operation that failed

cause - the failure cause. Usually a CmsException or a RuntimeException.

onCommitSuccess

void onCommitSuccess(ICommitResult commitResult)

Called after a commit is definitively finished and validated.

Parameters:

commitResult - the detail of committed elements.

onGetLockFailed

void onGetLockFailed(IGetLockConfig config,
                     java.lang.Throwable cause)

Called after a "Get lock" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.

onGetLockSuccess

void onGetLockSuccess(IGetLockResult lockResult)

Called after a locking operation is finished.

Parameters:

lockResult - result of the locking.

onRemoveFailed

void onRemoveFailed(IRemoveConfig config,
                    java.lang.Throwable cause)

Called after a "Remove" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.

onRemoveSuccess

void onRemoveSuccess(IRemoveConfig details)

Called after a successful remove from version is finished.

Parameters:

details - the result of the add to version.

onRevertFailed

void onRevertFailed(IRevertConfig config,
                    java.lang.Throwable cause)

Called after a "Revert" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.

onRevertSuccess

void onRevertSuccess(IRevertResult result)

Called after a revert operation.

Parameters:

result - the result of the revert operation.

onUpdateFailed

void onUpdateFailed(IUpdateConfig config,
                    java.lang.Throwable cause)

Called after a "Update" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.

onUpdateSuccess

void onUpdateSuccess(IUpdateDetails updateResult)

Called after a successful update is finished

Parameters:

updateResult - result of the update.

configMerge

void configMerge(org.modelio.vbasic.progress.IModelioProgress monitor,
                 IMergeConfig configuration)
          throws CmsContributorVetoException

Ask for the parameters and the confirmation of the update of the given elements.

The implementation may confirm or cancel the operation, and partly modify the command parameters.

Parameters:

monitor - the progress monitor to use for reporting progress to the user.
It is the caller's responsibility to call done() on the given monitor.
Accepts null, indicating that no progress should be reported and that the operation cannot be cancelled.

configuration - the command containing the elements on which the update will be run.

Throws:

CmsContributorVetoException - if the contributor oppose a veto to the operation. The exception message should be a translated user friendly message explaining the veto reason.

onMergeSuccess

void onMergeSuccess(IMergeConfig config,
                    IUpdateDetails mergeResult)

Called after a successful update is finished

Parameters:

config - the finished merge operation.

mergeResult - result of the merge.

onMergeFailed

void onMergeFailed(IMergeConfig config,
                   java.lang.Throwable cause)

Called after a "Update" has failed.

Parameters:

config - the operation that failed.

cause - the failure cause. Usually a CmsException or a RuntimeException.