public abstract class AbstractMassCommand extends Object implements IMassCommand
Modifier and Type | Field and Description |
---|---|
protected int |
applicable
Deprecated.
|
static RID |
ROOT_RID
Deprecated.
|
APPLICABLE_FALSE, APPLICABLE_TRUE, APPLICABLE_UNKNOWN
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 and Description |
---|
AbstractMassCommand()
Deprecated.
As of NetWeaver 7.1
|
AbstractMassCommand(String keyLabel,
String keyTooltip)
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Method and Description |
---|---|
protected boolean |
checkArchivingStauts(IResource resource)
Deprecated.
Read archiving status for the given resource and check it.
|
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 |
getLabel()
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
|
IProxy |
getProxy()
Deprecated.
As of NetWeaver 7.1
|
List |
getReplaceCommands()
Deprecated.
As of NetWeaver 7.1
|
protected IResource |
getResource()
Deprecated.
As of NetWeaver 7.1
|
IResourceContext |
getResourceContext()
Deprecated.
As of NetWeaver 7.1
|
protected IResourceList |
getResourceList()
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
|
protected Properties |
getTextProperties()
Deprecated.
As of NetWeaver 7.1
|
String |
getTooltip()
Deprecated.
As of NetWeaver 7.1
|
IMandatoryField[] |
getUserInputSpecifiers()
Deprecated.
As of NetWeaver 7.1
|
protected void |
handleWrongConfiguration()
Deprecated.
As of NetWeaver 7.1
|
protected IMassCommand |
initNewInstance(IMassCommand command)
Deprecated.
As of NetWeaver 7.1
|
boolean |
isApplicable()
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
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
execute, getNewInstance
isExecutable
protected int applicable
public static RID ROOT_RID
public AbstractMassCommand()
UICommandFactory
, when command is
created for the first timepublic AbstractMassCommand(String keyLabel, String keyTooltip)
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
public boolean raisesEvent()
IExecCommand
Event
in its execute
method.raisesEvent
in interface IExecCommand
Component
rendered for this command will result in an Event
or not.public LinkAttributes getLinkAttributes()
IExecCommand
LinkAttributes
when the Command returns false
in its raisesEvent
method.getLinkAttributes
in interface IExecCommand
LinkAttributes
when the Command returns false
in its raisesEvent
method,
null
otherwise.public void setResourceBundle(ResourceBundles bundleFile)
setResourceBundle
in interface IUIBaseCommand
bundleFile
- the bundle the command uses to retrieve its texts.public void setTextProperties(Properties properties)
setTextProperties
in interface IExecCommand
setTextProperties
in interface IMassCommand
properties
- should hold key-value pairs with keys defined in IUIBaseCommand.TEXT_KEYS
. Other key-value pairs will not be used.protected Properties getTextProperties()
public void setConfigurationProperties(Properties properties)
setConfigurationProperties
in interface IUIBaseCommand
properties
- free properties bag to be used by a command.public Properties getConfigurationProperties()
getConfigurationProperties
in interface IUIBaseCommand
public void setLabelBundleKey(String label)
setLabelBundleKey
in interface IUIBaseCommand
label
- The new labelBundleKey valuepublic void setTooltipBundleKey(String tooltip)
setTooltipBundleKey
in interface IUIBaseCommand
tooltip
- The new tooltipBundleKey valuepublic void setResourceList(IResourceList list)
setResourceList
in interface IMassExecCommand
list
- The new resourceList valueprotected IResourceList getResourceList()
public void setProxy(AbstractProxyControl proxy)
setProxy
in interface IUIBaseCommand
proxy
- The new proxy valuepublic void setResourceContext(IResourceContext context)
setResourceContext
in interface IUIBaseCommand
context
- The new resourceContext valuepublic IResourceContext getResourceContext()
public IProxy getProxy()
public void setResource(IResource resource)
setResource
in interface IUIBaseCommand
resource
- sets the resource the command shall operate onprotected IResource getResource()
public com.sapportals.htmlb.Component getComponent()
getComponent
in interface IUIBaseCommand
null
;public String getTooltip()
public String getLabel()
public String getText(TextKey key)
getText
in interface IUIBaseCommand
key
- Description of the parampublic String[] getTargetParameters() throws WcmException
null
. A number of IUIMassCommands
do not need
to add any information in the Event
s parameter list. When extending
this abstract class, there is no need to implement this method.getTargetParameters
in interface IExecCommand
WcmException
- Exception raised in failure situationpublic void setTargetParameters(List values, IResourceContext context) throws WcmException
null
, when this abstract classes getTargetParameters
method is used,
only the context parameter is used in this method.setTargetParameters
in interface IExecCommand
values
- The new targetParameters value - not used in this implementationcontext
- The ResourceContext - this is always neededWcmException
- Exception raised in failure situationprotected final IMassCommand initNewInstance(IMassCommand command)
getNewInstance
method 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.command
- Description of the parampublic String getTextForSecondaryScreen(String key)
key
- Description of the parampublic IMandatoryField[] getUserInputSpecifiers()
public String getLayoutSetID()
public void setLayoutSetID(String layoutSetID)
layoutSetID
- The new layoutSetID valuepublic String getAlias()
getAlias
in interface IExecCommand
public void setAlias(String alias)
setAlias
in interface IExecCommand
alias
- The new alias valueprotected String getBundleString(String key, Object[] obj)
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
MissingResourceException
- if the IResourceContext
is not
set for the commandprotected String getBundleString(String key)
key
- the key of the text to return - must not be
null
MissingResourceException
- if the IResourceContext
is not
set for the commandprotected String getBundleString(String key, Object obj)
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
MissingResourceException
- if the IResourceContext
is not
set for the commandprotected String getBundleString(String key, Object obj1, Object obj2)
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
*MissingResourceException
- if the IResourceContext
is not
set for the commandprotected void handleWrongConfiguration() throws InvalidConfigurationException
InvalidConfigurationException
that will be displayed
on the screen and give further information what was invalid for the given configurationInvalidConfigurationException
- Exception raised in failure situationpublic List getReplaceCommands()
getReplaceCommands
in interface IUIBaseCommand
public void setReplaceCommands(List replaceCommandsList)
setReplaceCommands
in interface IUIBaseCommand
replaceCommandsList
- The new replaceCommands valuepublic boolean isApplicable()
isApplicable
in interface IExecCommand
public void setParameters(Hashtable parameters)
setParameters
in interface IUIBaseCommand
parameters
- The new parameters valuepublic Hashtable getParameters()
getParameters
in interface IUIBaseCommand
protected boolean checkArchivingStauts(IResource resource)
resource
- resourceAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice