java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.payment.commands.DoRefundCmdImpl
Default
DoRefund
task command implementation.
This command handles the refund for the given order and Return Merchandise Authorization (RMA).
Parameters:
Parameter Name | Type | Descriptions |
abRMA | RMAAccessBean | The RMAAccessBean for the Return Merchandise Authorization (RMA) record |
abOrder | OrderAccessBean | The OrderAccessBean of the order associated with the RMA |
bdRefundAmount | BigDecimal | The amount of the refund in the currency specified in the RMA |
nReturnPolicyId | Long | The ID of the Return Business Policy |
Behavior:
UpdateTARefund
Task command to update the Refund records of
the Trading Agreement.
CreditAccount
command to debit the account through an external
Accounting System.RefundPaymentPolicy
specified by the nReturnPolicyId. (The
RefundPaymentPolicyCmd Command will in turn call the
DoRefundPolicy
Command with the appropriate Payment Policy
ID.)Error View Name:
ErrorCodes:
This command uses the following AccessBeans:
This command calls the following TaskCommands:
This command calls the following BusinessPolicyCommands:
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.payment.commands. DoRefundCmd |
COPYRIGHT,
defaultCommandClassName,
ERRTASK_NAME,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
DoRefundCmdImpl() |
Method Summary | |
---|---|
protected
OrderAccessBean |
getOrder() Returns the OrderAccessBean representing the Order. |
protected
java.lang.Long |
getPaymentPolicyId() Returns the ID of the Payment Business Policy used for the purchase. |
protected
java.math.BigDecimal |
getRefundAmount() Returns the amount to be refunded. |
protected
java.lang.Long |
getReturnPolicyId() Returns the ID of the Return Business Policy. |
protected
RMAAccessBean |
getRMA() Returns the RMA AccessBean representing the Return Merchandise Authorization record that authorizes the return of the merchandise. |
boolean |
isReadyToCallExecute() This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. |
void |
performExecute() Performs the main business logic of the command. |
void |
reset() Resets the instance variables of the command. |
void |
setOrder(
OrderAccessBean ab) Sets the order property of the command. |
protected
void |
setPaymentPolicyId(java.lang.Long nPaymentPolicyId) Sets the paymentPolicyId property of the command. |
void |
setRefundAmount(java.math.BigDecimal refundAmount) Sets the refundAmount property of the command. |
void |
setReturnPolicyId(java.lang.Long nReturnPolicyId) Sets the returnPolicyId property of the command. |
void |
setRMA(
RMAAccessBean ab) Sets the Return Merchandise Authorization record that authorizes the return of the merchandise. |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Constructor Detail |
---|
public DoRefundCmdImpl()
Method Detail |
---|
protected OrderAccessBean getOrder()
protected java.lang.Long getPaymentPolicyId()
protected java.math.BigDecimal getRefundAmount()
protected java.lang.Long getReturnPolicyId()
protected RMAAccessBean getRMA()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
public void setOrder(OrderAccessBean ab)
setOrder
in interface
DoRefundCmd
ab
- the OrderAccessBean of the order associated with the
Return Merchandise Authorization.protected void setPaymentPolicyId(java.lang.Long nPaymentPolicyId)
nPaymentPolicyId
- the Payment Policy ID for this
refundpublic void setRefundAmount(java.math.BigDecimal refundAmount)
setRefundAmount
in interface
DoRefundCmd
refundAmount
- the amount to be refunded in the currency
specified in in the Return Merchandise Authorizationpublic void setReturnPolicyId(java.lang.Long nReturnPolicyId)
setReturnPolicyId
in interface
DoRefundCmd
nReturnPolicyId
- the Return Policy ID for this
refundpublic void setRMA(RMAAccessBean ab)
setRMA
in interface
DoRefundCmd
ab
- the RMAAccessBean for the Return Merchandise
Authorization record