com.ibm.commerce.returns.commands
Interface ReturnItemUpdateCmd

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

public interface ReturnItemUpdateCmd
extends ControllerCommand

Interface for command used to update information about a return mechandise authorization (RMA) item.

Controller command URL calling syntax

https://host_name/path/ReturnItemAddCmd?RMAIdItem_i=RMAItemId_value&URL=redirect_url&quantity_t=quantity_value&UOM_i=UOM_value&commment_i=comment_value&reason_i&outRMANname=outRMANname_value&creditAdjustment_i=creditAdjustment_value&recieve_i=receive_value&forUserId=forUserId_value

Parameters

RMAItemId_i(required)
all RMA items must be in the same RMA or an exception will be raised
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.
receive_i (optional and only valid i forUserId is set)
whether the return item components are supposed to be received.
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.ReturnItemUpdateCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.returns.commands.ReturnItemUpdateCmd".
 
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.ReturnItemUpdateCmd".

defaultCommandClassName

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