com.ibm.commerce.payment.commands
Class DoDepositCLCmdImpl

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

public class DoDepositCLCmdImpl
extends BusinessPolicyCommandImpl
implements DoDepositPolicyCmd

This DoDepositPolicy business policy command implementation class is the default implementation class for depositing payment previously authorized to use the CreditLine.

Parameter:
Parameter Name Type Descriptions
order OrderAccessBean The Order Access Bean
depositAmount BigDecimal The amount of the deposit
errorViewName String Optional error view name passed in by the Caller.

Behavior:

Error View Name: ErrorCodes:


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.DoDepositPolicyCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoDepositCLCmdImpl()
           
 
Method Summary
protected  void convertAmountToStoreDefaultCurrency(java.lang.Long nOrderId)
          This is called by performExecute to convert the Amount to the Store Default Currency
protected  java.math.BigDecimal getChargeAmount()
          Retrieve Charge Amount
protected  java.lang.Long getCreditLineId()
          Retrieve Credit Line Reference Number
protected  java.math.BigDecimal getDepositAmount()
          Retrieve Deposit Amount
protected  java.lang.String getErrorViewName()
          Retrieve the error view name passed in by the Caller.
protected  OrderAccessBean getOrder()
          Retrieve Order
protected  java.lang.String getStoreDefaultCurrency()
          Retrieve Store Default Currency
 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.
protected  void setChargeAmount(java.math.BigDecimal n)
          Set Charge Amount
protected  void setCreditLineId(java.lang.Long n)
          Set Credit Line Reference Number
 void setDepositAmount(java.math.BigDecimal depositAmount)
          Sets the depositAmount property of the command.
 void setErrorViewName(java.lang.String sEVN)
          Optional error view name passed in by the Caller.
 void setOrder(OrderAccessBean ab)
          The order to be ReApproved.
protected  void setStoreDefaultCurrency(java.lang.String s)
          Set Store Default Currency
protected  void updateOrderPaymentMethod()
          This 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, 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

DoDepositCLCmdImpl

public DoDepositCLCmdImpl()
Method Detail

convertAmountToStoreDefaultCurrency

protected void convertAmountToStoreDefaultCurrency(java.lang.Long nOrderId)
                                            throws javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   javax.naming.NamingException,
                                                   java.rmi.RemoteException,
                                                   ECException
This is called by performExecute to convert the Amount to the Store Default Currency

getChargeAmount

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

getCreditLineId

protected java.lang.Long getCreditLineId()
Retrieve Credit Line Reference Number

getDepositAmount

protected java.math.BigDecimal getDepositAmount()
Retrieve Deposit Amount

getErrorViewName

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

getOrder

protected OrderAccessBean getOrder()
Retrieve Order

getStoreDefaultCurrency

protected java.lang.String getStoreDefaultCurrency()
Retrieve Store Default Currency

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

setChargeAmount

protected void setChargeAmount(java.math.BigDecimal n)
Set Charge Amount

setCreditLineId

protected void setCreditLineId(java.lang.Long n)
Set Credit Line Reference Number

setDepositAmount

public void setDepositAmount(java.math.BigDecimal depositAmount)
Description copied from interface: DoDepositPolicyCmd
Sets the depositAmount property of the command.
Specified by:
setDepositAmount in interface DoDepositPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoDepositPolicyCmd
Parameters:
depositAmount - the amount to be deposited.

setErrorViewName

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

setOrder

public void setOrder(OrderAccessBean ab)
The order to be ReApproved.
Specified by:
setOrder in interface DoDepositPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoDepositPolicyCmd
Parameters:
abOrder - the OrderAccessBean of the Order for which is going to be deposited.

setStoreDefaultCurrency

protected void setStoreDefaultCurrency(java.lang.String s)
Set Store Default Currency

updateOrderPaymentMethod

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