com.sapportals.wcm.rendering.uicommand

Class AbstractUIMassCommand

java.lang.Object
  com.sapportals.wcm.rendering.uicommand.AbstractUIMassCommand

All Implemented Interfaces:

IUIBaseCommand, IExecCommand, IMassExecCommand, IUIMassCommand

Deprecated. As of EP 5.0 SP6 and EP 6.0 SP1, replaced by AbstractMassCommand

public abstract class AbstractUIMassCommand
extends Object
implements IUIMassCommand

Copyright 2004 SAP AG

Field Summary

protected int	applicable Deprecated.
protected IResourceContext	context Deprecated.
String	layoutSetID Deprecated. Layout Set ID
IResourceList	list Deprecated.
IResource	resource Deprecated. Description of the Field

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

AbstractUIMassCommand()
Deprecated. As of NetWeaver 7.1

AbstractUIMassCommand(String keyLabel, String keyTooltip)
Deprecated. As of NetWeaver 7.1

Method Summary

boolean	allowUserInput() Deprecated. As of NetWeaver 7.1
protected boolean	checkArchivingStauts(IResource resource) Deprecated. Read archiving status for the given resource and check it.
com.sapportals.wdf.event.WdfEvent	execute(com.sapportals.wdf.ControllerDynPage dynpage, boolean pushStack) Deprecated. As of NetWeaver 7.1
String	getAlias() Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key) Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key, Object obj) Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key, Object[] obj) Deprecated. As of NetWeaver 7.1
protected String	getBundleString(String key, Object obj1, Object obj2) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	getComponent() Deprecated. As of NetWeaver 7.1
Properties	getConfigurationProperties() Deprecated. As of NetWeaver 7.1
String	getDefaultInput(String key) Deprecated. As of NetWeaver 7.1
String	getLabel() Deprecated. As of NetWeaver 7.1
String	getLabel(String key) Deprecated. As of NetWeaver 7.1
String	getLayoutSetID() Deprecated. As of NetWeaver 7.1
LinkAttributes	getLinkAttributes() Deprecated. As of NetWeaver 7.1
Hashtable	getParameters() Deprecated. As of NetWeaver 7.1
AbstractProxyControl	getProxy() Deprecated. As of NetWeaver 7.1
List	getReplaceCommands() Deprecated. As of NetWeaver 7.1
IResourceContext	getResourceContext() Deprecated. As of NetWeaver 7.1
String[]	getTargetParameters() Deprecated. As of NetWeaver 7.1
String	getText(TextKey key) Deprecated. As of NetWeaver 7.1
String	getTextForSecondaryScreen(String key) Deprecated. As of NetWeaver 7.1
String	getTooltip() Deprecated. As of NetWeaver 7.1
protected void	handleWrongConfiguration() Deprecated. As of NetWeaver 7.1
protected IUIMassCommand	initNewInstance(IUIMassCommand command) Deprecated. As of NetWeaver 7.1
boolean	isApplicable() Deprecated. As of NetWeaver 7.1
protected boolean	isMatchedPath(String[] paths, String resourcePath) Deprecated. As of NetWeaver 7.1
boolean	raisesEvent() Deprecated. As of NetWeaver 7.1
void	setAlias(String alias) Deprecated. As of NetWeaver 7.1
void	setConfigurationProperties(Properties properties) Deprecated. As of NetWeaver 7.1
void	setLabelBundleKey(String label) Deprecated. As of NetWeaver 7.1
void	setLayoutSetID(String layoutSetID) 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	setResourceList(IResourceList list) Deprecated. As of NetWeaver 7.1
void	setTargetParameters(List values, IResourceContext context) Deprecated. As of NetWeaver 7.1
void	setTextProperties(Properties properties) Deprecated. As of NetWeaver 7.1
void	setTooltipBundleKey(String tooltip) Deprecated. As of NetWeaver 7.1

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.IUIMassCommand

execute, getNewInstance

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

isExecutable

Field Detail

list

public IResourceList list

Deprecated.

context

protected IResourceContext context

Deprecated.

resource

public IResource resource

Deprecated.

Description of the Field

layoutSetID

public String layoutSetID

Deprecated.

Layout Set ID

applicable

protected int applicable

Deprecated.

Constructor Detail

AbstractUIMassCommand

public AbstractUIMassCommand()

Deprecated. As of NetWeaver 7.1

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

AbstractUIMassCommand

public AbstractUIMassCommand(String keyLabel,
                             String keyTooltip)

Deprecated. As of NetWeaver 7.1

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()

Deprecated. As of NetWeaver 7.1

Description copied from interface: IExecCommand

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

Specified by:

raisesEvent in interface IExecCommand

Returns:

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

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()

Deprecated. As of NetWeaver 7.1

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)

Deprecated. As of NetWeaver 7.1

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(Properties properties)

Deprecated. As of NetWeaver 7.1

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

Specified by:

setTextProperties in interface IExecCommand

Specified by:

setTextProperties in interface IUIMassCommand

Parameters:

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

setConfigurationProperties

public void setConfigurationProperties(Properties properties)

Deprecated. As of NetWeaver 7.1

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 Properties getConfigurationProperties()

Deprecated. As of NetWeaver 7.1

Gets the configurationProperties attribute of the AbstractUIMassCommand object

Specified by:

getConfigurationProperties in interface IUIBaseCommand

Returns:

The configurationProperties value

setLabelBundleKey

public void setLabelBundleKey(String label)

Deprecated. As of NetWeaver 7.1

currently not implemented.

Specified by:

setLabelBundleKey in interface IUIBaseCommand

Parameters:

label - The new labelBundleKey value

setTooltipBundleKey

public void setTooltipBundleKey(String tooltip)

Deprecated. As of NetWeaver 7.1

currently not implemented.

Specified by:

setTooltipBundleKey in interface IUIBaseCommand

Parameters:

tooltip - The new tooltipBundleKey value

setResourceList

public void setResourceList(IResourceList list)

Deprecated. As of NetWeaver 7.1

Sets the resource list, the command operates on

Specified by:

setResourceList in interface IMassExecCommand

Parameters:

list - The new resourceList value

setProxy

public void setProxy(AbstractProxyControl proxy)

Deprecated. As of NetWeaver 7.1

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)

Deprecated. As of NetWeaver 7.1

Sets the resourceContext for IUICommand

Specified by:

setResourceContext in interface IUIBaseCommand

Parameters:

context - The new resourceContext value

getResourceContext

public IResourceContext getResourceContext()

Deprecated. As of NetWeaver 7.1

Returns:

the context the command is operating on

getProxy

public AbstractProxyControl getProxy()

Deprecated. As of NetWeaver 7.1

Gets the proxy attribute of the AbstractUICommand object

Returns:

The proxy value

setResource

public void setResource(IResource resource)

Deprecated. As of NetWeaver 7.1

Specified by:

setResource in interface IUIBaseCommand

Parameters:

resource - sets the resource the command shall operate on

getComponent

public com.sapportals.htmlb.Component getComponent()

Deprecated. As of NetWeaver 7.1

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 String getTooltip()

Deprecated. As of NetWeaver 7.1

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 String getLabel()

Deprecated. As of NetWeaver 7.1

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 String getText(TextKey key)

Deprecated. As of NetWeaver 7.1

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 String[] getTargetParameters()
                             throws WcmException

Deprecated. As of NetWeaver 7.1

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(List values,
                                IResourceContext context)
                         throws WcmException

Deprecated. As of NetWeaver 7.1

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

execute

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

Deprecated. As of NetWeaver 7.1

calls the execute method without parameters.

Specified by:

execute in interface IUIMassCommand

Parameters:

dynpage - - not used

pushStack - - not used

Returns:

Description of the Return Value

Throws:

com.sapportals.wdf.WdfException - Exception raised in failure situation

initNewInstance

protected final IUIMassCommand initNewInstance(IUIMassCommand command)

Deprecated. As of NetWeaver 7.1

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 String getTextForSecondaryScreen(String key)

Deprecated. As of NetWeaver 7.1

Gets the textForSecondaryScreen attribute of the AbstractUIMassCommand object

Parameters:

key - Description of the param

Returns:

The textForSecondaryScreen value

getLabel

public String getLabel(String key)

Deprecated. As of NetWeaver 7.1

getDefaultInput

public String getDefaultInput(String key)

Deprecated. As of NetWeaver 7.1

getLayoutSetID

public String getLayoutSetID()

Deprecated. As of NetWeaver 7.1

Gets the layoutSetID attribute of the AbstractUIMassCommand object

Returns:

The layoutSetID value

setLayoutSetID

public void setLayoutSetID(String layoutSetID)

Deprecated. As of NetWeaver 7.1

Sets the layoutSetID attribute of the AbstractUIMassCommand object

Parameters:

layoutSetID - The new layoutSetID value

getAlias

public String getAlias()

Deprecated. As of NetWeaver 7.1

Gets the alias attribute of the AbstractUIMassCommand object

Specified by:

getAlias in interface IExecCommand

Returns:

The alias value

setAlias

public void setAlias(String alias)

Deprecated. As of NetWeaver 7.1

Sets the alias attribute of the AbstractUIMassCommand object

Specified by:

setAlias in interface IExecCommand

Parameters:

alias - The new alias value

getBundleString

protected String getBundleString(String key,
                                 Object[] obj)

Deprecated. As of NetWeaver 7.1

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:

MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected String getBundleString(String key)

Deprecated. As of NetWeaver 7.1

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:

MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected String getBundleString(String key,
                                 Object obj)

Deprecated. As of NetWeaver 7.1

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:

MissingResourceException - if the IResourceContext is not set for the command

getBundleString

protected String getBundleString(String key,
                                 Object obj1,
                                 Object obj2)

Deprecated. As of NetWeaver 7.1

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:

MissingResourceException - if the IResourceContext is not set for the command

handleWrongConfiguration

protected void handleWrongConfiguration()
                                 throws InvalidConfigurationException

Deprecated. As of NetWeaver 7.1

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 List getReplaceCommands()

Deprecated. As of NetWeaver 7.1

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(List replaceCommandsList)

Deprecated. As of NetWeaver 7.1

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()

Deprecated. As of NetWeaver 7.1

Gets the applicable attribute of the AbstractUIMassCommand object

Specified by:

isApplicable in interface IExecCommand

Returns:

The applicable value

isMatchedPath

protected boolean isMatchedPath(String[] paths,
                                String resourcePath)

Deprecated. As of NetWeaver 7.1

setParameters

public 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.

Specified by:

setParameters in interface IUIBaseCommand

Parameters:

parameters - The new parameters value

getParameters

public Hashtable getParameters()

Deprecated. As of NetWeaver 7.1

Gets the command parameters

Specified by:

getParameters in interface IUIBaseCommand

Returns:

The parameters value

allowUserInput

public boolean allowUserInput()

Deprecated. As of NetWeaver 7.1

checkArchivingStauts

protected boolean checkArchivingStauts(IResource resource)

Deprecated.

Read archiving status for the given resource and check it. Return true if the status is Null (this means ALLOWED),ALLOWED,WAITING_APPROVAL,REJECTED and FORBIDDEN if the status is null(this is A in all other cases it's returns false. This method return true in case when "Archiving service" is deactivated.

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