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

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

public class CSRReturnItemUpdateCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnItemUpdateCmd

Default implementation of CSRReturnItemUpdateCmd. Wrapper for implementation of ReturnItemUpdateCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.util.Vector returnItemsToBeUpdated
          List of items to be updated on 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. CSRReturnItemUpdateCmd
defaultCommandClassName, NAME
 
Constructor Summary
CSRReturnItemUpdateCmdImpl()
           
 
Method Summary
  AccessVector getResources()
          Gets the access vector used by command.
 java.util.Vector getReturnItemsToBeUpdated()
          Gets list of items to be updated on a 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 ReturnItemUpdateCmd command and calls the command.
 void setReturnItemsToBeUpdated(java.util.Vector newReturnItemsToBeUpdated)
          Sets list of items to be updated on a 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

returnItemsToBeUpdated

protected java.util.Vector returnItemsToBeUpdated
List of items to be updated on a Return. Vector containing Hashtables, with each hashtable representing a return item.
Constructor Detail

CSRReturnItemUpdateCmdImpl

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

getReturnItemsToBeUpdated

public java.util.Vector getReturnItemsToBeUpdated()
Gets list of items to be updated on a Return.
Returns:
set of hashtables where each hashtable represents data for a return item that will be passed to the ReturnItemUpdateCmd.

parseInputXMLObject

protected void parseInputXMLObject(java.util.Hashtable xmlRoot)
                            throws ECApplicationException
Extracts and stores data passed in the XML parameter. Calls setCustomerId with customerId, and setReturnItemsToBeUpdated with data in the returnItem 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 ReturnItemUpdateCmd 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 ReturnItemUpdateCmd command throws an exception. If a general exception occurs while parsing and validating the input params.

setReturnItemsToBeUpdated

public void setReturnItemsToBeUpdated(java.util.Vector newReturnItemsToBeUpdated)
Sets list of items to be updated on a Return.