com.ibm.commerce.returns.commands
Interface ReturnItemAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
ReturnItemAddCmdImpl, ReturnItemBaseCmdImpl

public interface ReturnItemAddCmd
extends ControllerCommand

Interface for command used to add an item to a return mechandise authorization (RMA).

Controller command URL calling syntax

https://host_name/path/ReturnItemAddCmd?RMAId=RMAId_value&URL=redirect_url&orderId_i=orderId_value&catEntryId_i=catEntryId_value&attrName_i=attrName_value&attrValue_i=attrValue_value&quantity_t=quantity_value&UOM_i=UOM_value&commment_i=comment_value&reason_i&outRMANname=outRMANname_value&creditAdjustment_i=creditAdjustment_value&forUserId=forUserId_value

Parameters

orderItemId_i(optional)
order item id, if not specified must specify a catEntryId
catEntryId_i (optional)
catalog entry being returned if order item is not provided. This must be a product or an item
attrName_i (optional)
(only if catEntry_id is specified) any distinct attribute defined for the product
attrValue_i (optional)
(only if catEntry_id is specified) the value of the attribute
RMAId
RMA ID or '**' to create one. If this is not specified, '**' is assumed.
quantity_i (optional)
quantity being returned (in CATENTRY units)
UOM_i(optional)
UOM for the quantity quantity being returned (in CATENTRY units)
comment_i (optional)
comment for item being returned
reason_i (optional)
purchaser provided reason for return (CODE column of the RTNREASON table with reasontype in ('B', 'C'))
outRMAName (optional)
the name to use for the name-value pair which will be passed to the redirected URL. This parameter is useful for chaining commands. If this parameter is not specified then "RMAId" will be used as the name portion of the RMA id name-value pair passed to the redirected URL.
URL (mandatory)
the URL to be called when the command completes successfully.
creditAdjustment_i (optional and only valid if forUserId is set)
the amount to adjust the product credit amount by. The format of this number must fit the rules for a java.math.BigDecimal object. The number must use a period for the decimal place. This amount will override any amount calculated by the CalculateReturnItemAdjustment task command.
forUserId (when called by a CSR)
userid of the customer

Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class name is "com.ibm.commerce.returns.commands.ReturnItemAddCmdImpl" .
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.returns.commands.ReturnItemAddCmd".
 
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
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.returns.commands.ReturnItemAddCmd".

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name is "com.ibm.commerce.returns.commands.ReturnItemAddCmdImpl" .
See Also:
Constant Field Values