com.sapportals.wcm.rendering.base

Interface IUIBaseCommand

All Known Subinterfaces:

ICommand, IExecCommand, IMassCommand, IMassExecCommand, IUICommand, IUIGroupCommand, IUIMassCommand, IUIMenuCommand

All Known Implementing Classes:

AbstractBaseCommand, AbstractCommand, AbstractMassCommand, AbstractUICommand, AbstractUIGroupCommand, AbstractUIMassCommand, UIGroupCommand, UIMenuCommand

Deprecated. As of NetWeaver 7.1

public interface IUIBaseCommand

Description of the Interface

Field Summary

static String	ERR_MESSAGE_MISSING_CONFIG_ENTRY Deprecated. Message for exception when config settings are missing for a IUIBaseCommand.
static String	ERR_MESSAGE_WRONG_METHOD_CALL Deprecated. Message for exception to show when a wrong method of a IUIBaseCommand was called.
static String	KEY_INPUT_CONTROL_TEXT Deprecated.
static String	KEY_INPUT_CONTROL_TEXT_2 Deprecated.
static String	KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT Deprecated.
static String	KEY_INPUT_CONTROL_TEXT_3 Deprecated.
static String	KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT Deprecated.
static String	KEY_LABEL Deprecated. Some Commands require a second screen to choose the resources that are needed to carry out the commands on the resources selected in the first screen.
static String	KEY_MASS_EMBEDDED_COMMAND_TEXT Deprecated.
static String	KEY_MASS_EMBEDDED_COMMANT_TOOLTIP Deprecated.
static String	KEY_SINGLE_EMBEDDED_COMMAND_TEXT Deprecated.
static String	KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP Deprecated.
static String	KEY_TOOLTIP Deprecated.
static String	LINE_BREAK Deprecated. Line break to format lists of information
static String[]	TEXT_KEYS Deprecated.
static String	VALUE_EMPTY_STRING Deprecated.

Method Summary

com.sapportals.htmlb.Component	getComponent() Deprecated. As of NetWeaver 7.1
Properties	getConfigurationProperties() Deprecated. As of NetWeaver 7.1
Hashtable	getParameters() Deprecated. As of NetWeaver 7.1
List	getReplaceCommands() Deprecated. As of NetWeaver 7.1
String	getText(TextKey key) Deprecated. As of NetWeaver 7.1
void	setConfigurationProperties(Properties properties) Deprecated. As of NetWeaver 7.1
void	setLabelBundleKey(String groupLabel) Deprecated. As of NetWeaver 7.1
void	setParameters(Hashtable parameters) Deprecated. As of NetWeaver 7.1
void	setProxy(AbstractProxyControl proxy) Deprecated. As of NetWeaver 7.1
void	setReplaceCommands(List replaceCommandsList) Deprecated. As of NetWeaver 7.1
void	setResource(IResource resource) Deprecated. As of NetWeaver 7.1
void	setResourceBundle(ResourceBundles bundleFile) Deprecated. As of NetWeaver 7.1
void	setResourceContext(IResourceContext context) Deprecated. As of NetWeaver 7.1
void	setTooltipBundleKey(String groupTooltip) Deprecated. As of NetWeaver 7.1

Field Detail

LINE_BREAK

static final String LINE_BREAK

Deprecated.

Line break to format lists of information

ERR_MESSAGE_WRONG_METHOD_CALL

static final String ERR_MESSAGE_WRONG_METHOD_CALL

Deprecated.

Message for exception to show when a wrong method of a IUIBaseCommand was called. This could be execute() for a command, that needs a complete screenflow and cannot operate properly with this call. It has three parameters: methodname, parameter-signature, classname

See Also:

Constant Field Values

ERR_MESSAGE_MISSING_CONFIG_ENTRY

static final String ERR_MESSAGE_MISSING_CONFIG_ENTRY

Deprecated.

Message for exception when config settings are missing for a IUIBaseCommand. It has two parameters: classname, parameter-name

See Also:

Constant Field Values

KEY_LABEL

static final String KEY_LABEL

Deprecated.

Some Commands require a second screen to choose the resources that are needed to carry out the commands on the resources selected in the first screen. In this case, the original command has to provide for the texts shown on the second screen. These constants are used to read out the texts from the internal hashmap of the commands.

See Also:

Constant Field Values

KEY_TOOLTIP

static final String KEY_TOOLTIP

Deprecated.

See Also:

Constant Field Values

KEY_INPUT_CONTROL_TEXT

static final String KEY_INPUT_CONTROL_TEXT

Deprecated.

See Also:

Constant Field Values

KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT

static final String KEY_INPUT_CONTROL_TEXT_DEFAULT_TEXT

Deprecated.

See Also:

Constant Field Values

KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT

static final String KEY_INPUT_CONTROL_TEXT_2_DEFAULT_TEXT

Deprecated.

See Also:

Constant Field Values

KEY_INPUT_CONTROL_TEXT_2

static final String KEY_INPUT_CONTROL_TEXT_2

Deprecated.

See Also:

Constant Field Values

KEY_INPUT_CONTROL_TEXT_3

static final String KEY_INPUT_CONTROL_TEXT_3

Deprecated.

See Also:

Constant Field Values

KEY_SINGLE_EMBEDDED_COMMAND_TEXT

static final String KEY_SINGLE_EMBEDDED_COMMAND_TEXT

Deprecated.

See Also:

Constant Field Values

KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP

static final String KEY_SINGLE_EMBEDDED_COMMAND_TOOLTIP

Deprecated.

See Also:

Constant Field Values

KEY_MASS_EMBEDDED_COMMAND_TEXT

static final String KEY_MASS_EMBEDDED_COMMAND_TEXT

Deprecated.

See Also:

Constant Field Values

KEY_MASS_EMBEDDED_COMMANT_TOOLTIP

static final String KEY_MASS_EMBEDDED_COMMANT_TOOLTIP

Deprecated.

See Also:

Constant Field Values

VALUE_EMPTY_STRING

static final String VALUE_EMPTY_STRING

Deprecated.

See Also:

Constant Field Values

TEXT_KEYS

static final String[] TEXT_KEYS

Deprecated.

Method Detail

setResource

void setResource(IResource resource)

Deprecated. As of NetWeaver 7.1

Parameters:

resource - sets the resource the command shall operate on

setResourceBundle

void setResourceBundle(ResourceBundles bundleFile)

Deprecated. As of NetWeaver 7.1

Parameters:

bundleFile - The new resourceBundle value

setLabelBundleKey

void setLabelBundleKey(String groupLabel)

Deprecated. As of NetWeaver 7.1

Sets the labelBundleKey attribute of the IUIBaseCommand object

Parameters:

groupLabel - The new labelBundleKey value

setTooltipBundleKey

void setTooltipBundleKey(String groupTooltip)

Deprecated. As of NetWeaver 7.1

Sets the tooltipBundleKey attribute of the IUIBaseCommand object

Parameters:

groupTooltip - The new tooltipBundleKey value

getText

String getText(TextKey key)

Deprecated. As of NetWeaver 7.1

Gets the text for a givven text key

Parameters:

key - the input TextKey

Returns:

The text value

setConfigurationProperties

void setConfigurationProperties(Properties properties)

Deprecated. As of NetWeaver 7.1

Parameters:

properties - The new configurationProperties value

getConfigurationProperties

Properties getConfigurationProperties()

Deprecated. As of NetWeaver 7.1

Gets the configurationProperties attribute of the IUIBaseCommand object

Returns:

The configurationProperties value

getComponent

com.sapportals.htmlb.Component getComponent()

Deprecated. As of NetWeaver 7.1

Returns:

a Component to use in a link or a button, e.g. a Trash-Can-Icon for delete

setProxy

void setProxy(AbstractProxyControl proxy)

Deprecated. As of NetWeaver 7.1

Sets the proxy attribute of the IUIBaseCommand object

Parameters:

proxy - The new proxy value

setResourceContext

void setResourceContext(IResourceContext context)

Deprecated. As of NetWeaver 7.1

Sets the resourceContext for IUIBaseCommand

Parameters:

context - The new resourceContext value

getReplaceCommands

List getReplaceCommands()

Deprecated. As of NetWeaver 7.1

gets the list of commands which will be ignored when the command is executable

Returns:

The replaceCommands value

setReplaceCommands

void setReplaceCommands(List replaceCommandsList)

Deprecated. As of NetWeaver 7.1

Sets the list of commands which will be ignored when the command is executable

Parameters:

replaceCommandsList - The new replaceCommands value

setParameters

void setParameters(Hashtable parameters)

Deprecated. As of NetWeaver 7.1

Sets parameters for the command. Each parameters should have an unique key and one or more values.

Parameters:

parameters - The new parameters value

getParameters

Hashtable getParameters()

Deprecated. As of NetWeaver 7.1

Gets the command parameters

Returns:

The parameters value

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/nonwduideprecated	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM