com.sap.netweaver.bc.uwl

Class GroupAction

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

All Implemented Interfaces:

Cloneable, Serializable

public final class GroupAction

extends Action

GroupAction contains bundling of different decision alternatives and their handler. A GroupAction contains, a title, decision alternatives and settings of whether a note/description is needed by the user. A GroupAction exists only at run time. An Item can have only one Group Action attached to it. UWL Service retrives GroupAction from the ProviderConnector and caches it for performance reasons. This Action has a fixed name called "GroupAction". Provider Connector could check for this name before retrieving all alternatives from the back end.
GroupAction instance is item specific and not shared between items and hence could be modified by the client.
All the texts in the Alternatives are already translated and are available only in one language that is the current users locale.
One restriction: None of the texts displayed should contain a carriage return character '\f'.

See Also:

Serialized Form

Nested Class Summary

static class

GroupAction.Alternative Each alternative contains a key and a title which is to be displayed.

Field Summary

static String

NAME

Fields inherited from class com.sap.netweaver.bc.uwl.config.Action

ACCEPT, ACTION_DECLINE, ACTION_END_FOLLOWUP, ACTION_FOLLOWUP, ACTION_FORWARD, ACTION_FORWARD_TO_ONE_USER, ACTION_REPLACE, ACTION_RESERVE, ADD_MEMO, ALERT_ACTION_CONFIRM, APPLICATION, APPROVE, ATTACHMENT_CONTENT, ATTACHMENT_CONTROLLER, ATTACHMENT_FILENAME, ATTACHMENT_ID, BEGIN, CANCEL_SUBPROCESS, COMPLETE, CONNECTOR_ID, CONTEXT, CUSTOMER_NAMESPACE, DEFAULT_ACTION, DELETE, DISPLAY_PRIORITY, DYNAMIC_PARAMS, END, ESCAPE, FOLLOW_UP, FUNCTION_MODULE_HANDLER, FUTURE_DATE, GLOBAL_WIZARD, IAC, ITEM, IVIEW_LAUNCHER, LAUNCH_IN_NEW_WINDOW, LAUNCH_NEW_WINDOW_FEATURES, LAUNCH_NEW_WINDOW_NAME, LAUNCH_SUBSTITUTION_MANAGER, LAUNCH_USER_DECISION, MANAGE_ATTACHMENT, MARK_AS_LAUNCHED, MARK_AS_READ, MARK_AS_UNREAD, MULTI_USER_SELECTION_NEEDED, NAMESPACE, NAVIGATION_KEYWORD, OBJECT_LINK_LAUNCHER, OBJECT_NAME, OBJECT_NAVIGATION_LAUNCHER, OBJECT_VALUE, OPERATION, PAGE_ID, PCD_PREFIX, PERSONALIZE_VIEW, PORTAL_CONTENT, PORTAL_EVENT_LAUNCHER, PROVIDER_ACTION_HANDLER, REFRESH_ACTION, REFRESH_DETAIL, REJECT, REMOVE_ATTACHMENT, RETURN_TO_TABLE, SAP_BSP_LAUNCHER, SAP_TRANSACTION_LAUNCHER, SAP_WEBDYNPRO_ABAP_LAUNCHER, SAP_WEBDYNPRO_LAUNCHER, SAPAPP_LAUNCHER, SAPIAC_LAUNCHER, SAPMINIAPP_LAUNCHER, SET_DONE, SINGLE_USER_SELECTION_NEEDED, SUBMIT_ACTION, SYSTEM, SYSTEM_ID_PROPERTY, TASK_WIZARD, TEMPLATE, TERMINATING_EVENT_HANDLER, UI_ACTION_HANDLER, UI_EXCLUDE_ACTION, UI_EXLCUDE_ITEM_TYPE_ACTION, UPDATING_CONTAINER_HANDLER, UPLOAD_ATTACHMENT, UPLOAD_MEMO, URL_LAUNCHER, USER_DECISION_ACTION_OBJECT, USER_DECISION_HANDLER, USER_DECISION_KEY, USER_DECISION_NOTE, USER_DECISION_NOTE_MANDATORY, USER_DECISION_NOTE_TEXT, USER_DECISION_TITLE, USER_ID, USER_ID_LIST, USER_NOTE, UWL_HANDLER, VIEW_DETAIL, VIEW_HISTORY, VIEW_PARENT_PROCESS_DETAIL, VIEW_PREVIEW_DETAIL, VIEW_SIMILAR, VIEW_SUB_PROCESS_DETAIL, WEB_DYNPRO_APP, WEB_DYNPRO_CONFIGURATION, WEB_DYNPRO_NAMESPACE, WEB_DYNPRO_OBJ, WORK_ITEM_ID, XHANDLER_LAUNCHER

Constructor Summary

GroupAction(String handler, String title)

Method Summary

GroupAction.Alternative	getAlternative(String key)
GroupAction.Alternative[]	getAlternatives()
String	getSelectedAlternativeKey()
boolean	isUserNoteNeeded() In addition to choosing a decision alternative, end user may optionally add a free text note.
static GroupAction	parseString(String str) Internal method used to deserialize from string.
void	setDecisionAlternatives(GroupAction.Alternative[] alternatives)
void	setDecisionAlternatives(List lternatives)
void	setNeedsUserNote(boolean b)
boolean	setSelectedAlternativeKey(String key) This should be called before calling itemManager.performAction().
String	toString() Internal method used to serialize the Action

Methods inherited from class com.sap.netweaver.bc.uwl.config.Action

clone, getConfirmActionDescriptions, getDisplayNames, getGroupName, getHandler, getLongText, getName, getNewWindowFeatures, getNewWindowName, getProperties, getProperties, getProperty, getPublicAndPrivateProperties, getReferenceBundle, getShortText, getValidityCriteria, isDefaultGroupAction, isDisable, isGroupAction, isOpenInNewWindowWithPortalFrame, isReturnToDetailViewAllowed, isShared, openInNewWindow, setConfirmActionDescriptions, setDefaultGroupAction, setDisable, setGroupName, setNewWindowFeatures, setNewWindowName, setOpenInNewWindow, setOpenInNewWindowWithPortalFrame, setReturnToDetailViewAllowed, setShared, setValidityCriteria

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

GroupAction

public GroupAction(String handler,
                   String title)

Parameters:

handler - ActionHandler identifer

title - Title for all the decision Alternatives

Method Detail

setDecisionAlternatives

public final void setDecisionAlternatives(List lternatives)

Parameters:

lternatives - should contain a list of Alternative object instances.

setDecisionAlternatives

public final void setDecisionAlternatives(GroupAction.Alternative[] alternatives)

getAlternatives

public GroupAction.Alternative[] getAlternatives()

Returns:

not null, decision options.

getAlternative

public GroupAction.Alternative getAlternative(String key)

Parameters:

key -

Returns:

an alternative object for the specified key

isUserNoteNeeded

public boolean isUserNoteNeeded()

In addition to choosing a decision alternative, end user may optionally add a free text note.

Returns:

true if needed

setNeedsUserNote

public void setNeedsUserNote(boolean b)

Parameters:

b - true sets the user note visibility

toString

public String toString()

Internal method used to serialize the Action

parseString

public static GroupAction parseString(String str)

Internal method used to deserialize from string.

Parameters:

str -

Returns:

GroupAction instance which could be null.

getSelectedAlternativeKey

public String getSelectedAlternativeKey()

Returns:

could be null

setSelectedAlternativeKey

public boolean setSelectedAlternativeKey(String key)

This should be called before calling itemManager.performAction().

Returns:

true if the key passed is the valid key, false otherwise.