com.ibm.commerce.payment.commands
Interface UpdateTARefundCmd
- All Superinterfaces:
- ECCommand, TaskCommand
- All Known Implementing Classes:
- UpdateTARefundRecordsCmdImpl
- public interface UpdateTARefundCmd
- extends TaskCommand
Update Trading Agreement's Refund amount for the given order and rma.
Parameter:
Parameter Name |
Type |
Descriptions |
tradingId |
Long |
The ID of the Trading Agreement |
RMA |
RMAAccessBean |
The RMA Access Bean |
order |
OrderAccessBean |
The Order Access Bean |
refundAmount |
BigDecimal |
The Refund Amount in the Currency of the RMA. |
Assumption:
- All return items within an RMA is against the same Trading Agreement.
Behavior:
- The default implementation inserts a row into the TRDREFAMT table for this
Trading ID and RMA ID ONLY if this Trading Agreement has a RightToBuy TC
by Amount or ObligationToBuy TC by Amount or both.
- Refunds may be made using a currency that is different from the currency
specified for the RightToBuy TC by Amount or ObligationToBuy TC by Amount.
(However, the two TCs must have the same currency if both exist within the
same Trading Agreement.)
- The default implementation converts the Refund Amount to the currency
specified for the RightToBuy TC or ObligationToBuy TC and stores the converted
amount in the TRDREFAMT Table. The command throws an ECApplicationException if
Currency conversion is not available or if the conversion failed.
Error View Name:
ErrorCodes:
Method Summary |
void |
setOrder(OrderAccessBean abOrder)
Sets the order associated with the Return Merchandise Authorization (RMA) record. |
void |
setRefundAmount(java.math.BigDecimal refundAmount)
Sets the refundAmount property of the command. |
void |
setRMA(RMAAccessBean ab)
Sets the RMA AccessBean representing the Return Merchandise Authorization record that authorizes
the return of the merchandise. |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
defaultCommandClassName
public static final java.lang.String defaultCommandClassName
- The default implementation class.
ERRTASK_NAME
public static final java.lang.String ERRTASK_NAME
- Name of the Error View for this command.
The constant value of this field is "UpdateTARefundErrorView".
NAME
public static final java.lang.String NAME
setOrder
public void setOrder(OrderAccessBean abOrder)
- Sets the order associated with the Return Merchandise Authorization (RMA) record.
setRefundAmount
public void setRefundAmount(java.math.BigDecimal refundAmount)
- Sets the refundAmount property of the command.
- Parameters:
refundAmount
- the amount to be refunded.
setRMA
public void setRMA(RMAAccessBean ab)
- Sets the RMA AccessBean representing the Return Merchandise Authorization record that authorizes
the return of the merchandise.