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
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:
PaymentConstants.ERR_CODE_CURRENCY_CONVERT_FAIL
(1961) -
Currency conversion not available or failed.PaymentConstants.ERR_CODE_CREDIT_LINE_NOT_AVAILABLE
(1981) -
Credit Line not available or no longer active.This command uses the following AccessBeans:
This command does not call other TaskCommand.
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 |
---|
public DoDepositCLCmdImpl()
Method Detail |
---|
protected void convertAmountToStoreDefaultCurrency(java.lang.Long nOrderId) throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException, ECException
nOrderId
- the ID of the Order whose payment is to be
depositedjavax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException
ECException
protected java.math.BigDecimal getChargeAmount()
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.
protected java.lang.Long getCreditLineId()
protected java.math.BigDecimal getDepositAmount()
protected java.lang.String getErrorViewName()
protected OrderAccessBean getOrder()
protected java.lang.String getStoreDefaultCurrency()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
protected void setChargeAmount(java.math.BigDecimal n)
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.
n
- the amount to be deposited converted to the default
currency of the Storeprotected void setCreditLineId(java.lang.Long n)
n
- the internal ID of the CreditLine
recordpublic void setDepositAmount(java.math.BigDecimal depositAmount)
setDepositAmount
in interface
DoDepositPolicyCmd
depositAmount
- the amount to be
deposited.public void setErrorViewName(java.lang.String sEVN)
setErrorViewName
in interface
DoDepositPolicyCmd
sEVN
- the Error View nameDoDepositPolicyCmd.ERRTASK_NAME
public void setOrder(OrderAccessBean ab)
setOrder
in interface
DoDepositPolicyCmd
ab
- the OrderAccessBean of the Order whose payment is to be
depositedprotected void setStoreDefaultCurrency(java.lang.String s)
s
- the alpha currency code representing the default currency
of the Storeprotected void updateOrderPaymentMethod() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException
java.rmi.RemoteException