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

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

public class CSRReturnItemDeleteCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnItemDeleteCmd

Default implementation of CSRReturnItemDeleteCmd. Wrapper for implementation of ReturnItemDeleteCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.util.Vector returnItemsToBeDeleted
          List of items to be removed from a 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. CSRReturnItemDeleteCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSRReturnItemDeleteCmdImpl()
           
 
Method Summary
  AccessVector getResources()
          Gets the access vector used by command.
 java.util.Vector getReturnItemsToBeDeleted()
          Gets list of items to be removed from the 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 ReturnItemDeleteCmd command and calls the command.
 void setReturnItemsToBeDeleted(java.util.Vector newReturnItemsToBeDeleted)
          Sets list of items to be removed from 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

returnItemsToBeDeleted

protected java.util.Vector returnItemsToBeDeleted
List of items to be removed from a Return. Vector containing Hashtables, with each hashtable representing a return item.
Constructor Detail

CSRReturnItemDeleteCmdImpl

public CSRReturnItemDeleteCmdImpl()
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

getReturnItemsToBeDeleted

public java.util.Vector getReturnItemsToBeDeleted()
Gets list of items to be removed from the Return.
Returns:
set of hashtables where each hashtable represents data for a return item that will be passed to the ReturnItemDeleteCmd.

parseInputXMLObject

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

performExecute

public void performExecute()
                    throws ECException
Sets up the input request property for the ReturnItemDeleteCmd 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 ReturnItemDeleteCmd command throws an exception. If a general exception occurs while parsing and validating the input params.

setReturnItemsToBeDeleted

public void setReturnItemsToBeDeleted(java.util.Vector newReturnItemsToBeDeleted)
Sets list of items to be removed from Return.
Parameters:
newReturnItemsToBeDeleted - vector of hashtables where each hashtable represents data for a return item that will be passed to the ReturnItemDeleteCmd.