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

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

public class CSRReturnItemDeleteCmdImpl
extends CSRReturnBaseCmdImpl
implements CSRReturnItemDeleteCmd

	Deletes one or more  return items.
	This command is a wrapper for the ReturnItemDeleteCmd command.  
	See the command class com.ibm.commerce.returns.commands.ReturnItemDeleteCmd for more detailed information
	on the behavior.


Field Summary
static java.lang.String COPYRIGHT
           
protected  java.util.Vector returnItemsToBeDeleted
          Vector containing Strings.
 
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 accessed by this command.
 java.util.Vector getReturnItemsToBeDeleted()
          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 ReturnItemDeleteCmd command.
 void setReturnItemsToBeDeleted(java.util.Vector newReturnItemsToBeDeleted)
          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

returnItemsToBeDeleted

protected java.util.Vector returnItemsToBeDeleted
Vector containing Strings. Each String represents a return item id that will be deleted.
Constructor Detail

CSRReturnItemDeleteCmdImpl

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

getReturnItemsToBeDeleted

public java.util.Vector getReturnItemsToBeDeleted()
Getter method
Returns:
Vector of Strings representing return item id's.

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
   - setReturnItemsToBeDeleted
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 ReturnItemDeleteCmd command. Calls the ReturnItemDeleteCmd. 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 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)
Setter method
Parameters:
newReturnItemsToBeDeleted - Vector of Strings containing the return item id's