net.ontopia.topicmaps.webed.impl.basic
Class ActionGroup

java.lang.Object
  net.ontopia.topicmaps.webed.impl.basic.ActionGroup

All Implemented Interfaces:

ActionGroupIF

public class ActionGroup
extends java.lang.Object
implements ActionGroupIF

INTERNAL: Basic implementation of ActionGroupIF interface, for storing a set of action objects belonging to a common group.

Constructor Summary

ActionGroup(java.lang.String actionName)
Default constructor.

Method Summary

void	addAction(ActionInGroup action) INTERNAL: Add an action to this action group.
boolean	equals(java.lang.Object obj)
ActionInGroup	getAction(java.lang.String name) INTERNAL: Gets the action by the given name.
java.util.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.
java.util.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.
java.util.Map	getForwardPages() INTERNAL: Gets all forward pages assigned to this action group.
ActionForwardPageIF	getLockedForwardPage() INTERNAL: Gets the forward page to use when locking fails.
java.lang.String	getName() INTERNAL: Gets the name of this action group.
int	hashCode()
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
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ActionGroup

public ActionGroup(java.lang.String actionName)

Default constructor.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ActionGroupIF

INTERNAL: Gets the name of this action group.

Specified by:

getName in interface ActionGroupIF

addAction

public void addAction(ActionInGroup action)

Description copied from interface: ActionGroupIF

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

Specified by:

addAction in interface ActionGroupIF

getActions

public java.util.List getActions()

Description copied from interface: ActionGroupIF

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

Specified by:

getActions in interface ActionGroupIF

Returns:

a list of ActionInGroup objects

getAction

public ActionInGroup getAction(java.lang.String name)

Description copied from interface: ActionGroupIF

INTERNAL: Gets the action by the given name.

Specified by:

getAction in interface ActionGroupIF

setDefaultForwardPage

public void setDefaultForwardPage(int responseType,
                                  ActionForwardPageIF forwardPage)

Description copied from interface: ActionGroupIF

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

Specified by:

setDefaultForwardPage in interface ActionGroupIF

getDefaultForwardPage

public ActionForwardPageIF getDefaultForwardPage(int responseType)

Description copied from interface: ActionGroupIF

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.

Specified by:

getDefaultForwardPage in interface ActionGroupIF

getDefaultForwardPages

public java.util.Map getDefaultForwardPages()

Description copied from interface: ActionGroupIF

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

Specified by:

getDefaultForwardPages in interface ActionGroupIF

Returns:

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

setLockedForwardPage

public void setLockedForwardPage(ActionForwardPageIF forwardPage)

Description copied from interface: ActionGroupIF

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

Specified by:

setLockedForwardPage in interface ActionGroupIF

getLockedForwardPage

public ActionForwardPageIF getLockedForwardPage()

Description copied from interface: ActionGroupIF

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

Specified by:

getLockedForwardPage in interface ActionGroupIF

setForwardPage

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

Description copied from interface: ActionGroupIF

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

Specified by:

setForwardPage in interface ActionGroupIF

getForwardPage

public ActionForwardPageIF getForwardPage(ActionInGroup action,
                                          boolean error)

Description copied from interface: ActionGroupIF

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.

Specified by:

getForwardPage in interface ActionGroupIF

error - whether there was an error or not.

getForwardPages

public java.util.Map getForwardPages()

Description copied from interface: ActionGroupIF

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

Specified by:

getForwardPages in interface ActionGroupIF

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object