com.modeliosoft.modelio.cms.api

Interface ICancelAddCommand

public interface ICancelAddCommand

Command that cancels the addition of elements to version.

Method Summary

Modifier and Type	Method and Description
void	addElement(MObject toCancel) Add the given element to the collection of elements to undo.
void	addElements(java.util.Collection<MObject> toCancel) Add the given elements to the collection of elements to undo.
boolean	canExecute() Tells whether the command can be executed.
void	execute(org.modelio.vbasic.progress.IModelioProgress iMonitor) Cancel the "Add to version" command on the given elements and their descendant.
java.util.Collection<MObject>	getElements() Get the elements to cancel.

Method Detail

addElements

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

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

Parameters:

toCancel - the elements to cancel.

addElement

void addElement(MObject toCancel)

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

Parameters:

toCancel - the element to cancel.

Since:

3.7.1

getElements

java.util.Collection<MObject> getElements()

Get the elements to cancel.

The returned collection reflects the command configuration and may be freely modified .

Returns:

element a reference to the list of elements to remove.

canExecute

boolean canExecute()

Tells whether the command can be executed.

Returns:

true if execute can be called, false if the selected elements are invalid.

execute

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

Cancel the "Add to version" command on the given elements and their descendant.

Parameters:

iMonitor - 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 CMS error