com.ibm.commerce.command
Class AbstractForwardViewCommand

java.lang.Object
  com.ibm.commerce.command.AbstractECCommand
      com.ibm.commerce.command.AbstractViewCommand
          com.ibm.commerce.command.AbstractForwardViewCommand
All Implemented Interfaces:
AccCommand, ECCommand, ForwardViewCommand, Protectable, ViewCommand
Direct Known Subclasses:
HttpForwardViewCommandImpl

public abstract class AbstractForwardViewCommand
extends AbstractViewCommand
implements ForwardViewCommand

This class provides the abstract base implementation of a forward view command.


Field Summary
Fields inherited from class com.ibm.commerce.command.AbstractViewCommand
requestProperties, responseProperties
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
Constructor Summary
AbstractForwardViewCommand()
AbstractForwardViewCommand constructor.
Method Summary
java.lang.String getDocumentPathName()
Gets the path name of the document to be forwarded.
void setViewStorePath(java.lang.Integer storePathId)
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, getViewName, mergeProperties, performExecute, setForUserId, setOwner, setRequestProperties, setResponseProperties, setViewName
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
Methods inherited from class java.lang.Object
clone, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

Constructor Detail

AbstractForwardViewCommand

public AbstractForwardViewCommand()
AbstractForwardViewCommand constructor.
Method Detail

setViewStorePath

public void setViewStorePath(java.lang.Integer storePathId)
Sets the directory for the store path used to instantiate this view command.
Parameters:
storePathId - store path identifier

getDocumentPathName

public java.lang.String getDocumentPathName()
                                     throws ECException
Gets the path name of the document to be forwarded.
Specified by:
getDocumentPathName in interface ForwardViewCommand
Returns:
name of document path
Throws:
ECException - - generates _ERR_CMD_MISSING_PARAM or _ERR_GENERIC error message

Feedback