com.modeliosoft.modelio.cms.api

Interface IRemoveCommand

public interface IRemoveCommand

Remove from version engine interface.

Method Summary

Modifier and Type	Method and Description
void	addElement(MObject elementToRemove) Add the given element to the collection of elements to remove.
void	addElements(java.util.Collection<MObject> elementsToRemove) Add the given elements to the collection of elements to remove.
void	execute(org.modelio.vbasic.progress.IModelioProgress monitor) Remove the elements from version control.
void	execute(java.util.List<MObject> elementsToRemove, org.modelio.vbasic.progress.IModelioProgress monitor) Deprecated. Use execute(IModelioProgress) and addElements(Collection)
IRemoveConfig	getConfiguration()
boolean	isBatchMode()
void	setBatch(boolean batchMode) Set whether the command must be run in batch mode
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

execute

@Deprecated
void execute(java.util.List<MObject> elementsToRemove,
                         org.modelio.vbasic.progress.IModelioProgress monitor)
                  throws CmsException

Deprecated. Use execute(IModelioProgress) and addElements(Collection)

Remove elements from version control

Parameters:

elementsToRemove - elements to remove

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

Throws:

CmsException - in case of failure

execute

void execute(org.modelio.vbasic.progress.IModelioProgress monitor)
      throws CmsException

Remove the elements from version control.

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

Throws:

CmsException - in case of failure

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

IRemoveConfig getConfiguration()

Returns:

the command configuration.

Since:

3.5

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

addElements

void addElements(java.util.Collection<MObject> elementsToRemove)

Add the given elements to the collection of elements to remove.

Parameters:

elementsToRemove - the elements to remove.

Since:

3.5

addElement

void addElement(MObject elementToRemove)

Add the given element to the collection of elements to remove.

Parameters:

elementToRemove - the element to remove.

Since:

3.7.1