com.modeliosoft.modelio.cms.api

Interface IRevertCommand

public interface IRevertCommand

Used to configure a revert operation.

Method Summary

Modifier and Type	Method and Description
void	addElements(java.util.Collection<MObject> elementsToAdd, org.modelio.vbasic.progress.IModelioProgress monitor) Add elements to be reverted.
boolean	doReleaseLocks() Tells whether locks must be kept or released.
IRevertResult	execute(org.modelio.vbasic.progress.IModelioProgress monitor) Execute the revert.
IRevertConfig	getConfiguration()
IRevertDetail	getDetails() Get the list of elements to commit revert dependency analysis.
java.util.Collection<MObject>	getSelection() Get the elements on which the revert was run.
boolean	isBatchMode()
boolean	isRecursive() Get whether the revert must be recursive.
void	setBatch(boolean batchMode) Set whether the command must be run in batch mode
void	setRecursive(boolean isRecursive, org.modelio.vbasic.progress.IModelioProgress monitor) Set whether the revert must be recursive.
void	setReleaseLocks(boolean releaseLocks) Set whether locks must be kept or released.
void	setUseProcessExtension(boolean val) Set whether the the process model extensions will be called.
boolean	useProcessExtension() Tells whether the the process model extensions will be called.

Method Detail

getDetails

IRevertDetail getDetails()

Get the list of elements to commit revert dependency analysis. The returned set cannot be modified.

Returns:

the elements to commit

getSelection

java.util.Collection<MObject> getSelection()

Get the elements on which the revert was run.

Returns:

the initial list of elements to revert.

isRecursive

boolean isRecursive()

Get whether the revert must be recursive.

Returns:

whether the revert must be recursive.

setRecursive

void setRecursive(boolean isRecursive,
                  org.modelio.vbasic.progress.IModelioProgress monitor)

Set whether the revert must be recursive.

Changing this value reruns dependency analysis and invalidates the value returned by getDetails() . getDetails() must then be called again to get the new revert details.

Parameters:

isRecursive - whether the revert must be recursive.

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.

addElements

void addElements(java.util.Collection<MObject> elementsToAdd,
                 org.modelio.vbasic.progress.IModelioProgress monitor)

Add elements to be reverted.

Calling this method reruns dependency analysis and invalidates the value returned by getDetails() . getDetails() must then be called again to get the new revert details.

Parameters:

elementsToAdd - The elements to be added to the revert operation.

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.

doReleaseLocks

boolean doReleaseLocks()

Tells whether locks must be kept or released.

Returns:

true if locks must be released, false to keep them.

setReleaseLocks

void setReleaseLocks(boolean releaseLocks)

Set whether locks must be kept or released.

Parameters:

releaseLocks - true to release locks, false to keep them.

execute

IRevertResult execute(org.modelio.vbasic.progress.IModelioProgress monitor)
               throws CmsException,
                      TransactionStillOpenException

Execute the revert.

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.

Returns:

the result of the revert operation.

Throws:

CmsException - in case of failure.

TransactionStillOpenException - if a transaction is currently open.

setBatch

void setBatch(boolean batchMode)

Set whether the command must be run in batch mode

Parameters:

batchMode - true for batch mode. false to allow GUI.

Since:

3.5

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

Since:

3.5

setUseProcessExtension

void setUseProcessExtension(boolean val)

Set whether the the process model extensions will be called.

Parameters:

val - true to use the process model extensions will be called.

Since:

3.5

useProcessExtension

boolean useProcessExtension()

Tells whether the the process model extensions will be called.

Returns:

true to use the process model extensions will be called.

Since:

3.5

getConfiguration

IRevertConfig getConfiguration()

Returns:

the command configuration for process extensions.

Since:

3.5