com.ibm.commerce.tools.optools.returns.commands
Class CSRReturnPrepareCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
|
+--com.ibm.commerce.tools.optools.order.commands.CSRBaseControllerCommandImpl
|
+--com.ibm.commerce.tools.optools.returns.commands.CSRReturnBaseCmdImpl
|
+--com.ibm.commerce.tools.optools.returns.commands.CSRReturnPrepareCmdImpl
- All Implemented Interfaces:
- AccCommand, ControllerCommand, CSRReturnPrepareCmd, ECCommand, ECTargetableCommand, Protectable, ToolsControllerCommand
- public class CSRReturnPrepareCmdImpl
- extends CSRReturnBaseCmdImpl
- implements CSRReturnPrepareCmd
Prepares the return specified by <returnId>.
This command is a wrapper for the ReturnPrepareCmd command.
See the command class com.ibm.commerce.returns.commands.ReturnPrepareCmd for more detailed information
on the behavior.
Method Summary |
AccessVector |
getResources()
Gets the access vector accessed by this command. |
java.lang.String |
getReturnComment()
Getter method |
protected void |
parseInputXMLObject(java.util.Hashtable xmlRoot)
Parses the input xml data stream, retrieves the parameters and stores them in the objects variables. |
void |
performExecute()
Copies the command context and request properties in preparation of calling the ReturnPrepareCmd command. |
void |
setReturnComment(java.lang.String newReturnComment)
Setter method. |
Methods inherited from class com.ibm.commerce.tools.optools.returns.commands.CSRReturnBaseCmdImpl |
exceptionUtil, getCustomerId, getNLS, getOrigCmdContext, getOrigReqProperties, getRedirectURL, getReturnId, setCustomerId, setNLS, setOrigCmdContext, setOrigReqProperties, setRedirectURL, setReturnId, traceFormat, validateParameters |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
returnComment
protected java.lang.String returnComment
CSRReturnPrepareCmdImpl
public CSRReturnPrepareCmdImpl()
getResources
public AccessVector getResources()
throws ECException
- Gets the access vector accessed by this command.
The default implementation returns null indicating that no protectable resource is
accessed by this command.
- Specified by:
getResources
in interface ECCommand
- Overrides:
getResources
in class CSRReturnBaseCmdImpl
- Returns:
- AccessVector of resource action pairs
getReturnComment
public java.lang.String getReturnComment()
- Getter method
- Returns:
- The return comment.
parseInputXMLObject
protected void parseInputXMLObject(java.util.Hashtable xmlRoot)
throws ECApplicationException
Parses the input xml data stream, retrieves the parameters and stores them in the objects variables.
The following setter methods are called:
- setReturnId
- setCustomerId
- setReturnComment
- Overrides:
parseInputXMLObject
in class CSRReturnBaseCmdImpl
- Parameters:
xmlRoot
- Representation of the xml data stream as a java Hashtable- Throws:
ECApplicationException
- If customerId is null or empty.
If returnId is null or empty
performExecute
public void performExecute()
throws ECException
- Copies the command context and request properties in preparation of calling the ReturnPrepareCmd command.
Calls the ReturnPrepareCmd.
Set up the redirect url by putting the redirect url parameter into the response property
- Specified by:
performExecute
in interface ECCommand
- Overrides:
performExecute
in class AbstractECTargetableCommand
- Throws:
ECApplicationException
- If ReturnPrepareCmd command throws an exception.
If a general exception occurs while parsing and validating the input params.
setReturnComment
public void setReturnComment(java.lang.String newReturnComment)
- Setter method.
- Parameters:
newReturnComment
- The return comment.