com.ibm.commerce.payment.commands
Class DoRefundTestCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.DoRefundTestCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, DoRefundPolicyCmd, ECCommand, TaskCommand

public class DoRefundTestCmdImpl
extends BusinessPolicyCommandImpl
implements DoRefundPolicyCmd

The DoRefundPolicyCmd implementation class for the TestPaymentMethod policy. This sample command creates a row in the OrdPayMthd Table to represent the Refund due to the customer.


Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoRefundPolicyCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoRefundTestCmdImpl()
          DoRefundTestCmdImpl default constructor.
 
Method Summary
protected  void checkCurrencyAndGetChargeAmount()
          Checks the currency of the Order and the Store default currency.
protected  AccountAccessBean getAccount()
          This method will first check if the local variable is set or not.
protected  java.lang.Long getAccountId()
          Retrieve Account Reference Number
protected  java.math.BigDecimal getChargeAmount()
          Returned Charge Amount
protected  java.lang.String getChargeAmountCurrency()
          Returns the currency of the Charge Amount.
protected  java.lang.String getErrorViewName()
          Retrieve the error view name passed in by the Caller.
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the Order.
protected  java.math.BigDecimal getRefundAmount()
           
protected  RMAAccessBean getRMA()
          Retrieve RMA
 void performExecute()
          Performs the main business logic of the command.
 void reset()
          This method is called after a command has been executed to reset its states variables.
protected  void retrieveActiveAccountIdFromOrder()
          This is called by performExecute to retrieve Account Id from RMA
protected  void setAccountId(java.lang.Long nAccountId)
          Sets the accountId property of the command.
protected  void setChargeAmount(java.math.BigDecimal nChargeAmount)
          Sets the nChargeAmount property of the command.
protected  void setChargeAmountCurrency(java.lang.String sCurrency)
          Sets the chargeAmountCurrency property of the command.
 void setErrorViewName(java.lang.String sEVN)
          Optional error view name passed in by the Caller.
 void setOrder(OrderAccessBean ab)
          Sets the order property of the command.
 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.
protected  void updateOrderPaymentMethod()
          This method is called by performExecute to update ORDPAYMTHD table with refund info
 
Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, 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.BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
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

DoRefundTestCmdImpl

public DoRefundTestCmdImpl()
DoRefundTestCmdImpl default constructor.
Method Detail

checkCurrencyAndGetChargeAmount

protected void checkCurrencyAndGetChargeAmount()
                                        throws javax.ejb.CreateException,
                                               javax.ejb.FinderException,
                                               javax.naming.NamingException,
                                               java.rmi.RemoteException,
                                               ECException
Checks the currency of the Order and the Store default currency. Converts the refund amount to the Store default currency and stores in ChargeAmount if the two currencies are different. Otherwise, stores the refund amount as-is in the ChargeAmount.

getAccount

protected AccountAccessBean getAccount()
This method will first check if the local variable is set or not. If not set, the method will attempt to create a new AccessBean that represents the Account object.

getAccountId

protected java.lang.Long getAccountId()
Retrieve Account Reference Number

getChargeAmount

protected java.math.BigDecimal getChargeAmount()
Returned Charge Amount

getChargeAmountCurrency

protected java.lang.String getChargeAmountCurrency()
Returns the currency of the Charge Amount.
Returns:
The currency of the Charge Amount.
See Also:
getChargeAmount

getErrorViewName

protected java.lang.String getErrorViewName()
Retrieve the error view name passed in by the Caller.

getOrder

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

getRefundAmount

protected java.math.BigDecimal getRefundAmount()

getRMA

protected RMAAccessBean getRMA()
Retrieve RMA

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
Throws:
ECException -  

reset

public void reset()
Description copied from class: AbstractECCommand
This method is called after a command has been executed to reset its states variables. After the call to reset, we should be able to execute the command again.
Overrides:
reset in class AbstractECCommand

retrieveActiveAccountIdFromOrder

protected void retrieveActiveAccountIdFromOrder()
                                         throws javax.ejb.CreateException,
                                                javax.ejb.FinderException,
                                                javax.naming.NamingException,
                                                java.rmi.RemoteException,
                                                ECException
This is called by performExecute to retrieve Account Id from RMA

setAccountId

protected void setAccountId(java.lang.Long nAccountId)
Sets the accountId property of the command.
Parameters:
nAccountId - the Account ID.

setChargeAmount

protected void setChargeAmount(java.math.BigDecimal nChargeAmount)
Sets the nChargeAmount property of the command.
Parameters:
nChargeAmount - the Charge Amount of this refund.

setChargeAmountCurrency

protected void setChargeAmountCurrency(java.lang.String sCurrency)
Sets the chargeAmountCurrency property of the command.
Parameters:
sCurrency - the Charge Amount Currency.

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Optional error view name passed in by the Caller.
Specified by:
setErrorViewName in interface DoRefundPolicyCmd

setOrder

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

setRefundAmount

public void setRefundAmount(java.math.BigDecimal refundAmount)
Sets the refundAmount property of the command.
Specified by:
setRefundAmount in interface DoRefundPolicyCmd
Parameters:
refundAmount - the amount to be refunded.

setRMA

public void setRMA(RMAAccessBean ab)
Sets the RMA AccessBean representing the Return Merchandise Authorization record.
Specified by:
setRMA in interface DoRefundPolicyCmd

updateOrderPaymentMethod

protected void updateOrderPaymentMethod()
                                 throws javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException,
                                        java.rmi.RemoteException
This method is called by performExecute to update ORDPAYMTHD table with refund info