com.sap.netweaver.bc.uwl.config

Class Action

java.lang.Object
  com.sap.netweaver.bc.uwl.config.Action

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

GroupAction

public class Action
extends Object
implements Cloneable, Serializable

Class that represents Action on a UWL item. An Action object instance is basically metadata and not meant to be modifed by the caller. Special note on User decision Actions: (Following section is deprecated for User Decisions. Refer to GroupAction for more details. User decision page is triggered by the UI Action denoted by the constant USER_DECISION_ACTION_OBJECT User decision actions displayed on a page consist of

1. A caption for all user decision. This caption is taken from any one of the Action's property with property denoted by as UserDecisionTitle or the constant value Action.USER_DECISION_TITLE for example property.put(Action.USER_DECISION_TITLE,"Select One of the Options")
2. An Optional note/comment/text. If note is required one of the Actions should have a property UserDecisionNote set as true or use the Constant value Action.USER_DECISION_NOTE for the property set as true. property.put(Action.USER_DECISION_NOTE,"true") When action is performed, a property UserDecisionNoteText holds the text value from the ui.
3. All user decision actions displayed as RadioButtons in one RadioButtonGroup

Dynamic properties of an Action.
Configuration of an Action in a configuration xml supports dynamic parameters. Convention for a variable is ${variable}. This variable can be item.'someAttribute' or context.someAttribute. Then reflection on the item is done to get that value. For example ${item.externalId} could be used to fill the external id. These variables cant be nested. Example on how to use dynamic properties of an Action:
<Action name="..." handler="...">
<Properties>
<Property name="workitemID" value="${item.externalId}"/>
</Properties>
</Action>
Brief information about different Action Handlers is present in ActionHandlers documentation

See Also:

GroupAction, Serialized Form

Field Summary

static String	ACCEPT
static String	ACTION_DECLINE Action to decline working on the item
static String	ACTION_END_FOLLOWUP Action to pull a future task to current time to be worked on
static String	ACTION_FOLLOWUP Action to push the need to work on a task to a later date
static String	ACTION_FORWARD Strings being declared in the uwl.standard.xml for forwarding items to one or more users
static String	ACTION_FORWARD_TO_ONE_USER Strings being declared in the uwl.standard.xml for forwarding items to one user
static String	ACTION_REPLACE Action to put the item back into the pool for processors
static String	ACTION_RESERVE Action to reserve the item from the pool from other processors
static String	ADD_MEMO
static String	ALERT_ACTION_CONFIRM Strings being declared in the uwl.standard.xml for confirming --closing-- Alerts
static String	APPLICATION
static String	APPROVE
static String	ATTACHMENT_CONTENT Action property for UPLOAD_ATTACHMENT: content in byte array
static String	ATTACHMENT_CONTROLLER This is a special action which will be added to the attachment sections to allow upload and removal of attachments.
static String	ATTACHMENT_FILENAME Action property for UPLOAD_ATTACHMENT: the name of the file to be attached, with file extension (if any)
static String	ATTACHMENT_ID Action property for REMOVE_ATTACHMENT
static String	BEGIN
static String	CANCEL_SUBPROCESS
static String	COMPLETE
static String	CONNECTOR_ID
static String	CONTEXT
static String	CUSTOMER_NAMESPACE Parameters for BSPLauncher
static String	DEFAULT_ACTION
static String	DELETE
static String	DISPLAY_PRIORITY Add this property key with a integer value to indicate if it should be display ahead of other actions in the detail/preview screens.
static String	DYNAMIC_PARAMS
static char	END
static char	ESCAPE
static String	FOLLOW_UP Action which require user selection must have this prefix.
static String	FUNCTION_MODULE_HANDLER
static String	FUTURE_DATE Action property for ACTION_FOLLOWUP
static String	GLOBAL_WIZARD
static String	IAC IAC Launcher parameter
static String	ITEM
static String	IVIEW_LAUNCHER
static String	LAUNCH_IN_NEW_WINDOW Deprecated. Use openInNewWindow() method, this has also be changed in the xml to allow using an attribute key when defining the action. See the DTD documentation for details.
static String	LAUNCH_NEW_WINDOW_FEATURES Deprecated. Use getNewWindowFeatures() method, this has also be changed in the xml to allow using an attribute key when defining the action. See the DTD documentation for details.
static String	LAUNCH_NEW_WINDOW_NAME Deprecated. Use getNewWindowName() method.
static String	LAUNCH_SUBSTITUTION_MANAGER
static String	LAUNCH_USER_DECISION the Action name to launch the User decision iView; launched by UI_ACTION_HANDLER
static String	MANAGE_ATTACHMENT
static String	MARK_AS_LAUNCHED
static String	MARK_AS_READ
static String	MARK_AS_UNREAD
static String	MULTI_USER_SELECTION_NEEDED If the action requires a user(s) selection, add this as one of the properties The property will be replace with the user id(s) when submitted to the provider.
static String	NAMESPACE
static String	NAVIGATION_KEYWORD
static String	OBJECT_LINK_LAUNCHER
static String	OBJECT_NAME ObjectNavigationLauncher parameters.
static String	OBJECT_NAVIGATION_LAUNCHER
static String	OBJECT_VALUE
static String	OPERATION
static String	PAGE_ID
static String	PCD_PREFIX
static String	PERSONALIZE_VIEW
static String	PORTAL_CONTENT
static String	PORTAL_EVENT_LAUNCHER
static String	PROVIDER_ACTION_HANDLER
static String	REFRESH_ACTION
static String	REFRESH_DETAIL
static String	REJECT
static String	REMOVE_ATTACHMENT
static String	RETURN_TO_TABLE
static String	SAP_BSP_LAUNCHER
static String	SAP_TRANSACTION_LAUNCHER
static String	SAP_WEBDYNPRO_ABAP_LAUNCHER
static String	SAP_WEBDYNPRO_LAUNCHER
static String	SAPAPP_LAUNCHER
static String	SAPIAC_LAUNCHER
static String	SAPMINIAPP_LAUNCHER
static String	SET_DONE
static String	SINGLE_USER_SELECTION_NEEDED If the action requires a user(s) selection, add this as one of the properties.
static String	SUBMIT_ACTION UIActionHandler commands
static String	SYSTEM Parameters shared by all launchers
static String	SYSTEM_ID_PROPERTY
static String	TASK_WIZARD
static String	TEMPLATE MiniApp Launcher parameter
static String	TERMINATING_EVENT_HANDLER
static String	UI_ACTION_HANDLER
static String	UI_EXCLUDE_ACTION If an Action is defined of an Item Type, a view can define the Action again with the action handler set to UI_EXCLUDE_ACTION.
static String	UI_EXLCUDE_ITEM_TYPE_ACTION If an Action is defined ine Item Type to be used in a menu only, this will then indicate the action should not be displayed in the preview and detail pages of this view.
static String	UPDATING_CONTAINER_HANDLER Only available in (supported by backend 6.20+)
static String	UPLOAD_ATTACHMENT
static String	UPLOAD_MEMO
static String	URL_LAUNCHER
static Action	USER_DECISION_ACTION_OBJECT
static String	USER_DECISION_HANDLER The name of the decision handler
static String	USER_DECISION_KEY Constant representign the User Decision key that is selected.
static String	USER_DECISION_NOTE flag indicating the attachment note in the user decision
static String	USER_DECISION_NOTE_MANDATORY flag indicating the attachment note in the user decision alternative is mandatory
static String	USER_DECISION_NOTE_TEXT the text of the attachment note in the user decision is saved in this property
static String	USER_DECISION_TITLE the title for decision options
static String	USER_ID action property for ACTION_FORWARD_TO_ONE_USER
static String	USER_ID_LIST action property for ACTION_FORWARD
static String	USER_NOTE
static String	UWL_HANDLER
static String	VIEW_DETAIL
static String	VIEW_HISTORY
static String	VIEW_PARENT_PROCESS_DETAIL
static String	VIEW_PREVIEW_DETAIL
static String	VIEW_SIMILAR
static String	VIEW_SUB_PROCESS_DETAIL
static String	WEB_DYNPRO_APP Parameters for Webdynpro Launchers
static String	WEB_DYNPRO_CONFIGURATION
static String	WEB_DYNPRO_NAMESPACE
static String	WEB_DYNPRO_OBJ
static String	WORK_ITEM_ID
static String	XHANDLER_LAUNCHER

Constructor Summary

Action(String name, String hand, Map props, Descriptions d, boolean uDecision)

Action(String name, String hand, Map props, Descriptions d, String bundle, boolean uDecision)

Action(String name, String hand, Map props, Descriptions d, String bundle, boolean uDecision, boolean openInNewWindow, String launchWindowName, String launchWindowFeatures)

Method Summary

Object	clone()
Descriptions	getConfirmActionDescriptions() If there is a confirmation text, which should be displayed before this action is ran, then this call will return the Descriptions.
Descriptions	getDisplayNames() Returns the ds.
String	getGroupName() This is used to determine if action should be group together with other actions of the same group name.
String	getHandler() Returns the handler.
String	getLongText(Locale locale) Get the long text for the specified locale.
String	getName() Returns the name.
String	getNewWindowFeatures() If the action is to be luanched in a new window this should return any desired features for defining the new browser window.
String	getNewWindowName() If the action is to be luanched in a new window this should return the new window browser name.
Map	getProperties() Returns the unmodifiable map
Map	getProperties(boolean bDynamic)
String	getProperty(String key)
Map	getPublicAndPrivateProperties() This is used be the Action Handler for the toDom and toStream calls.
String	getReferenceBundle()
String	getShortText(Locale locale) Return the action display name text for the specified Locale.
CompoundExpression	getValidityCriteria()
String	getWdPortalNavigationMode()
boolean	isDefaultGroupAction() Determine if this is the default action when used with the groupName method.
boolean	isDisable()
boolean	isGroupAction() Deprecated. No longer used. Use getGroupName.
boolean	isOpenInNewWindowWithPortalFrame()
boolean	isReturnToDetailViewAllowed() Determine if after the action is excuted from the detail page if it should return to the detail page or go back to the main page.
boolean	isShared()
boolean	openInNewWindow() Detemine if the action should be launched in a new window.
void	setConfirmActionDescriptions(Descriptions descriptions) Set the Descriptions for the confirmation text.
void	setDefaultGroupAction(boolean b) When used with in a groupName, this is the action to use as the default selection if set to true.
void	setDisable(boolean b) Set to true if the action should be displayed but disabled.
void	setGroupName(String string)
void	setNewWindowFeatures(String string)
void	setNewWindowName(String string)
void	setOpenInNewWindow(boolean b)
void	setOpenInNewWindowWithPortalFrame(boolean b)
void	setReturnToDetailViewAllowed(boolean b) If the action changes the item in a way, which will cause the detail page to be invalid (like deleting the item), set this flag to false to force the return to the main view and not back to the detail page.
void	setShared(boolean bSet)
void	setValidityCriteria(CompoundExpression expression)
void	setWdPortalNavigationMode(String wdPortalNavigationMode)

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN

public static final String BEGIN

See Also:

Constant Field Values

END

public static final char END

See Also:

Constant Field Values

ITEM

public static final String ITEM

See Also:

Constant Field Values

ESCAPE

public static final char ESCAPE

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

MARK_AS_READ

public static final String MARK_AS_READ

See Also:

Constant Field Values

MARK_AS_LAUNCHED

public static final String MARK_AS_LAUNCHED

See Also:

Constant Field Values

MARK_AS_UNREAD

public static final String MARK_AS_UNREAD

See Also:

Constant Field Values

SET_DONE

public static final String SET_DONE

See Also:

Constant Field Values

DELETE

public static final String DELETE

See Also:

Constant Field Values

CONNECTOR_ID

public static final String CONNECTOR_ID

See Also:

Constant Field Values

ACCEPT

public static final String ACCEPT

See Also:

Constant Field Values

REJECT

public static final String REJECT

See Also:

Constant Field Values

APPROVE

public static final String APPROVE

See Also:

Constant Field Values

COMPLETE

public static final String COMPLETE

See Also:

Constant Field Values

ACTION_REPLACE

public static final String ACTION_REPLACE

Action to put the item back into the pool for processors

See Also:

Constant Field Values

ACTION_RESERVE

public static final String ACTION_RESERVE

Action to reserve the item from the pool from other processors

See Also:

Constant Field Values

ACTION_DECLINE

public static final String ACTION_DECLINE

Action to decline working on the item

See Also:

Constant Field Values

REMOVE_ATTACHMENT

public static final String REMOVE_ATTACHMENT

See Also:

Constant Field Values

ATTACHMENT_ID

public static final String ATTACHMENT_ID

Action property for REMOVE_ATTACHMENT

See Also:

Constant Field Values

UPLOAD_ATTACHMENT

public static final String UPLOAD_ATTACHMENT

See Also:

Constant Field Values

ATTACHMENT_FILENAME

public static final String ATTACHMENT_FILENAME

Action property for UPLOAD_ATTACHMENT: the name of the file to be attached, with file extension (if any)

See Also:

Constant Field Values

ATTACHMENT_CONTENT

public static final String ATTACHMENT_CONTENT

Action property for UPLOAD_ATTACHMENT: content in byte array

See Also:

Constant Field Values

MANAGE_ATTACHMENT

public static final String MANAGE_ATTACHMENT

See Also:

Constant Field Values

VIEW_HISTORY

public static final String VIEW_HISTORY

See Also:

Constant Field Values

ADD_MEMO

public static final String ADD_MEMO

See Also:

Constant Field Values

UPLOAD_MEMO

public static final String UPLOAD_MEMO

See Also:

Constant Field Values

ACTION_FOLLOWUP

public static final String ACTION_FOLLOWUP

Action to push the need to work on a task to a later date

See Also:

Constant Field Values

FUTURE_DATE

public static final String FUTURE_DATE

Action property for ACTION_FOLLOWUP

See Also:

Constant Field Values

ACTION_END_FOLLOWUP

public static final String ACTION_END_FOLLOWUP

Action to pull a future task to current time to be worked on

See Also:

Constant Field Values

ACTION_FORWARD

public static final String ACTION_FORWARD

Strings being declared in the uwl.standard.xml for forwarding items to one or more users

See Also:

Constant Field Values

USER_ID_LIST

public static final String USER_ID_LIST

action property for ACTION_FORWARD

See Also:

Constant Field Values

ACTION_FORWARD_TO_ONE_USER

public static final String ACTION_FORWARD_TO_ONE_USER

Strings being declared in the uwl.standard.xml for forwarding items to one user

See Also:

Constant Field Values

USER_ID

public static final String USER_ID

action property for ACTION_FORWARD_TO_ONE_USER

See Also:

Constant Field Values

ALERT_ACTION_CONFIRM

public static final String ALERT_ACTION_CONFIRM

Strings being declared in the uwl.standard.xml for confirming --closing-- Alerts

See Also:

Constant Field Values

CANCEL_SUBPROCESS

public static final String CANCEL_SUBPROCESS

See Also:

Constant Field Values

LAUNCH_USER_DECISION

public static final String LAUNCH_USER_DECISION

the Action name to launch the User decision iView; launched by UI_ACTION_HANDLER

See Also:

Constant Field Values

USER_DECISION_KEY

public static final String USER_DECISION_KEY

Constant representign the User Decision key that is selected.

See Also:

Constant Field Values

UWL_HANDLER

public static final String UWL_HANDLER

See Also:

Constant Field Values

SAPAPP_LAUNCHER

public static final String SAPAPP_LAUNCHER

See Also:

ActionHandlers.html#SAPAppLauncher, Constant Field Values

SAPMINIAPP_LAUNCHER

public static final String SAPMINIAPP_LAUNCHER

See Also:

ActionHandlers.html#SAPMiniAppLauncher, Constant Field Values

SAPIAC_LAUNCHER

public static final String SAPIAC_LAUNCHER

See Also:

ActionHandlers.html#SAPIACLauncher, Constant Field Values

SAP_BSP_LAUNCHER

public static final String SAP_BSP_LAUNCHER

See Also:

ActionHandlers.html#SAPBSPLauncher, Constant Field Values

SAP_WEBDYNPRO_LAUNCHER

public static final String SAP_WEBDYNPRO_LAUNCHER

See Also:

ActionHandlers.html#SAPWebDynproLauncher, Constant Field Values

SAP_WEBDYNPRO_ABAP_LAUNCHER

public static final String SAP_WEBDYNPRO_ABAP_LAUNCHER

See Also:

ActionHandlers.html#SAPWebDynproABAPLauncher, Constant Field Values

SAP_TRANSACTION_LAUNCHER

public static final String SAP_TRANSACTION_LAUNCHER

See Also:

ActionHandlers.html#SAPTransactionLauncher, Constant Field Values

OBJECT_LINK_LAUNCHER

public static final String OBJECT_LINK_LAUNCHER

See Also:

ActionHandlers.html#ObjectLinkLauncher, Constant Field Values

OBJECT_NAVIGATION_LAUNCHER

public static final String OBJECT_NAVIGATION_LAUNCHER

See Also:

ActionHandlers.html#ObjectNavigationLauncher, Constant Field Values

PORTAL_EVENT_LAUNCHER

public static final String PORTAL_EVENT_LAUNCHER

See Also:

ActionHandlers.html#PortalEventLauncher, Constant Field Values

IVIEW_LAUNCHER

public static final String IVIEW_LAUNCHER

See Also:

ActionHandlers.html#IViewLauncher, Constant Field Values

URL_LAUNCHER

public static final String URL_LAUNCHER

See Also:

ActionHandlers.html#UrlLauncher, Constant Field Values

XHANDLER_LAUNCHER

public static final String XHANDLER_LAUNCHER

See Also:

ActionHandlers.html#XhandlerLauncher, Constant Field Values

FUNCTION_MODULE_HANDLER

public static final String FUNCTION_MODULE_HANDLER

See Also:

ActionHandlers.html#FunctionModuleActionHandler, Constant Field Values

UI_ACTION_HANDLER

public static final String UI_ACTION_HANDLER

See Also:

Constant Field Values

PROVIDER_ACTION_HANDLER

public static final String PROVIDER_ACTION_HANDLER

See Also:

Constant Field Values

TERMINATING_EVENT_HANDLER

public static final String TERMINATING_EVENT_HANDLER

See Also:

ActionHandlers.html#TerminatingEventHandler, Constant Field Values

UPDATING_CONTAINER_HANDLER

public static final String UPDATING_CONTAINER_HANDLER

Only available in (supported by backend 6.20+)

See Also:

ActionHandlers.html#UpdatingContainerHandler, Constant Field Values

SUBMIT_ACTION

public static final String SUBMIT_ACTION

UIActionHandler commands

See Also:

Constant Field Values

VIEW_SIMILAR

public static final String VIEW_SIMILAR

See Also:

Constant Field Values

VIEW_PREVIEW_DETAIL

public static final String VIEW_PREVIEW_DETAIL

See Also:

Constant Field Values

VIEW_DETAIL

public static final String VIEW_DETAIL

See Also:

Constant Field Values

VIEW_PARENT_PROCESS_DETAIL

public static final String VIEW_PARENT_PROCESS_DETAIL

See Also:

Constant Field Values

VIEW_SUB_PROCESS_DETAIL

public static final String VIEW_SUB_PROCESS_DETAIL

See Also:

Constant Field Values

REFRESH_DETAIL

public static final String REFRESH_DETAIL

See Also:

Constant Field Values

REFRESH_ACTION

public static final String REFRESH_ACTION

See Also:

Constant Field Values

RETURN_TO_TABLE

public static final String RETURN_TO_TABLE

See Also:

Constant Field Values

PERSONALIZE_VIEW

public static final String PERSONALIZE_VIEW

See Also:

Constant Field Values

GLOBAL_WIZARD

public static final String GLOBAL_WIZARD

See Also:

Constant Field Values

TASK_WIZARD

public static final String TASK_WIZARD

See Also:

Constant Field Values

LAUNCH_SUBSTITUTION_MANAGER

public static final String LAUNCH_SUBSTITUTION_MANAGER

See Also:

Constant Field Values

OBJECT_NAME

public static final String OBJECT_NAME

ObjectNavigationLauncher parameters.

See Also:

Constant Field Values

OPERATION

public static final String OPERATION

See Also:

Constant Field Values

OBJECT_VALUE

public static final String OBJECT_VALUE

See Also:

Constant Field Values

WEB_DYNPRO_APP

public static final String WEB_DYNPRO_APP

Parameters for Webdynpro Launchers

See Also:

Constant Field Values

WEB_DYNPRO_OBJ

public static final String WEB_DYNPRO_OBJ

See Also:

Constant Field Values

WEB_DYNPRO_NAMESPACE

public static final String WEB_DYNPRO_NAMESPACE

See Also:

Constant Field Values

WEB_DYNPRO_CONFIGURATION

public static final String WEB_DYNPRO_CONFIGURATION

See Also:

Constant Field Values

TEMPLATE

public static final String TEMPLATE

MiniApp Launcher parameter

See Also:

Constant Field Values

IAC

public static final String IAC

IAC Launcher parameter

See Also:

Constant Field Values

CUSTOMER_NAMESPACE

public static final String CUSTOMER_NAMESPACE

Parameters for BSPLauncher

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

APPLICATION

public static final String APPLICATION

See Also:

Constant Field Values

PAGE_ID

public static final String PAGE_ID

See Also:

Constant Field Values

SYSTEM

public static final String SYSTEM

Parameters shared by all launchers

See Also:

Constant Field Values

DYNAMIC_PARAMS

public static final String DYNAMIC_PARAMS

See Also:

Constant Field Values

ATTACHMENT_CONTROLLER

public static final String ATTACHMENT_CONTROLLER

This is a special action which will be added to the attachment sections to allow upload and removal of attachments. (Needs to be supported by the provider.)

See Also:

Constant Field Values

DEFAULT_ACTION

public static String DEFAULT_ACTION

FOLLOW_UP

public static final String FOLLOW_UP

Action which require user selection must have this prefix.

See Also:

Constant Field Values

USER_NOTE

public static final String USER_NOTE

See Also:

Constant Field Values

MULTI_USER_SELECTION_NEEDED

public static final String MULTI_USER_SELECTION_NEEDED

If the action requires a user(s) selection, add this as one of the properties The property will be replace with the user id(s) when submitted to the provider.

See Also:

Constant Field Values

SINGLE_USER_SELECTION_NEEDED

public static final String SINGLE_USER_SELECTION_NEEDED

If the action requires a user(s) selection, add this as one of the properties. The property will be replace with the user id(s) when submitted to the provider.

See Also:

Constant Field Values

USER_DECISION_HANDLER

public static final String USER_DECISION_HANDLER

The name of the decision handler

See Also:

Constant Field Values

USER_DECISION_TITLE

public static final String USER_DECISION_TITLE

the title for decision options

See Also:

Constant Field Values

USER_DECISION_NOTE

public static final String USER_DECISION_NOTE

flag indicating the attachment note in the user decision

See Also:

Constant Field Values

USER_DECISION_NOTE_MANDATORY

public static final String USER_DECISION_NOTE_MANDATORY

flag indicating the attachment note in the user decision alternative is mandatory

See Also:

Constant Field Values

USER_DECISION_NOTE_TEXT

public static final String USER_DECISION_NOTE_TEXT

the text of the attachment note in the user decision is saved in this property

See Also:

Constant Field Values

LAUNCH_IN_NEW_WINDOW

public static final String LAUNCH_IN_NEW_WINDOW

Deprecated. Use openInNewWindow() method, this has also be changed in the xml to allow using an attribute key when defining the action. See the DTD documentation for details.

If the Action is launchable and the Action has the property openInNewWindow=true will cause the UI to open a new browser window to launch the action.

See Also:

openInNewWindow, Constant Field Values

LAUNCH_NEW_WINDOW_NAME

public static final String LAUNCH_NEW_WINDOW_NAME

Deprecated. Use getNewWindowName() method.

If the Action is launchable and the Action has the property openInNewWindow=true will cause the UI to open a new browser window to launch the action using the new window name set in the action property newWindowName, this has also be changed in the xml to allow using an attribute key when defining the action. See the DTD documentation for details.

See Also:

getNewWindowName(), Constant Field Values

LAUNCH_NEW_WINDOW_FEATURES

public static final String LAUNCH_NEW_WINDOW_FEATURES

Deprecated. Use getNewWindowFeatures() method, this has also be changed in the xml to allow using an attribute key when defining the action. See the DTD documentation for details.

If the Action is launchable and the Action has the property openInNewWindow=true will cause the UI to open a new browser window to launch the action using the features set in the action property newWindowFeatures.

See Also:

getNewWindowFeatures(), Constant Field Values

UI_EXCLUDE_ACTION

public static final String UI_EXCLUDE_ACTION

If an Action is defined of an Item Type, a view can define the Action again with the action handler set to UI_EXCLUDE_ACTION. This will then indicate the action should not be displayed in the preview and detail pages of this view.
Example:
<Action name="progress" handler="uwlExcludeAction" referenceBundle="menu_action_no_description" />

See Also:

Constant Field Values

UI_EXLCUDE_ITEM_TYPE_ACTION

public static final String UI_EXLCUDE_ITEM_TYPE_ACTION

If an Action is defined ine Item Type to be used in a menu only, this will then indicate the action should not be displayed in the preview and detail pages of this view.
Example:

See Also:

Constant Field Values

DISPLAY_PRIORITY

public static final String DISPLAY_PRIORITY

Add this property key with a integer value to indicate if it should be display ahead of other actions in the detail/preview screens. The higher the number the more likely to be displayed first. If more then one action is defined with the same priority, then they will be group by priority and displayed in alphabetical order.

See Also:

Constant Field Values

SYSTEM_ID_PROPERTY

public static final String SYSTEM_ID_PROPERTY

See Also:

Constant Field Values

WORK_ITEM_ID

public static final String WORK_ITEM_ID

See Also:

Constant Field Values

PORTAL_CONTENT

public static final String PORTAL_CONTENT

See Also:

Constant Field Values

PCD_PREFIX

public static final String PCD_PREFIX

See Also:

Constant Field Values

NAVIGATION_KEYWORD

public static final String NAVIGATION_KEYWORD

See Also:

Constant Field Values

USER_DECISION_ACTION_OBJECT

public static final Action USER_DECISION_ACTION_OBJECT

Constructor Detail

Action

public Action(String name,
              String hand,
              Map props,
              Descriptions d,
              boolean uDecision)

Action

public Action(String name,
              String hand,
              Map props,
              Descriptions d,
              String bundle,
              boolean uDecision)

Action

public Action(String name,
              String hand,
              Map props,
              Descriptions d,
              String bundle,
              boolean uDecision,
              boolean openInNewWindow,
              String launchWindowName,
              String launchWindowFeatures)

Method Detail

getName

public String getName()

Returns the name.

Returns:

String

getProperty

public String getProperty(String key)

getProperties

public Map getProperties(boolean bDynamic)

Parameters:

bDynamic - if true returns only dynamic properties else only static.

Returns:

getShortText

public String getShortText(Locale locale)

Return the action display name text for the specified Locale. This text is used for the Button/Link text.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getLongText

public String getLongText(Locale locale)

Get the long text for the specified locale. This is the Text used to create the tooltip for the action.

Parameters:

locale -

Returns:

None NULL string will be returned. If the desired Text is not found then an empty string is returned.

getDisplayNames

public Descriptions getDisplayNames()

Returns the ds.

Returns:

Descriptions

isGroupAction

public boolean isGroupAction()

Deprecated. No longer used. Use getGroupName.

Returns the groupAction

Returns:

boolean

getHandler

public String getHandler()

Returns the handler.

Returns:

String

getPublicAndPrivateProperties

public Map getPublicAndPrivateProperties()

This is used be the Action Handler for the toDom and toStream calls.

Returns:

getProperties

public Map getProperties()

Returns the unmodifiable map

Returns:

Properties

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getReferenceBundle

public String getReferenceBundle()

getConfirmActionDescriptions

public Descriptions getConfirmActionDescriptions()

If there is a confirmation text, which should be displayed before this action is ran, then this call will return the Descriptions.

Returns:

Null if No Confirmation needed else the Descriptions

See Also:

Descriptions

setConfirmActionDescriptions

public void setConfirmActionDescriptions(Descriptions descriptions)

Set the Descriptions for the confirmation text.

Parameters:

descriptions -

openInNewWindow

public boolean openInNewWindow()

Detemine if the action should be launched in a new window.

Returns:

true if a new browser window should be opened else false to run the launch the action in the current browser.

setOpenInNewWindow

public void setOpenInNewWindow(boolean b)

Parameters:

b -

getNewWindowFeatures

public String getNewWindowFeatures()

If the action is to be luanched in a new window this should return any desired features for defining the new browser window.

Returns:

null if none specified.

See Also:

openInNewWindow

getNewWindowName

public String getNewWindowName()

If the action is to be luanched in a new window this should return the new window browser name.

Returns:

Defaults to "_blank" if not defined.

setNewWindowFeatures

public void setNewWindowFeatures(String string)

Parameters:

string -

setNewWindowName

public void setNewWindowName(String string)

Parameters:

string -

isReturnToDetailViewAllowed

public boolean isReturnToDetailViewAllowed()

Determine if after the action is excuted from the detail page if it should return to the detail page or go back to the main page.

Returns:

true if after the action has been excuted it is safe to return to the detail page.

setReturnToDetailViewAllowed

public void setReturnToDetailViewAllowed(boolean b)

If the action changes the item in a way, which will cause the detail page to be invalid (like deleting the item), set this flag to false to force the return to the main view and not back to the detail page.

Parameters:

b -

isShared

public boolean isShared()

setShared

public void setShared(boolean bSet)

isDisable

public boolean isDisable()

Returns:

setDisable

public void setDisable(boolean b)

Set to true if the action should be displayed but disabled.

Parameters:

b -

getValidityCriteria

public CompoundExpression getValidityCriteria()

Returns:

setValidityCriteria

public void setValidityCriteria(CompoundExpression expression)

Parameters:

expression -

getGroupName

public String getGroupName()

This is used to determine if action should be group together with other actions of the same group name. Current used to determine if actions will be displayed in the YouCanAlsoDo section or at the bottom of the preview area.

Returns:

Will return the group name for the action. yes is return if the boolean group flag was set.

setGroupName

public void setGroupName(String string)

Parameters:

string -

isDefaultGroupAction

public boolean isDefaultGroupAction()

Determine if this is the default action when used with the groupName method. If the groupName is not set this is not used. NOTE: Future enhancement when we use WD Button with dropdown feature.

Returns:

setDefaultGroupAction

public void setDefaultGroupAction(boolean b)

When used with in a groupName, this is the action to use as the default selection if set to true. In the Button Choose (Drop Down) it is used as the Button Label and default action if the button is pressed other wise it is added to the drop list of the button control. NOTE: Future enhancement when we use WD Button with dropdown feature.

Parameters:

b -

isOpenInNewWindowWithPortalFrame

public boolean isOpenInNewWindowWithPortalFrame()

Returns:

setOpenInNewWindowWithPortalFrame

public void setOpenInNewWindowWithPortalFrame(boolean b)

Parameters:

b -

getWdPortalNavigationMode

public String getWdPortalNavigationMode()

Returns:

Returns the wdPortalNavigationMode.

setWdPortalNavigationMode

public void setWdPortalNavigationMode(String wdPortalNavigationMode)

Parameters:

wdPortalNavigationMode - The wdPortalNavigationMode to set.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	-	EP-BC-UWL
[sap.com] UWLJWF	[sap.com] tc/kmc/bc.uwl/api	default	EP-BC-UWL