com.ibm.commerce.command

Class AbstractRedirectViewCommand

java.lang.Object

com.ibm.commerce.command.AbstractECCommand

com.ibm.commerce.command.AbstractViewCommand

com.ibm.commerce.command.AbstractRedirectViewCommand

All Implemented Interfaces:

AccCommand, ECCommand, RedirectViewCommand, ViewCommand, Protectable, com.ibm.websphere.command.Command, java.io.Serializable

Direct Known Subclasses:

HttpRedirectViewCommandImpl, HttpsRedirectViewCommandImpl

public abstract class AbstractRedirectViewCommand
extends AbstractViewCommand
implements RedirectViewCommand

This class provides the abstract base implementation of all redirect view commands. All redirect view commands should extend from this class.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.command.ECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AbstractRedirectViewCommand() This is the default constructor for this class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocumentPathName() This method gets the path name of the document to be forwarded.
java.lang.String	getRedirectUrl() This method gets the EC_REDIRECTURL property from the request properties.
void	setViewStorePath(java.lang.Integer storePathId) This method sets the directory for the store path used to instantiate this view command.

Methods inherited from class com.ibm.commerce.command.AbstractViewCommand

fulfills, getForUserId, getOwner, getRequestProperties, getResourceOwners, getResponseProperties, getViewCommandContext, getViewName, mergeProperties, performExecute, setForUserId, setOwner, setRequestProperties, setViewCommandContext, setViewName

Methods inherited from class com.ibm.commerce.command.AbstractECCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, setForUserId, setUserId, validateParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.command.ViewCommand

getRequestProperties, getResponseProperties, getViewName, mergeProperties, setRequestProperties, setViewName

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Constructor Detail

AbstractRedirectViewCommand

public AbstractRedirectViewCommand()

This is the default constructor for this class. It calls the constructor from the superclass.

Method Detail

setViewStorePath

public void setViewStorePath(java.lang.Integer storePathId)

This method sets the directory for the store path used to instantiate this view command.

Parameters:

storePathId - This is the store path identifier.

getDocumentPathName

public java.lang.String getDocumentPathName()
                                     throws ECException

This method gets the path name of the document to be forwarded.

Specified by:

getDocumentPathName in interface RedirectViewCommand

Returns:

This method returns the name of the document path.

Throws:

ECException - This exception generates an _ERR_CMD_MISSING_PARAM or an _ERR_GENERIC error message.

getRedirectUrl

public java.lang.String getRedirectUrl()
                                throws ECException

This method gets the EC_REDIRECTURL property from the request properties. If none is found, it will try to get the EC_URL property instead. If none is found, it throws a ParameterNotFoundException. After the EC_REDIRECTURL or EC_URL has been retrieved, it will be removed from the properties list so that it won't be added as a parameter to the redirect url itself.

Specified by:

getRedirectUrl in interface RedirectViewCommand

Returns:

This method returns the redirect URL.

Throws:

ECException