com.ibm.commerce.tools.optools.returns.commands
Class CSRReturnPrepareCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--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, ToolsControllerCommand

public class CSRReturnPrepareCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnPrepareCmd

Default implementation of CSRReturnPrepareCmd. Wrapper for implementation of ReturnPrepareCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.lang.String returnComment
          Comment applicable to whole return.
 
Fields inherited from class com.ibm.commerce.tools.optools.returns.commands. CSRReturnBaseCmdImpl
customerId, ERRTASK_NAME, origCmdContext, origReqProperties, redirectURL, returnId, returnResBun, xmlRoot
 
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl
requestProperties, responseProperties, retriable, viewReqProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.tools.optools.returns.commands. CSRReturnPrepareCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSRReturnPrepareCmdImpl()
           
 
Method Summary
  AccessVector getResources()
          Gets the access vector used by command.
 java.lang.String getReturnComment()
          Gets the comment applicable to the entire return.
protected  void parseInputXMLObject(java.util.Hashtable xmlRoot)
          Extracts and stores data passed in the XML parameter.
 void performExecute()
          Sets up the input request property for the ReturnPrepareCmd command and calls the command.
 void setReturnComment(java.lang.String newReturnComment)
          Sets the comment applicable to the entire return.
 
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.tools.optools.order.commands. CSRBaseControllerCommandImpl
callPreCommands, findCmdInterfaceName, getIfExePreCmdChains, getPreCmdChain, setIfExePreCmdChains, setPreCmdChain
 
Methods inherited from class com.ibm.commerce.tools.command. ToolsControllerCommandImpl
getViewInputProperties, setRequestProperties
 
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
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. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
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, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

returnComment

protected java.lang.String returnComment
Comment applicable to whole return.
Constructor Detail

CSRReturnPrepareCmdImpl

public CSRReturnPrepareCmdImpl()
Method Detail

getResources

public AccessVector getResources()
                          throws ECException
Gets the access vector used by command. There are no protected resources.
Specified by:
getResources in interface ECCommand
Overrides:
getResources in class CSRReturnBaseCmdImpl
Returns:
vector of resource action pairs
Throws:
ECException
See Also:
AccessVector

getReturnComment

public java.lang.String getReturnComment()
Gets the comment applicable to the entire return.
Returns:
return comment

parseInputXMLObject

protected void parseInputXMLObject(java.util.Hashtable xmlRoot)
                            throws ECApplicationException
Extracts and stores data passed in the XML parameter. Calls setReturnId with returnId, setCustomerId with customerId, and setReturnComment with refundComment.
Specified by:
parseInputXMLObject in class CSRReturnBaseCmdImpl
Parameters:
xmlRoot - Representation of the xml data stream as a java Hashtable
Throws:
ECApplicationException - If returnId is null or empty. If customerId is null or empty.

performExecute

public void performExecute()
                    throws ECException
Sets up the input request property for the ReturnPrepareCmd command and calls the command. Sets 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:
ECException - If return is not successfully prepared

setReturnComment

public void setReturnComment(java.lang.String newReturnComment)
Sets the comment applicable to the entire return.
Parameters:
newReturnComment - return comment