AbstractForwardViewCommand

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- com.ibm.commerce.command.AbstractECCommand
- - com.ibm.commerce.command.AbstractViewCommand
  - - com.ibm.commerce.command.AbstractForwardViewCommand

All Implemented Interfaces:

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

Direct Known Subclasses:

HttpForwardViewCommandImpl
```
public abstract class AbstractForwardViewCommand
extends AbstractViewCommand
implements ForwardViewCommand
```
This class provides the abstract base implementation of a forward view command.

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

AbstractForwardViewCommand()
This is the default constructor of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDocumentPathName()` This method gets the path name of the document to be forwarded.
`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 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
  - AbstractForwardViewCommand
```
public AbstractForwardViewCommand()
```
    This is the default constructor of 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 ForwardViewCommand
    
    Returns:
    
    This method returns the name of the document path.
    
    Throws:
    
    ECException - This exception generates either a _ERR_CMD_MISSING_PARAM or a _ERR_GENERIC error message when thrown.