com.ibm.commerce.payment.commands
Class DoRefundCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.DoRefundCmdImpl
All Implemented Interfaces:
DoRefundCmd, ECCommand, ECTargetableCommand, TaskCommand

public class DoRefundCmdImpl
extends TaskCommandImpl
implements DoRefundCmd

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:

Error View Name:

ErrorCodes:

This command uses the following AccessBeans:

This command calls the following TaskCommands:

This command calls the following BusinessPolicyCommands:

See Also:
Serialized Form

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

DoRefundCmdImpl

public DoRefundCmdImpl()
Method Detail

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the Order. This is the OrderAccessBean passed in to the command.
Returns:
the OrderAccessBean

getPaymentPolicyId

protected java.lang.Long getPaymentPolicyId()
Returns the ID of the Payment Business Policy used for the purchase.
Returns:
the Payment Policy ID

getRefundAmount

protected java.math.BigDecimal getRefundAmount()
Returns the amount to be refunded.
Returns:
the refund amount

getReturnPolicyId

protected java.lang.Long getReturnPolicyId()
Returns the ID of the Return Business Policy.
Returns:
the Return Policy ID

getRMA

protected RMAAccessBean getRMA()
Returns the RMA AccessBean representing the Return Merchandise Authorization record that authorizes the return of the merchandise.
Returns:
the RMAAccessBean

isReadyToCallExecute

public boolean isReadyToCallExecute()
This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
Overrides:
isReadyToCallExecute in class AbstractECTargetableCommand
Returns:
true if we can execute the command; false otherwise.

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException

reset

public void reset()
Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters, then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

This is useful if the command instance is to be called multiple times with different command parameters.

Overrides:
reset in class AbstractECTargetableCommand

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface DoRefundCmd
Parameters:
ab - the OrderAccessBean of the order associated with the Return Merchandise Authorization.

setPaymentPolicyId

protected void setPaymentPolicyId(java.lang.Long nPaymentPolicyId)
Sets the paymentPolicyId property of the command.
Parameters:
nPaymentPolicyId - the Payment Policy ID for this refund

setRefundAmount

public void setRefundAmount(java.math.BigDecimal refundAmount)
Sets the refundAmount property of the command.
Specified by:
setRefundAmount in interface DoRefundCmd
Parameters:
refundAmount - the amount to be refunded in the currency specified in in the Return Merchandise Authorization

setReturnPolicyId

public void setReturnPolicyId(java.lang.Long nReturnPolicyId)
Sets the returnPolicyId property of the command.
Specified by:
setReturnPolicyId in interface DoRefundCmd
Parameters:
nReturnPolicyId - the Return Policy ID for this refund

setRMA

public void setRMA(RMAAccessBean ab)
Sets the Return Merchandise Authorization record that authorizes the return of the merchandise.
Specified by:
setRMA in interface DoRefundCmd
Parameters:
ab - the RMAAccessBean for the Return Merchandise Authorization record