com.sapportals.wcm.rendering.uicommand

Interface ICommand

All Superinterfaces:

IExecCommand, IUIBaseCommand

All Known Implementing Classes:

AbstractCommand

public interface ICommand

extends IExecCommand

Since:

EP5 SP6 and EP6 SP1

Field Summary

Fields inherited from interface com.sapportals.wcm.rendering.uicommand.IExecCommand

APPLICABLE_FALSE, APPLICABLE_TRUE, APPLICABLE_UNKNOWN

Fields inherited from interface com.sapportals.wcm.rendering.base.IUIBaseCommand

ERR_MESSAGE_MISSING_CONFIG_ENTRY, ERR_MESSAGE_WRONG_METHOD_CALL, KEY_INPUT_CONTROL_TEXT, KEY_INPUT_CONTROL_TEXT_2, KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT, KEY_INPUT_CONTROL_TEXT_3, KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT, KEY_LABEL, KEY_MASS_EMBEDDED_COMMAND_TEXT, KEY_MASS_EMBEDDED_COMMANT_TOOLTIP, KEY_SINGLE_EMBEDDED_COMMAND_TEXT, KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP, KEY_TOOLTIP, LINE_BREAK, TEXT_KEYS, VALUE_EMPTY_STRING

Method Summary

IRenderingEvent	execute(IScreenflowData data) carries out the wanted functionality on the given IResource and might start a screenflow to do so.
ICommand	getNewInstance() returns a new instance of the class with all the values set by the configuration.
IResource	getResource() returns the resource the command works with.
void	setTextProperties(Properties properties) allows to set key-value pairs used for the texts on the screen for the implementing command.

Methods inherited from interface com.sapportals.wcm.rendering.uicommand.IExecCommand

getAlias, getLinkAttributes, getTargetParameters, isApplicable, isExecutable, raisesEvent, setAlias, setTargetParameters

Methods inherited from interface com.sapportals.wcm.rendering.base.IUIBaseCommand

getComponent, getConfigurationProperties, getParameters, getReplaceCommands, getText, setConfigurationProperties, setLabelBundleKey, setParameters, setProxy, setReplaceCommands, setResource, setResourceBundle, setResourceContext, setTooltipBundleKey

Method Detail

execute

public IRenderingEvent execute(IScreenflowData data)
                        throws WcmException

carries out the wanted functionality on the given IResource and might start a screenflow to do so.

Returns:

the WdfEvent that encapsulates the information about the status of the execution. It also acts as the trigger to jump into the IUICommand's screenflow (If one is defined). Note, that a WdfEvent can encapsulate other events.

Throws:

WcmException - Exception raised in failure situation

setTextProperties

public void setTextProperties(Properties properties)

allows to set key-value pairs used for the texts on the screen for the implementing command. The command must have some default-values to use, if no properties are sent from the configuration.

Specified by:

setTextProperties in interface IExecCommand

Parameters:

properties - The new textProperties value

getNewInstance

public ICommand getNewInstance()

returns a new instance of the class with all the values set by the configuration. When the CM is starting, the UICommandFactory reads out the configuration for the IUICommands and creates an instance of each command. Whenever the factory is asked to return a certain command, it uses the initially created command instance and calls its getNewInstance method. The command is responsible to set all values stemming from the configuration to the newly created instance. This delegated responsibility allows for greater flexibility inside the commands.

Returns:

a new Instance of the class, must not return null.

getResource

public IResource getResource()

returns the resource the command works with.

Returns:

the resource the command works with.