com.sapportals.wcm.rendering.uicommand
Interface IUICommand

[contained in: com.sap.km.cm.ui.flex.par - km.shared.ui.flex.uicommand_api.jar]

All Superinterfaces:

IExecCommand, IUIBaseCommand

All Known Implementing Classes:

AbstractUICommand

public interface IUICommand

extends IUIBaseCommand, IExecCommand

IUICommands encapsulate everything that is needed to work with a specified resource on the user interface: - it provides the label and tooltip texts needed to display itself on the screen - it encapsulates the screenflow (if needed) that guides the user through the functionality of the command - it calls framework functionality to actually do the requested work - it provides success and error messages to inform the user about the state of the execution The commands use functionality of the htmlb and the WD-Framework, to implement the screenflow functionality the IScreenflow can be used. The IUICommand should not be instantiated directly, instead the UICommandFactory and the UIMenuFactory should be used. They return UIGroupCommands that hold a number of IUICommands and IUIMassCommands. IUICommand s - when instantiated through the UICommandFactory - receive a set of Properties that specify some member variables of the commands. Therefore, the UICommandFactory may hold several instances of the same class that implements the IUICommand, each with a different set of properties. To identify them, the 'alias' attribute is used. The config framework ensures, that this attribute is unique.

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

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

APPLICABLE_FALSE, APPLICABLE_TRUE, APPLICABLE_UNKNOWN

Method Summary

com.sapportals.wdf.event.WdfEvent	execute() carries out the wanted functionality on the given IResource.
com.sapportals.wdf.event.WdfEvent	execute(com.sapportals.wdf.ControllerDynPage dynpage, boolean pushStack) carries out the wanted functionality on the given IResource and might start a screenflow to do so.
java.lang.String	getButtonLabel()
java.lang.String	getLinkLabel()
IUICommand	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(java.util.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.base.IUIBaseCommand

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

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

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

Method Detail

execute

public com.sapportals.wdf.event.WdfEvent execute()
                                          throws com.sapportals.wdf.WdfException

carries out the wanted functionality on the given IResource. When this method is called, no screenflow can be started, the command can only carry out its action and return a status message. Some IUICommands need to start a screenflow to properly execute their tasks. They might throw an Exception or simply return an error message stating that this method call is not usable by them.

Returns:

the WdfEvent that encapsulates the information about the status of the execution.

Throws:

WdfException - Exception raised in failure situation

execute

public com.sapportals.wdf.event.WdfEvent execute(com.sapportals.wdf.ControllerDynPage dynpage,
                                                 boolean pushStack)
                                          throws com.sapportals.wdf.WdfException

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

Parameters:

dynpage - The page the current AbstractProxyControl and the command are rendered in.

pushStack - flag that states, if the current pane of the Wdf-Screenflow should be stored on the stack, or not. If the value is true , all registered Controls will be stored on the stack and when the screenflow returns to this stack, the userinput of these controls is still available

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:

WdfException - Exception raised in failure situation

setTextProperties

public void setTextProperties(java.util.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 IUICommand 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.

getLinkLabel

public java.lang.String getLinkLabel()

Returns:

the label to put on the link that leads to this Command

getButtonLabel

public java.lang.String getButtonLabel()

Returns:

the label to put on the button that leads to this Command