com.modeliosoft.modelio.cms.api

Interface IProcessExtensionGui

public interface IProcessExtensionGui

GUI displayed by the IProcessExtension.

Since:

Alouette 5.3

Author:

cmarin

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Void>	displayAddResult(IAddResult result) Called after a successful add to version is finished.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayCommitResult(ICommitResult result) Called after a commit is definitively finished and validated.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayGetLockResult(IGetLockResult result) Called after a locking operation is finished.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayMergeResult(IMergeCommand command, IUpdateDetails result) Called after a successful merge is finished
void	displayModelChangeKeeperError(ModelChangesLoadingFailedException e)
boolean	displayPreAdd(IAddCommand command) Ask for the parameters and the confirmation of the addition of the given command elements.
boolean	displayPreCommit(ICommitCommand command) Called before a commit operation is executed.
boolean	displayPreGetLock(IGetLockCommand command) Ask for the parameters and the confirmation of the locking of the given elements.
boolean	displayPreRemove(IRemoveCommand command) Ask for the parameters and the confirmation of the removal of the given command elements.
boolean	displayPreRevert(IRevertCommand command) Called before a revert operation is executed.
boolean	displayPreUpdate(IUpdateCommand command) Ask for the parameters and the confirmation of the update of the given elements.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayRemoveResult(IRemoveConfig result) Called after a successful remove from version is finished.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayRevertResult(IRevertResult result) Called after a revert operation.
java.util.concurrent.CompletableFuture<java.lang.Void>	displayUpdateResult(IUpdateDetails result) Called after a successful update is finished

Method Detail

displayCommitResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayCommitResult(ICommitResult result)

Called after a commit is definitively finished and validated.

It is not called if the commit fails.

Parameters:

result - the detail of committed elements.

Returns:

a future that completes when the GUI is closed.

displayAddResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayAddResult(IAddResult result)

Called after a successful add to version is finished.

It is not called if the command fails.

Parameters:

result - the result of the add to version.

Returns:

a future that completes when the GUI is closed.

displayMergeResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayMergeResult(IMergeCommand command,
                                                                          IUpdateDetails result)

Called after a successful merge is finished

Parameters:

command - the merge command

result - result of the merge.

Returns:

a future that completes when the GUI is closed.

displayGetLockResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayGetLockResult(IGetLockResult result)

Called after a locking operation is finished.

Parameters:

result - result of the locking.

Returns:

a future that completes when the GUI is closed.

displayRemoveResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayRemoveResult(IRemoveConfig result)

Called after a successful remove from version is finished.

Parameters:

result - the remove from version operation.

Returns:

a future that completes when the GUI is closed.

displayUpdateResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayUpdateResult(IUpdateDetails result)

Called after a successful update is finished

Parameters:

result - result of the update.

Returns:

a future that completes when the GUI is closed.

displayRevertResult

java.util.concurrent.CompletableFuture<java.lang.Void> displayRevertResult(IRevertResult result)

Called after a revert operation.

Parameters:

result - the result of the revert operation.

Returns:

the state of the displayed GUI.

displayPreRemove

boolean displayPreRemove(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:

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.

displayPreRevert

boolean displayPreRevert(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:

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

displayPreGetLock

boolean displayPreGetLock(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:

command - the elements to checkout.

Returns:

true to allow the command to run, false to cancel it.

displayPreCommit

boolean displayPreCommit(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:

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

displayPreAdd

boolean displayPreAdd(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:

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.

displayPreUpdate

boolean displayPreUpdate(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:

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.

displayModelChangeKeeperError

void displayModelChangeKeeperError(ModelChangesLoadingFailedException e)