IProcessExtension (Modelio 5.3 API (commercial))

```
public interface IProcessExtension
```
Process Extension Model (PEM) : hook that drives Subversion operations.
The Process Extension Model (PEM) is called before and after most of the Subversion operations. It is also in charge to display GUI to the user before and after SVN operations.
The PEM can be changed by another module with ICmsServices.setHook(IProcessExtension). It allow other modules to redefine the Subversion behavior to some extents.
The PEM may also be enriched by contributions implementing ICmsContributor, registered with addContributor(ICmsContributor).
Only one hook can be set at a time, and the dialog boxes before and after SVN operations are displayed by the predefined PEM. It is advised to instantiate instead a ICmsContributor and register it with addContributor(ICmsContributor).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addContributor(ICmsContributor contrib)` Add a contributor to the process model.
`IProcessExtensionGui`	`getGui()`
`ICmsContributorHolder`	`getPemContributorHolder()` Get the service that manages the Process Extension Model contributors.
`void`	`onModelChangeKeeperError(ModelChangesLoadingFailedException e)` Called when the model change keeper couldn't be loaded.
`void`	`postAdd(IAddResult result)` Called after a successful add to version is finished.
`void`	`postAddFailed(IAddCommand command, java.lang.Exception cause)` Called after the command failed.
`void`	`postCommit(ICommitResult result)` Called after a commit is definitively finished and validated.
`void`	`postCommitFailed(ICommitCommand command, java.lang.Exception cause)` Called after a commit command failed.
`void`	`postGetLock(IGetLockResult result)` Called after a locking operation is finished.
`void`	`postGetLockFailed(IGetLockCommand command, java.lang.Exception cause)` Called after the command failed.
`void`	`postMerge(IMergeCommand command, IUpdateDetails result)` Called after a successful merge is finished
`void`	`postMergeFailed(IMergeCommand command, java.lang.Exception cause)` Called after the command failed.
`void`	`postRemove(IRemoveConfig result)` Called after a successful remove from version is finished.
`void`	`postRemoveFailed(IRemoveCommand command, java.lang.Exception cause)` Called after the command failed partially or totally.
`void`	`postRevert(IRevertResult result)` Called after a revert operation.
`void`	`postRevertFailed(IRevertCommand command, java.lang.Exception cause)` Called after the command failed.
`void`	`postUpdate(IUpdateDetails result)` Called after a successful update is finished
`void`	`postUpdateFailed(IUpdateCommand command, java.lang.Exception cause)` Called after the command failed.
`boolean`	`preAdd(org.modelio.vbasic.progress.IModelioProgress monitor, IAddCommand command)` Ask for the parameters and the confirmation of the addition of the given command elements.
`boolean`	`preCommit(org.modelio.vbasic.progress.IModelioProgress monitor, ICommitCommand command)` Called before a commit operation is executed.
`boolean`	`preGetLock(org.modelio.vbasic.progress.IModelioProgress monitor, IGetLockCommand command)` Ask for the parameters and the confirmation of the locking of the given elements.
`boolean`	`preMerge(org.modelio.vbasic.progress.IModelioProgress monitor, IMergeCommand command)` Ask for the parameters and the confirmation of the merge operation.
`boolean`	`preRemove(org.modelio.vbasic.progress.IModelioProgress monitor, IRemoveCommand command)` Ask for the parameters and the confirmation of the removal of the given command elements.
`boolean`	`preRevert(org.modelio.vbasic.progress.IModelioProgress monitor, IRevertCommand command)` Called before a revert operation is executed.
`boolean`	`preUpdate(org.modelio.vbasic.progress.IModelioProgress monitor, IUpdateCommand command)` Ask for the parameters and the confirmation of the update of the given elements.
`void`	`removeContributor(ICmsContributor contrib)` Remove a contributor to the process model.

- Method Detail
  - addContributor
```
void addContributor(ICmsContributor contrib)
```
    Add a contributor to the process model.
    This is a shortcut for getPemContributorHolder().addContributor()
    
    Parameters:
    
    contrib - a contributor to add
    
    Since:
    
    3.5
  - onModelChangeKeeperError
```
void onModelChangeKeeperError(ModelChangesLoadingFailedException e)
```
    Called when the model change keeper couldn't be loaded.
    
    Parameters:
    
    e - the error
  - postAdd
```
void postAdd(IAddResult result)
```
    Called after a successful add to version is finished.
    It is not called if the command fails. In this case postAddFailed(IAddCommand, Exception) is called instead.
    
    Parameters:
    
    result - the result of the add to version.
  - postAddFailed
```
void postAddFailed(IAddCommand command,
                   java.lang.Exception cause)
```
    Called after the command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - postCommit
```
void postCommit(ICommitResult result)
```
    Called after a commit is definitively finished and validated.
    It is not called if the commit fails. In this case postCommitFailed(ICommitCommand, Exception) is called instead.
    
    Parameters:
    
    result - the detail of committed elements.
  - postCommitFailed
```
void postCommitFailed(ICommitCommand command,
                      java.lang.Exception cause)
```
    Called after a commit command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - postGetLock
```
void postGetLock(IGetLockResult result)
```
    Called after a locking operation is finished.
    
    Parameters:
    
    result - result of the locking.
  - postGetLockFailed
```
void postGetLockFailed(IGetLockCommand command,
                       java.lang.Exception cause)
```
    Called after the command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - postRemove
```
void postRemove(IRemoveConfig result)
```
    Called after a successful remove from version is finished.
    
    Parameters:
    
    result - the remove from version operation.
  - postRemoveFailed
```
void postRemoveFailed(IRemoveCommand command,
                      java.lang.Exception cause)
```
    Called after the command failed partially or totally.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - postRevert
```
void postRevert(IRevertResult result)
```
    Called after a revert operation.
    
    Parameters:
    
    result - the result of the revert operation.
  - postRevertFailed
```
void postRevertFailed(IRevertCommand command,
                      java.lang.Exception cause)
```
    Called after the command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - postUpdate
```
void postUpdate(IUpdateDetails result)
```
    Called after a successful update is finished
    
    Parameters:
    
    result - result of the update.
  - postUpdateFailed
```
void postUpdateFailed(IUpdateCommand command,
                      java.lang.Exception cause)
```
    Called after the command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - preAdd
```
boolean preAdd(org.modelio.vbasic.progress.IModelioProgress monitor,
               IAddCommand command)
```
    Ask for the parameters and the confirmation of the addition of the given command elements.
    The PEM may show a dialog box to ask the user for confirmation. The method may return false if the addition is cancelled.
    
    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.
    
    command - the command containing the elements on which the update will be run.
    
    Returns:
    
    true in case of confirmation, false if the update is canceled.
  - preCommit
```
boolean preCommit(org.modelio.vbasic.progress.IModelioProgress monitor,
                  ICommitCommand command)
```
    Called before a commit operation is executed.
    The PEM may show a dialog box to ask the user for confirmation. The PEM may confirm or cancel the commit operation, and partly modify the commit 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.
    
    command - The commit configuration. It may be modified by calling the appropriate methods on the ICommitConfig
    
    Returns:
    
    true if the commit is confirmed, false to cancel the commit configuration
  - preGetLock
```
boolean preGetLock(org.modelio.vbasic.progress.IModelioProgress monitor,
                   IGetLockCommand command)
```
    Ask for the parameters and the confirmation of the locking of the given elements.
    The PEM may show a dialog box to ask the user for confirmation. The method must return the checkout parameters or null if the checkout is cancelled.
    
    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.
    
    command - the elements to checkout.
    
    Returns:
    
    true to allow the command to run, false to cancel it.
  - preRemove
```
boolean preRemove(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IRemoveCommand command)
```
    Ask for the parameters and the confirmation of the removal of the given command elements.
    The PEM may show a dialog box to ask the user for confirmation. The method may return false if the operation is cancelled.
    
    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.
    
    command - the command containing the elements on which the update will be run.
    
    Returns:
    
    true in case of confirmation, false if the operation is canceled.
  - preRevert
```
boolean preRevert(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IRevertCommand command)
```
    Called before a revert operation is executed.
    The PEM may show a dialog box to ask the user for confirmation. The PEM may confirm or cancel the revert operation, and partly modify the revert 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.
    
    command - The revert configuration. It may be modified by calling the appropriate methods on the IRevertCommand
    
    Returns:
    
    true if the revert is confirmed, false to cancel the commit configuration
  - preUpdate
```
boolean preUpdate(org.modelio.vbasic.progress.IModelioProgress monitor,
                  IUpdateCommand command)
```
    Ask for the parameters and the confirmation of the update of the given elements.
    The PEM may show a dialog box to ask the user for confirmation. The method may return false if the update is cancelled.
    
    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.
    
    command - the command containing the elements on which the update will be run.
    
    Returns:
    
    true in case of confirmation, false if the update is canceled.
  - removeContributor
```
void removeContributor(ICmsContributor contrib)
```
    Remove a contributor to the process model.
    
    Parameters:
    
    contrib - the contributor to remove
  - postMerge
```
void postMerge(IMergeCommand command,
               IUpdateDetails result)
```
    Called after a successful merge is finished
    
    Parameters:
    
    command - the merge command
    
    result - result of the merge.
  - postMergeFailed
```
void postMergeFailed(IMergeCommand command,
                     java.lang.Exception cause)
```
    Called after the command failed.
    
    Parameters:
    
    command - the failed command
    
    cause - the failure cause. Usually a CmsException or a RuntimeException.
  - preMerge
```
boolean preMerge(org.modelio.vbasic.progress.IModelioProgress monitor,
                 IMergeCommand command)
```
    Ask for the parameters and the confirmation of the merge operation.
    The PEM may show a dialog box to ask the user for confirmation. The method may return false if the update is cancelled.
    
    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.
    
    command - the merge command that will be run.
    
    Returns:
    
    true in case of confirmation, false if the merge is canceled.
  - getPemContributorHolder
```
ICmsContributorHolder getPemContributorHolder()
```
    Get the service that manages the Process Extension Model contributors.
    
    Returns:
    
    the service that manages the Process Extension Model contributors.
  - getGui
```
IProcessExtensionGui getGui()
```
    Returns:
    
    the services that display command dialogs and result to the user.

Interface IProcessExtension

Method Summary

Method Detail

addContributor

onModelChangeKeeperError

postAdd

postAddFailed

postCommit

postCommitFailed

postGetLock

postGetLockFailed

postRemove

postRemoveFailed

postRevert

postRevertFailed

postUpdate

postUpdateFailed

preAdd

preCommit

preGetLock

preRemove

preRevert

preUpdate

removeContributor

postMerge

postMergeFailed

preMerge

getPemContributorHolder

getGui