com.modeliosoft.modelio.cms.api.contrib

Class AbstractCmsContributor

java.lang.Object

com.modeliosoft.modelio.cms.api.contrib.AbstractCmsContributor

All Implemented Interfaces:

ICmsContributor

public abstract class AbstractCmsContributor
extends java.lang.Object
implements ICmsContributor

This class is an implementation of ICmsContributor whose strategy consists in doing nothing.

ICmsContributor.getId() and ICmsContributor.getLabel() must be implemented by the sub classes.

You are encouraged to subclass this class instead of directly implementing the ICmsContributor interface.

Since:

3.5

Constructor Summary

Constructors

Constructor and Description
AbstractCmsContributor()

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.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.modeliosoft.modelio.cms.api.contrib.ICmsContributor

getId, getLabel

Constructor Detail

AbstractCmsContributor

public AbstractCmsContributor()

Method Detail

configAdd

public 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.

Specified by:

configAdd in interface ICmsContributor

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

public 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.

Specified by:

configCommit in interface ICmsContributor

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

public 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.

Specified by:

configGetLock in interface ICmsContributor

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.

configMerge

public 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.

Specified by:

configMerge in interface ICmsContributor

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.

configRemove

public 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.

Specified by:

configRemove in interface ICmsContributor

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

public 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.

Specified by:

configRevert in interface ICmsContributor

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

public 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.

Specified by:

configUpdate in interface ICmsContributor

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.

onAddFailed

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

Called after a "Add" has failed.

Specified by:

onAddFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onAddSuccess

public void onAddSuccess(IAddResult details)

Called after a successful add to version is finished.

Specified by:

onAddSuccess in interface ICmsContributor

Parameters:

details - the result of the add to version.

onCommitFailed

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

Called after a commit has failed.

Specified by:

onCommitFailed in interface ICmsContributor

Parameters:

config - the operation that failed

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

onCommitSuccess

public void onCommitSuccess(ICommitResult commitResult)

Called after a commit is definitively finished and validated.

Specified by:

onCommitSuccess in interface ICmsContributor

Parameters:

commitResult - the detail of committed elements.

onGetLockFailed

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

Called after a "Get lock" has failed.

Specified by:

onGetLockFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onGetLockSuccess

public void onGetLockSuccess(IGetLockResult lockResult)

Called after a locking operation is finished.

Specified by:

onGetLockSuccess in interface ICmsContributor

Parameters:

lockResult - result of the locking.

onMergeFailed

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

Called after a "Update" has failed.

Specified by:

onMergeFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onMergeSuccess

public void onMergeSuccess(IMergeConfig config,
                           IUpdateDetails mergeResult)

Called after a successful update is finished

Specified by:

onMergeSuccess in interface ICmsContributor

Parameters:

config - the finished merge operation.

mergeResult - result of the merge.

onRemoveFailed

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

Called after a "Remove" has failed.

Specified by:

onRemoveFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onRemoveSuccess

public void onRemoveSuccess(IRemoveConfig details)

Called after a successful remove from version is finished.

Specified by:

onRemoveSuccess in interface ICmsContributor

Parameters:

details - the result of the add to version.

onRevertFailed

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

Called after a "Revert" has failed.

Specified by:

onRevertFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onRevertSuccess

public void onRevertSuccess(IRevertResult result)

Called after a revert operation.

Specified by:

onRevertSuccess in interface ICmsContributor

Parameters:

result - the result of the revert operation.

onUpdateFailed

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

Called after a "Update" has failed.

Specified by:

onUpdateFailed in interface ICmsContributor

Parameters:

config - the operation that failed.

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

onUpdateSuccess

public void onUpdateSuccess(IUpdateDetails updateResult)

Called after a successful update is finished

Specified by:

onUpdateSuccess in interface ICmsContributor

Parameters:

updateResult - result of the update.