com.sapportals.wcm.rendering.uicommand
Interface IExecCommand

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

All Superinterfaces:

IUIBaseCommand

All Known Subinterfaces:

ICommand, IMassCommand, IMassExecCommand, IUICommand, IUIMassCommand

public interface IExecCommand

extends IUIBaseCommand

Since:

EP5 SP6 and EP6 SP1

Field Summary

static int	APPLICABLE_FALSE
static int	APPLICABLE_TRUE
static int	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

java.lang.String	getAlias()
LinkAttributes	getLinkAttributes() Return a LinkAttributes when the Command returns false in its raisesEvent method.
java.lang.String[]	getTargetParameters() returns the information the command needs to carry out its task, when it is called through its execute method.
boolean	isApplicable()
boolean	isExecutable() checks, if this Command can be executed for this resource (e.g. a resource can not be deleted, when it is locked by someone else).
boolean	raisesEvent() flag, if the command raises an Event in its execute method.
void	setAlias(java.lang.String p0) set the alias under which this instance is accessible via the UICommandFactory
void	setTargetParameters(java.util.List p0, IResourceContext p1) sets the parameters the command returned in its getTargetParameters method as well as the resource context.
void	setTextProperties(java.util.Properties properties)

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

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

Field Detail

APPLICABLE_UNKNOWN

public static final int APPLICABLE_UNKNOWN

APPLICABLE_FALSE

public static final int APPLICABLE_FALSE

APPLICABLE_TRUE

public static final int APPLICABLE_TRUE

Method Detail

isApplicable

public boolean isApplicable()

isExecutable

public boolean isExecutable()

checks, if this Command can be executed for this resource (e.g. a resource can not be deleted, when it is locked by someone else). Depending on the functionality that has to be checked, the call can be very expensive. Even if the command returns true, the state of the given IResource can change in the time between the calls isExecutable and execute , so this method does not guarantee successful execution at a later time.

Returns:

The executable value

getAlias

public java.lang.String getAlias()

Returns:

the alias under which this instance is accessible via the UICommandFactory

setAlias

public void setAlias(java.lang.String p0)

set the alias under which this instance is accessible via the UICommandFactory

Parameters:

alias - The new alias value

setTargetParameters

public void setTargetParameters(java.util.List p0,
                                IResourceContext p1)
                         throws WcmException

sets the parameters the command returned in its getTargetParameters method as well as the resource context. This method as well as the getTargetParameters method are called by the UICommandFactory. The later is called, when a Component (e.g. a Link) is used to render the command. At that time, the command has been initialized by the UICommandFactory . As the factory or the surrounding framework does not know about the commands inner structure, the command itself has to encode all information it needs for its execute method in the String[] it returns in the getTargetParameters method. This exact list is returned in the same order in this method here. In the standard scenario, the usage of IUICommand s in the WDF- htmlb-environment, this method is called just before the class's execute method is called.

Parameters:

values - an ArrayList which contains all the information the command encoded and needs to properly execute

context - the IResourceContext which contains the user data

Throws:

WcmException - Exception raised in failure situation

getTargetParameters

public java.lang.String[] getTargetParameters()
                                       throws WcmException

returns the information the command needs to carry out its task, when it is called through its execute method. See the setTargetParameters method for details. The String[] must not contain any null values

Returns:

The targetParameters value

Throws:

WcmException - Exception raised in failure situation

raisesEvent

public boolean raisesEvent()

flag, if the command raises an Event in its execute method.

Returns:

true, if the command raises an Event, false , if not

getLinkAttributes

public LinkAttributes getLinkAttributes()

Return a LinkAttributes when the Command returns false in its raisesEvent method.

Returns:

the link value

setTextProperties

public void setTextProperties(java.util.Properties properties)