com.sapportals.wcm.rendering.uicommand
Class AbstractMassCommand

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

java.lang.Object
  |
  +--com.sapportals.wcm.rendering.uicommand.AbstractMassCommand

All Implemented Interfaces:

IExecCommand, IMassCommand, IMassExecCommand, IUIBaseCommand

public abstract class AbstractMassCommand

extends java.lang.Object

implements IMassCommand

Copyright 2004 SAP AG

Since:

EP5, SP6 and EP6, SP1

Field Summary

protected int	applicable
static RID	ROOT_RID

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

Constructor Summary

AbstractMassCommand()
public constructor used by the UICommandFactory, when command is created for the first time

AbstractMassCommand(java.lang.String keyLabel, java.lang.String keyTooltip)
allows to set keys for the label and the tooltip of the command.

Method Summary

java.lang.String	getAlias() Gets the alias attribute of the AbstractUIMassCommand object
protected java.lang.String	getBundleString(java.lang.String key) returns the translated text for the given key.
protected java.lang.String	getBundleString(java.lang.String key, java.lang.Object obj) returns the translated text with the given variables included in the object.
protected java.lang.String	getBundleString(java.lang.String key, java.lang.Object[] obj) returns the translated text with the given variables included in the object array.
protected java.lang.String	getBundleString(java.lang.String key, java.lang.Object obj1, java.lang.Object obj2) returns the translated text with the given variables included in the two objects.
com.sapportals.htmlb.Component	getComponent() Returns a component for this command.
java.util.Properties	getConfigurationProperties() Gets the configurationProperties attribute of the AbstractUIMassCommand object
java.lang.String	getLabel() returns the label text for the command.
java.lang.String	getLayoutSetID() Gets the layoutSetID attribute of the AbstractUIMassCommand object
LinkAttributes	getLinkAttributes() Return a LinkAttributes when the Command returns false in its raisesEvent method.
java.util.Hashtable	getParameters() Gets the command parameters
IProxy	getProxy() Gets the proxy attribute of the AbstractUICommand object
java.util.List	getReplaceCommands() gets the list of commands which will be ignored when the command is executable
protected IResource	getResource()
IResourceContext	getResourceContext()
protected IResourceList	getResourceList()
java.lang.String[]	getTargetParameters() returns null.
java.lang.String	getText(TextKey key) Gets the text attribute of the AbstractUICommand object
java.lang.String	getTextForSecondaryScreen(java.lang.String key) Gets the textForSecondaryScreen attribute of the AbstractUIMassCommand object
protected java.util.Properties	getTextProperties()
java.lang.String	getTooltip() returns the tooltip text for the command.
com.sapportals.wcm.control.base.IMandatoryField[]	getUserInputSpecifiers()
protected void	handleWrongConfiguration() throws an InvalidConfigurationException that will be displayed on the screen and give further information what was invalid for the given configuration
protected IMassCommand	initNewInstance(IMassCommand command) whenever a new instance of a command is needed, the newly created instance has to inherit all of the old instance's member variables, such as the alias, the resource bundle...
boolean	isApplicable() Gets the applicable attribute of the AbstractUIMassCommand object
boolean	raisesEvent() flag, if the command raises an Event in its execute method.
void	setAlias(java.lang.String alias) Sets the alias attribute of the AbstractUIMassCommand object
void	setConfigurationProperties(java.util.Properties properties) allows to set a free list of key-value pairs to be used by this command.
void	setLabelBundleKey(java.lang.String label) currently not implemented.
void	setLayoutSetID(java.lang.String layoutSetID) Sets the layoutSetID attribute of the AbstractUIMassCommand object
void	setParameters(java.util.Hashtable parameters) Sets parameters for the command.
void	setProxy(AbstractProxyControl proxy) Sets the proxy attribute of the AbstractUICommand object
void	setReplaceCommands(java.util.List replaceCommandsList) set the list of commands which will be ignored when the command is executable
void	setResource(IResource resource)
void	setResourceBundle(ResourceBundles bundleFile) sets the resourcebundle for this command
void	setResourceContext(IResourceContext context) Sets the resourceContext for IUICommand
void	setResourceList(IResourceList list) Sets the resource list, the command operates on
void	setTargetParameters(java.util.List values, IResourceContext context) sets the given parameters for this class.
void	setTextProperties(java.util.Properties properties) copies the values of known keys from the given properties-object into its own list.
void	setTooltipBundleKey(java.lang.String tooltip) currently not implemented.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

execute, getNewInstance

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

isExecutable

Field Detail

applicable

protected int applicable

ROOT_RID

public static RID ROOT_RID

Constructor Detail

AbstractMassCommand

public AbstractMassCommand()

public constructor used by the UICommandFactory, when command is created for the first time

AbstractMassCommand

public AbstractMassCommand(java.lang.String keyLabel,
                           java.lang.String keyTooltip)

allows to set keys for the label and the tooltip of the command. It does not check, if the resource bundle holds entries for these keys.

Parameters:

keyLabel - the labelkey for the resourcebundle of the command, it is only set if it is not null

keyTooltip - the tooltipkey for the resourcebundle of the command, it is only set if it is not null

Method Detail

raisesEvent

public boolean raisesEvent()

Description copied from interface: IExecCommand

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

Specified by:

raisesEvent in interface IExecCommand

Since:

EP5 SP6 and EP6 SP1 states, if the Component rendered for this command will result in an Event or not.

getLinkAttributes

public LinkAttributes getLinkAttributes()

Description copied from interface: IExecCommand

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

Specified by:

getLinkAttributes in interface IExecCommand

Returns:

the link value

Since:

EP5 SP6 and EP6 SP1 returns a LinkAttributes when the Command returns false in its raisesEvent method, null otherwise.

setResourceBundle

public void setResourceBundle(ResourceBundles bundleFile)

sets the resourcebundle for this command

Specified by:

setResourceBundle in interface IUIBaseCommand

Parameters:

bundleFile - the bundle the command uses to retrieve its texts.

setTextProperties

public void setTextProperties(java.util.Properties properties)

copies the values of known keys from the given properties-object into its own list.

Specified by:

setTextProperties in interface IMassCommand

Parameters:

properties - should hold key-value pairs with keys defined in IUIBaseCommand.TEXT_KEYS . Other key-value pairs will not be used.

getTextProperties

protected java.util.Properties getTextProperties()

setConfigurationProperties

public void setConfigurationProperties(java.util.Properties properties)

allows to set a free list of key-value pairs to be used by this command. This

Specified by:

setConfigurationProperties in interface IUIBaseCommand

Parameters:

properties - free properties bag to be used by a command.

getConfigurationProperties

public java.util.Properties getConfigurationProperties()

Gets the configurationProperties attribute of the AbstractUIMassCommand object

Specified by:

getConfigurationProperties in interface IUIBaseCommand

Returns:

The configurationProperties value

setLabelBundleKey

public void setLabelBundleKey(java.lang.String label)

currently not implemented.

Specified by:

setLabelBundleKey in interface IUIBaseCommand

Parameters:

label - The new labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(java.lang.String tooltip)

currently not implemented.

Specified by:

setTooltipBundleKey in interface IUIBaseCommand

Parameters:

tooltip - The new tooltipBundleKey value

setResourceList

public void setResourceList(IResourceList list)

Sets the resource list, the command operates on

Specified by:

setResourceList in interface IMassExecCommand

Parameters:

list - The new resourceList value

getResourceList

protected IResourceList getResourceList()

setProxy

public void setProxy(AbstractProxyControl proxy)

Sets the proxy attribute of the AbstractUICommand object

Specified by:

setProxy in interface IUIBaseCommand

Parameters:

proxy - The new proxy value

setResourceContext

public void setResourceContext(IResourceContext context)

Sets the resourceContext for IUICommand

Specified by:

setResourceContext in interface IUIBaseCommand

Parameters:

context - The new resourceContext value

getResourceContext

public IResourceContext getResourceContext()

Returns:

the context the command is operating on

getProxy

public IProxy getProxy()

Gets the proxy attribute of the AbstractUICommand object

Returns:

The proxy value

setResource

public void setResource(IResource resource)

Specified by:

setResource in interface IUIBaseCommand

Parameters:

resource - sets the resource the command shall operate on

getResource

protected IResource getResource()

getComponent

public com.sapportals.htmlb.Component getComponent()

Returns a component for this command. This could be used to display this command on the screen.

Specified by:

getComponent in interface IUIBaseCommand

Returns:

a component to display. Currently returns null;

getTooltip

public java.lang.String getTooltip()

returns the tooltip text for the command. If no entry in the specified resource bundle is found, the class searches in its own static default resource bundle. If none can be found there, the alias-attribute of the class is returned.

Returns:

a tooltip for this command

getLabel

public java.lang.String getLabel()

returns the label text for the command. If no entry in the specified resource bundle is found, the class searches in its own static default resource bundle. If none can be found there, the alias-attribute of the class is returned.

Returns:

a label for this command

getText

public java.lang.String getText(TextKey key)

Gets the text attribute of the AbstractUICommand object

Specified by:

getText in interface IUIBaseCommand

Parameters:

key - Description of the param

Returns:

The text value

getTargetParameters

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

returns null. A number of IUIMassCommands do not need to add any information in the Event/code>s parameter list. When extending this abstract class, there is no need to implement this method.

Specified by:

getTargetParameters in interface IExecCommand

Returns:

The targetParameters value

Throws:

WcmException - Exception raised in failure situation

setTargetParameters

public void setTargetParameters(java.util.List values,
                                IResourceContext context)
                         throws WcmException

sets the given parameters for this class. As the value parameter is null , when this abstract classes getTargetParameters method is used, only the context parameter is used in this method.

Specified by:

setTargetParameters in interface IExecCommand

Parameters:

values - The new targetParameters value - not used in this implementation

context - The ResourceContext - this is always needed

Throws:

WcmException - Exception raised in failure situation

initNewInstance

protected final IMassCommand initNewInstance(IMassCommand command)

whenever a new instance of a command is needed, the newly created instance has to inherit all of the old instance's member variables, such as the alias, the resource bundle... To aid with this, the implementing class can implement its getNewInstancemethod like this public getNewInstance() { return this.initNewInstance(new MyCommand()); } this abstract class' method will copy all of the member-attributes. Comparable to the deep-clone approach.

Parameters:

command - Description of the param

Returns:

Description of the Return Value

getTextForSecondaryScreen

public java.lang.String getTextForSecondaryScreen(java.lang.String key)

Gets the textForSecondaryScreen attribute of the AbstractUIMassCommand object

Parameters:

key - Description of the param

Returns:

The textForSecondaryScreen value

getUserInputSpecifiers

public com.sapportals.wcm.control.base.IMandatoryField[] getUserInputSpecifiers()

getLayoutSetID

public java.lang.String getLayoutSetID()

Gets the layoutSetID attribute of the AbstractUIMassCommand object

Returns:

The layoutSetID value

setLayoutSetID

public void setLayoutSetID(java.lang.String layoutSetID)

Sets the layoutSetID attribute of the AbstractUIMassCommand object

Parameters:

layoutSetID - The new layoutSetID value

getAlias

public java.lang.String getAlias()

Gets the alias attribute of the AbstractUIMassCommand object

Specified by:

getAlias in interface IExecCommand

Returns:

The alias value

setAlias

public void setAlias(java.lang.String alias)

Sets the alias attribute of the AbstractUIMassCommand object

Specified by:

setAlias in interface IExecCommand

Parameters:

alias - The new alias value

getBundleString

protected java.lang.String getBundleString(java.lang.String key,
                                           java.lang.Object[] obj)

returns the translated text with the given variables included in the object array. If the key cannot be found in the specified resource bundle, the class will check for it in its static default bundle. If it cannot be found here, an error message is logged and the alias of the implementing class is returned instead.

Parameters:

key - the key of the text to return - must not be null

obj - the variables to fill the place holders in the resource bundle, can be null

Returns:

The bundleString value

Throws:

java.util.MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected java.lang.String getBundleString(java.lang.String key)

returns the translated text for the given key. If the key cannot be found in the specified resource bundle, the class will check for it in its static default bundle. If it cannot be found here, an error message is logged and the alias of the implementing class is returned instead.

Parameters:

key - the key of the text to return - must not be null

Returns:

The bundleString value

Throws:

java.util.MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected java.lang.String getBundleString(java.lang.String key,
                                           java.lang.Object obj)

returns the translated text with the given variables included in the object. If the key cannot be found in the specified resource bundle, the class will check for it in its static default bundle. If it cannot be found here, an error message is logged and the alias of the implementing class is returned instead.

Parameters:

key - the key of the text to return - must not be null

obj - the variable to fill the place holder in the resource bundle, can be null

Returns:

The bundleString value

Throws:

java.util.MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected java.lang.String getBundleString(java.lang.String key,
                                           java.lang.Object obj1,
                                           java.lang.Object obj2)

returns the translated text with the given variables included in the two objects. If the key cannot be found in the specified resource bundle, the class will check for it in its static default bundle. If it cannot be found here, an error message is logged and the alias of the implementing class is returned instead.

Parameters:

key - the key of the text to return - must not be null

obj1 - the variable to fill the first place holder in the resource bundle, can be null

obj2 - the variable to fill the second place holder in the resource bundle, can be null *

Returns:

The bundleString value

Throws:

java.util.MissingResourceException - if the IResourceContext is not set for the command

handleWrongConfiguration

protected void handleWrongConfiguration()
                                 throws com.sapportals.wcm.control.base.InvalidConfigurationException

throws an InvalidConfigurationException that will be displayed on the screen and give further information what was invalid for the given configuration

Throws:

InvalidConfigurationException - Exception raised in failure situation

getReplaceCommands

public java.util.List getReplaceCommands()

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

Specified by:

getReplaceCommands in interface IUIBaseCommand

Returns:

The replaceCommands value

setReplaceCommands

public void setReplaceCommands(java.util.List replaceCommandsList)

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

Specified by:

setReplaceCommands in interface IUIBaseCommand

Parameters:

replaceCommandsList - The new replaceCommands value

isApplicable

public boolean isApplicable()

Gets the applicable attribute of the AbstractUIMassCommand object

Specified by:

isApplicable in interface IExecCommand

Returns:

The applicable value

setParameters

public void setParameters(java.util.Hashtable parameters)

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

Specified by:

setParameters in interface IUIBaseCommand

Parameters:

parameter - The new parameters value

getParameters

public java.util.Hashtable getParameters()

Gets the command parameters

Specified by:

getParameters in interface IUIBaseCommand

Returns:

The parameters value