com.ibm.commerce.payment.commands
Class DoDepositCLCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                          |
                          +--com.ibm.commerce.payment.commands.DoDepositCLCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, DoDepositPolicyCmd, ECCommand, ECTargetableCommand, 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.

Parameters:

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:

Default Error View Name:

ErrorCodes:

This command uses the following AccessBeans:

This command does not call other TaskCommand.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.commerce.command. BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands. DoDepositPolicyCmd
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
DoDepositCLCmdImpl()
           
 
Method Summary
protected  void convertAmountToStoreDefaultCurrency(java.lang.Long nOrderId)
          Converts the Deposit Amount in the currency of the order to the default currency of the Store.
protected  java.math.BigDecimal getChargeAmount()
          Returns the Charge Amount.
protected  java.lang.Long getCreditLineId()
          Returns the CreditLine ID.
protected  java.math.BigDecimal getDepositAmount()
          Gets the depositAmount property of the command.
protected  java.lang.String getErrorViewName()
          Returns the name of the error view to use for reporting error.
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the order whose payment is to be deposited.
protected  java.lang.String getStoreDefaultCurrency()
          Returns the default currency of the Store.
 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)
          Sets the Charge Amount.
protected  void setCreditLineId(java.lang.Long n)
          Sets the Credit Line ID.
 void setDepositAmount(java.math.BigDecimal depositAmount)
          Sets the depositAmount property of the command.
 void setErrorViewName(java.lang.String sEVN)
          Sets the error view to be used to report error.
 void setOrder( OrderAccessBean ab)
          Sets the order property of the command.
protected  void setStoreDefaultCurrency(java.lang.String s)
          Sets the Store Default Currency
protected  void updateOrderPaymentMethod()
          Updates the ORDPAYMTHD table with deposit info for the order.
 
Methods inherited from class com.ibm.commerce.command. BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
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
 
Methods inherited from interface com.ibm.commerce.command. BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 

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
Converts the Deposit Amount in the currency of the order to the default currency of the Store.
Parameters:
nOrderId - the ID of the Order whose payment is to be deposited
Throws:
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException
ECException

getChargeAmount

protected java.math.BigDecimal getChargeAmount()
Returns the Charge Amount.

The Charge Amount is the Deposit Amount converted to the default currency of the Store. If the default currency of the Store is the same as the currency of the order, then the Charge Amount is the same as the Deposit Amount.

Returns:
the Charge Amount

getCreditLineId

protected java.lang.Long getCreditLineId()
Returns the CreditLine ID.
Returns:
the internal ID of the Credit Line record

getDepositAmount

protected java.math.BigDecimal getDepositAmount()
Gets the depositAmount property of the command.
Returns:
the amount to be deposited.

getErrorViewName

protected java.lang.String getErrorViewName()
Returns the name of the error view to use for reporting error.
Returns:
the error view name

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the order whose payment is to be deposited.
Returns:
the OrderAccessBean

getStoreDefaultCurrency

protected java.lang.String getStoreDefaultCurrency()
Returns the default currency of the Store.
Returns:
the alpha currency code

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

setChargeAmount

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

The Charge Amount is the Deposit Amount converted to the default currency of the Store. If the default currency of the Store is the same as the currency of the order, then the Charge Amount is the same as the Deposit Amount.

Parameters:
n - the amount to be deposited converted to the default currency of the Store

setCreditLineId

protected void setCreditLineId(java.lang.Long n)
Sets the Credit Line ID.
Parameters:
n - the internal ID of the CreditLine record

setDepositAmount

public void setDepositAmount(java.math.BigDecimal depositAmount)
Sets the depositAmount property of the command.
Specified by:
setDepositAmount in interface DoDepositPolicyCmd
Parameters:
depositAmount - the amount to be deposited.

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Sets the error view to be used to report error. This overrides the default error view of the command.
Specified by:
setErrorViewName in interface DoDepositPolicyCmd
Parameters:
sEVN - the Error View name
See Also:
DoDepositPolicyCmd.ERRTASK_NAME

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface DoDepositPolicyCmd
Parameters:
ab - the OrderAccessBean of the Order whose payment is to be deposited

setStoreDefaultCurrency

protected void setStoreDefaultCurrency(java.lang.String s)
Sets the Store Default Currency
Parameters:
s - the alpha currency code representing the default currency of the Store

updateOrderPaymentMethod

protected void updateOrderPaymentMethod()
                                 throws javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException,
                                        java.rmi.RemoteException
Updates the ORDPAYMTHD table with deposit info for the order.
Throws:
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException