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

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.CSRReturnCancelCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, CSRReturnCancelCmd, ECCommand, ECTargetableCommand, ToolsControllerCommand

public class CSRReturnCancelCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnCancelCmd

Default implementation of CSRReturnCancelCmd. Wrapper for implementation of ReturnCancelCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
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. CSRReturnCancelCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSRReturnCancelCmdImpl()
          Constructor.
 
Method Summary
protected  TypedProperty exceptionUtil( TypedProperty prop, java.lang.Exception ex, java.lang.String methodName, java.lang.String cmdName)
          Utility for performing tasks prior to throwing exception.
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 ReturnCancelCmd command and calls the command.
 
Methods inherited from class com.ibm.commerce.tools.optools.returns.commands. CSRReturnBaseCmdImpl
getCustomerId, getNLS, getOrigCmdContext, getOrigReqProperties, getRedirectURL, getResources, 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, getResources, 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
Constructor Detail

CSRReturnCancelCmdImpl

public CSRReturnCancelCmdImpl()
Constructor.
Method Detail

exceptionUtil

protected TypedProperty exceptionUtil(TypedProperty prop,
                                      java.lang.Exception ex,
                                      java.lang.String methodName,
                                      java.lang.String cmdName)
Utility for performing tasks prior to throwing exception. Calls ancestor method. Adds redirect URL to specified typed property.
Overrides:
exceptionUtil in class CSRReturnBaseCmdImpl
Parameters:
prop - existing typed properties object to which to add properties
ex - exception about to be thrown
methodName - name of method in which exception occurred
cmdName - name of command in which exception occurred

parseInputXMLObject

protected void parseInputXMLObject(java.util.Hashtable xmlRoot)
                            throws ECApplicationException
Extracts and stores data passed in the XML parameter. Calls setReturnId with returnId, and setCustomerId with customerId.
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 ReturnCancelCmd 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 cancelled