net.ontopia.topicmaps.webed.impl.basic

Interface ActionGroupIF

All Known Implementing Classes:

ActionGroup

public interface ActionGroupIF

INTERNAL: The interface is implemented by objects representing action groups that handle and provide access to a collection of actions.

Method Summary

Modifier and Type	Method and Description
void	addAction(ActionInGroup action) INTERNAL: Add an action to this action group.
ActionInGroup	getAction(String name) INTERNAL: Gets the action by the given name.
List	getActions() INTERNAL: Returns all actions that are assigned to this action group in the order in which they are to be executed.
ActionForwardPageIF	getDefaultForwardPage(int responseType) INTERNAL: Gets the forward page which should be used as default for the given action response type.
Map	getDefaultForwardPages() INTERNAL: Gets all default forward pages assigned to this action group.
ActionForwardPageIF	getForwardPage(ActionInGroup action, boolean error) INTERNAL: Gets the forward page for the given action and response type.
Map	getForwardPages() INTERNAL: Gets all forward pages assigned to this action group.
ActionForwardPageIF	getLockedForwardPage() INTERNAL: Gets the forward page to use when locking fails.
String	getName() INTERNAL: Gets the name of this action group.
void	setDefaultForwardPage(int responseType, ActionForwardPageIF forwardPage) INTERNAL: Sets the default forward page for the given action response type.
void	setForwardPage(ActionInGroup action, int responseType, ActionForwardPageIF forwardPage) INTERNAL: Sets forward page for the given pair of action and action response type.
void	setLockedForwardPage(ActionForwardPageIF forwardPage) INTERNAL: Sets the forward page in the case a lock situation

Method Detail

getName

String getName()

INTERNAL: Gets the name of this action group.

addAction

void addAction(ActionInGroup action)

INTERNAL: Add an action to this action group. Note that the order in which actions are added is significant.

getActions

List getActions()

INTERNAL: Returns all actions that are assigned to this action group in the order in which they are to be executed.

Returns:

a list of ActionInGroup objects

getAction

ActionInGroup getAction(String name)

INTERNAL: Gets the action by the given name.

setDefaultForwardPage

void setDefaultForwardPage(int responseType,
                           ActionForwardPageIF forwardPage)

INTERNAL: Sets the default forward page for the given action response type.

getDefaultForwardPage

ActionForwardPageIF getDefaultForwardPage(int responseType)

INTERNAL: Gets the forward page which should be used as default for the given action response type. If there is no specific forward page for the given response type tries to retrieve the generic forward page, otherwise null.

getDefaultForwardPages

Map getDefaultForwardPages()

INTERNAL: Gets all default forward pages assigned to this action group.

Returns:

A map containing the action response type (as Integer object, see ActionResponseIF constants) as key and the corresponding ActionForwardPageIF object.

setLockedForwardPage

void setLockedForwardPage(ActionForwardPageIF forwardPage)

INTERNAL: Sets the forward page in the case a lock situation

getLockedForwardPage

ActionForwardPageIF getLockedForwardPage()

INTERNAL: Gets the forward page to use when locking fails.

setForwardPage

void setForwardPage(ActionInGroup action,
                    int responseType,
                    ActionForwardPageIF forwardPage)

INTERNAL: Sets forward page for the given pair of action and action response type.

getForwardPage

ActionForwardPageIF getForwardPage(ActionInGroup action,
                                   boolean error)

INTERNAL: Gets the forward page for the given action and response type. The following order has to be implemented for resolving an appropiate forward page:

• try to get forward page for specified action and response type,
• if not found: try to get generic forward page for given action,
• if not found: try to get default forward page for given response type,
• if not found: try to get generic default forward page,
• if not found: return null.

Parameters:

error - whether there was an error or not.

getForwardPages

Map getForwardPages()

INTERNAL: Gets all forward pages assigned to this action group.

Returns:

A map containing the action response (as ActionResponseComposite object) as key and the corresponding ActionForwardPageIF object.