com.ibm.commerce.tools.optools.returns.commands
Interface CSRReturnItemAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
CSRReturnItemAddCmdImpl

public interface CSRReturnItemAddCmd
extends ToolsControllerCommand

Brief Description:

	Adds one or more return items to a return.  A return item could be a order item or a catalog entry.
	If a return does not exist then one will be created.
	This command is a wrapper for the ReturnItemAddCmd command.  
	See the command class com.ibm.commerce.returns.commands.ReturnItemAddCmd for more detailed information
	on the behavior.
  
Input parameters:

	1) XML - An xml input stream representing a list of return items to add to a return.

		The following is a sample value for the XML parameter.
			<?xml version="1.0" encoding "UTF-8">
			<XML>
				<returnId>1001</returnId>
				<customerId>1234</customerId>
				<addReturnItem>
					<orderItemId>10051</orderItemId>
					<itemId></itemId>
					<returnQuantity>1</returnQuantity>
				</addReturnItem>
				<addReturnItem>
					...
				</addReturnItem>
			</XML>
	
		The mandatory data in the xml stream are the following:
			- customerId
			- returnQuantity
			- one of <orderItemId> or <itemId> (it is an exclusive or relationship)
	
	2) URL - The URL to redirect to if the command completes successfully.

Output parameters:

	The following parameters are put into the response property
		returnId - The return id representing the return the return items were added to.
   
Exceptions:
	ECApplicationException - if ReturnItemAddCmd throws an exception
                               
Commands called:
   
	1) ReturnItemAddCmd
    
Special behavior:  
 
	1) If <returnId> is empty or does not exist then a new return will be created.
   
	2) When the ReturnItemAddCmd command is called the forUserId paremeter is set in the request
	   properties to the value in the <customerId> xml tag.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String NAME
          Interface name
 
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, getResources, getStoreId, getUser, getUserId, performExecute, 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

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.

NAME

public static final java.lang.String NAME
Interface name