RedirectViewCommandImpl

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.RedirectViewCommandImpl

All Implemented Interfaces:

AccCommand, ECCommand, RedirectViewCommand, ViewCommand, Protectable, com.ibm.websphere.command.Command, java.io.Serializable
```
public abstract class RedirectViewCommandImpl
extends AbstractViewCommand
implements RedirectViewCommand
```
This class is the abstract base implementation of all redirect view commands.

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

RedirectViewCommandImpl()
This is the constructor for 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.
`java.lang.String`	`getRedirectUrl()` This method gets the `EC_REDIRECTURL` property from the request properties.

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
  - RedirectViewCommandImpl
```
public RedirectViewCommandImpl()
```
    This is the constructor for this class. It calls the constructor from the superclass.
- Method Detail
  - 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:
    
    The path name of the document.
    
    Throws:
    
    ECException - Generates 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 tries to get the EC_URL property instead. If none is found, it throws a parameter not found exception. 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:
    
    The redirect URL.
    
    Throws:
    
    ECException - Generates an _ERR_MISSING_CMD_PARAMETERS error message.