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

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

public interface CSRReturnItemComponentUpdateCmd
extends ToolsControllerCommand

Brief Description:

	Updates one or more return item components in a return.  
	This command is a wrapper for ReturnItemComponentUpdateCmd command.  
	See the command class com.ibm.commerce.returns.commands.ReturnItemComponentUpdateCmd for more detailed
	information of 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>
					<customerId>1234</customerId>
					<returnItemComponent>
						<returnItemComponentId>10051</returnItemComponentId> 
						<returnToWarehouse>yes</returnToWarehouse>
					</returnItemComponent>
					<returnItemComponent>
						...
					</returnItemComponent>
				</XML>	

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

Output parameters:
	None.
      
Exceptions:
	ECApplicationException - if ReturnItemComponentUpdateCmd throws an exception
                               
Commands called:
   
	1) ReturnItemUpdateComponentCmd
    
Special behavior:  
 
	1) When the ReturnItemComponentUpdateCmd 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