com.modeliosoft.modelio.cms.api.contrib

Interface IRevertConfig

public interface IRevertConfig

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.
void	addFiles(java.util.Collection<java.io.File> filesToRevert) Add files to be reverted.
boolean	doReleaseLocks() Tells whether locks must be kept or released.
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	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.

Method Detail

setReleaseLocks

void setReleaseLocks(boolean releaseLocks)

Set whether locks must be kept or released.

Parameters:

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

getSelection

java.util.Collection<MObject> getSelection()

Get the elements on which the revert was run.

Does not contain all elements that will be reverted. for this call getDetails().

Returns:

the initial list of elements to revert.

See Also:

getDetails()

doReleaseLocks

boolean doReleaseLocks()

Tells whether locks must be kept or released.

Returns:

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

isRecursive

boolean isRecursive()

Get whether the revert must be recursive.

Returns:

whether the revert must be recursive.

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.

getDetails

IRevertDetail getDetails()

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

Returns:

the elements to commit

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.

isBatchMode

boolean isBatchMode()

Returns:

true for batch mode. False to show GUI.

addFiles

void addFiles(java.util.Collection<java.io.File> filesToRevert)

Add files to be reverted.

Parameters:

filesToRevert - the additional files to revert.