com.ibm.commerce.giftregistry.giftconsultant.struts

Class GiftRegistryForwardInstance

java.lang.Object

org.apache.struts.config.ForwardConfig

org.apache.struts.action.ActionForward

com.ibm.commerce.struts.ECActionForwardInstance

com.ibm.commerce.giftregistry.giftconsultant.struts.GiftRegistryForwardInstance

All Implemented Interfaces:

java.io.Serializable

public class GiftRegistryForwardInstance
extends com.ibm.commerce.struts.ECActionForwardInstance

GiftRegistryForwardInstance extends from ECActionForwardInstance, and is an instance of ECActionForward.
This instance is used to manage the gift consultant session before forwarding. It checks whether the layoutMode=GiftConsultant parameter is present in the session. If it is not, it adds this parameter to the session to indicate that this is a GiftConsultant session. In the store, the JSTLEnvironmentSetup.jspf will check for this session parameter and change the page format. Then, the store can use the GiftConsultant header, footer and no sidebar. To force this GiftRegistryForwardInstance to clear the GiftConsultant session, user can register the command with parameter gcViewAction=clearLayout.
The second task of this GiftRegistryForwardInstance is to keep track of the last accessed gift registry. Views that manage the registry should pass a gcViewAction=manageRegistry. The registry will be saved in the gift registry session context. The externalId parameter is saved into the session context.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GiftRegistryForwardInstance(ActivityToken token, org.apache.struts.action.ActionForward config, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, TypedProperty prop, boolean secure, boolean useStoreDir) Constructors for GiftRegistryForwardInstance.

Method Summary

Methods inherited from class com.ibm.commerce.struts.ECActionForwardInstance

getForward, getPath, isCommandContextRequired, toString

Methods inherited from class org.apache.struts.config.ForwardConfig

freeze, getContextRelative, getModule, getName, getRedirect, setContextRelative, setModule, setName, setPath, setRedirect

Methods inherited from class java.lang.Object

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

Constructor Detail

GiftRegistryForwardInstance

public GiftRegistryForwardInstance(ActivityToken token,
                                   org.apache.struts.action.ActionForward config,
                                   javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse resp,
                                   TypedProperty prop,
                                   boolean secure,
                                   boolean useStoreDir)
                            throws java.lang.Exception

Constructors for GiftRegistryForwardInstance.

Parameters:

token - The activity token

forward - ActionForward class

req - HTTP request

resp - HTTP response

prop - request property to be passed to the JSP file

secure - True to indicates a secure action

isStore - Indicates whether this is a store command

Throws:

java.lang.Exception