com.ibm.commerce.payment.commands
Class DoRefundCmdImpl

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

public class DoRefundCmdImpl
extends TaskCommandImpl
implements DoRefundCmd

Default DoRefund task command implementation.

Parameter:
Parameter Name Type Descriptions
abRMA RMAAccessBean The RMA Access Bean
abOrder OrderAccessBean The Order Access Bean
bdRefundAmount BigDecimal The amount of the refund
nReturnPolicyId Long The ID of the Return Policy

Behavior:

Error View Name: ErrorCodes:


Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoRefundCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoRefundCmdImpl()
           
 
Method Summary
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the Order.
protected  java.lang.Long getPaymentPolicyId()
          Returns the Payment Policy ID
protected  java.math.BigDecimal getRefundAmount()
          Returns the Refund Amount
protected  java.lang.Long getReturnPolicyId()
          Returns the Return Policy ID
protected  RMAAccessBean getRMA()
          Returns the RMA AccessBean
 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 RMA AccessBean representing the Return Merchandise Authorization record.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

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.

getPaymentPolicyId

protected java.lang.Long getPaymentPolicyId()
Returns the Payment Policy ID

getRefundAmount

protected java.math.BigDecimal getRefundAmount()
Returns the Refund Amount

getReturnPolicyId

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

getRMA

protected RMAAccessBean getRMA()
Returns the RMA AccessBean

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 AbstractECCommand
Following copied from class: com.ibm.commerce.command.AbstractECCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

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 AbstractECCommand

setOrder

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

setPaymentPolicyId

protected void setPaymentPolicyId(java.lang.Long nPaymentPolicyId)
Sets the paymentPolicyId property of the command.
Parameters:
inPaymentPolicyId - 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.

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 RMA AccessBean representing the Return Merchandise Authorization record.
Specified by:
setRMA in interface DoRefundCmd