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

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

public interface CSRReturnProcessCmd
extends ToolsControllerCommand

Brief Description:

	Process the return specified by <returnId>.
	This command is a wrapper for the ReturnProcessCmd command.  
	See the command class com.ibm.commerce.returns.commands.ReturnProcessCmd 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>
					<refundPolicyId>5678</refundPolicyId>
					<edit>false</edit>
				</XML>

			The mandatory data in the xml stream are the following:
				- returnId
				- customerId
				- refundPolicyId
	
	2) URL - The URL to redirect to if the command completes successfully.

Output parameters:

	None.
   
                             
Commands called:
   
	1) ReturnProcessCmd
    
Special behavior:  
 
	1) When the ReturnItemAddCmd command is called the forUserId paremeter is set in the request
	   properties to the value in the <customerId> xml tag.
	2) This command sets the INUSE column on the rma/return to 'N' to mark that the return is not being edited.
	   This is done here because this command should be the last command to be called when the return
	   is being worked on.


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