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

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, Protectable, ToolsControllerCommand

public class CSRReturnItemUpdateCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnItemUpdateCmd

	Updates one or more return items in a return.  
	This command is a wrapper for ReturnItemUpdateCmd command.  
	See the command class com.ibm.commerce.returns.commands.ReturnItemUpdateCmd for more detail 
	information of the behavior.


Field Summary
static java.lang.String COPYRIGHT
           
protected  java.util.Vector returnItemsToBeUpdated
          Vector containing Hashtables.
 
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 accessed by this command.
 java.util.Vector getReturnItemsToBeUpdated()
          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 ReturnItemUpdateCmd command.
 void setReturnItemsToBeUpdated(java.util.Vector newReturnItemsToBeUpdated)
          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.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
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.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

returnItemsToBeUpdated

protected java.util.Vector returnItemsToBeUpdated
Vector containing Hashtables. Each Hashtable represents a return item that will be updated.
Constructor Detail

CSRReturnItemUpdateCmdImpl

public CSRReturnItemUpdateCmdImpl()
Method Detail

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

getReturnItemsToBeUpdated

public java.util.Vector getReturnItemsToBeUpdated()
Getter method
Returns:
Vector 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
 Parses the input xml data stream,  retrieves the parameters and stores them in the objects variables.
 The following setter methods are called:  
   - setCustomerId
   - setReturnItemsToBeUpdated
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

performExecute

public void performExecute()
                    throws ECException
Copies the command context and request properties in preparation of calling the ReturnItemUpdateCmd command. Calls the ReturnItemUpdateCmd. 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 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)
Setter method
Parameters:
newReturnItemsToBeAdded - Vector of hashtables where each hashtable represents data for a return item that will be passed to the ReturnItemUpdateCmd.