org.polarsys.capella.common.ef.command

Interface ICommand

All Superinterfaces:

java.lang.Runnable

All Known Implementing Classes:

AbstractCommand, AbstractCompoundCommand, AbstractNonDirtyingCommand, AbstractReadOnlyCommand, AbstractReadWriteCommand

public interface ICommand
extends java.lang.Runnable

A command that is modifying or reading model objects, and thus need to be executed in the correct environment.

Method Summary

Modifier and Type	Method and Description
void	commandInterrupted() Command has been interrupted. Implementation is free to take any action that seems necessary.
void	commandRolledBack() Command has been rolled back. Implementation is free to take any action that seems necessary.
java.util.Collection<?>	getAffectedObjects() Returns the collection of things which this command wishes to present as the objects affected by the command.
java.util.Map	getExecutionOptions() Get the execution options map. TransactionalCommandStack.execute(org.eclipse.emf.common.command.Command, Map).
java.lang.String	getName() Get readable command name.
boolean	isReadOnly() Is the command only reading model objects or is it modifying any of them ?

Methods inherited from interface java.lang.Runnable

run

Method Detail

isReadOnly

boolean isReadOnly()

Is the command only reading model objects or is it modifying any of them ?

Returns:

true if read only, false if any model object is modified by the command.

commandInterrupted

void commandInterrupted()

Command has been interrupted.
Implementation is free to take any action that seems necessary.

commandRolledBack

void commandRolledBack()

Command has been rolled back.
Implementation is free to take any action that seems necessary.

getExecutionOptions

java.util.Map getExecutionOptions()

Get the execution options map.
TransactionalCommandStack.execute(org.eclipse.emf.common.command.Command, Map).

Returns:

can be null if default options are acceptable.

getName

java.lang.String getName()

Get readable command name.

Returns:

getAffectedObjects

java.util.Collection<?> getAffectedObjects()

Returns the collection of things which this command wishes to present as the objects affected by the command. Typically should could be used as the selection that should be highlighted to best illustrate the effect of the command. The result of calling this before an execute, redo, or undo is undefined. The result may be different after an undo than it is after an execute or redo, but the result should be the same (equivalent) after either an execute or redo.

Returns:

the collection of things which this command wishes to present as the objects affected by the command.