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

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

public interface CSRReturnItemAddCmd
extends ToolsControllerCommand

Wrapper for ReturnItemAddCmd.

Parameters:

XML
String, in XML format, which contains all the required data for one or more returns items. CustomerId, returnQuantity, and either orderItemId or itemId are required.
Example xml_string:
<?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>
URL
URL to be called when the command completes successfully.

Output parameters: returnId - Identifier of the the return to which items were added.

Exceptions: ECApplicationException - if ReturnItemAddCmd throws an exception

Special behavior: When the ReturnItemAddCmd command is called the forUserId paremeter is set in the request properties to the value in the <customerId> xml tag.

See Also:
ReturnItemAddCmd

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright notice field.
static java.lang.String defaultCommandClassName
          Default implementation class.
static java.lang.String NAME
          Interface name
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, 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, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
Interface name
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
Default implementation class.
See Also:
Constant Field Values