java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.command.BusinessPolicyCommandImpl | +--com.ibm.commerce.payment.commands.CheckPaymentAcceptCLCmdImpl
This
CheckPaymentAcceptPolicy
business policy command
implementation class is the default implementation class for checking if the
payment previously authorized to use the CreditLine is still valid.
Parameters:
Parameter Name | Type | Descriptions |
abOrder | OrderAccessBean | The OrderAccessBean |
dApproveAmount | BigDecimal | The approved amount to be checked |
errorViewName | String | Optional error view name passed in by the Caller. |
Default Error View Name:
ErrorCodes:
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. CheckPaymentAcceptPolicyCmd |
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 | |
---|---|
CheckPaymentAcceptCLCmdImpl() |
Method Summary | |
---|---|
protected
java.math.BigDecimal |
getApproveAmount() Returns the approveAmount 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 for which the approved amount is to be checked. |
java.lang.String |
getReturnCode() Returns the String return code indicating the payment approval status of the specified order. |
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 |
setApproveAmount(java.math.BigDecimal approveAmount) Sets the approveAmount 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. |
void |
setReturnCode(java.lang.String s) Sets the return code to be returned to the caller of the command. |
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 CheckPaymentAcceptCLCmdImpl()
Method Detail |
---|
protected java.math.BigDecimal getApproveAmount()
protected java.lang.String getErrorViewName()
protected OrderAccessBean getOrder()
public java.lang.String getReturnCode()
For this command implementation the possible return codes are:
PaymentConstants.APPROVAL_YES
- The authorization is still
valid and the Approved Amount is the same as the Order Amount.PaymentConstants.APPROVAL_NO
- The authorization is no longer
valid. Re-authorization is not possible.
getReturnCode
in interface
CheckPaymentAcceptPolicyCmd
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
public void setApproveAmount(java.math.BigDecimal approveAmount)
setApproveAmount
in interface
CheckPaymentAcceptPolicyCmd
approveAmount
- the approved amount to be
checkedpublic void setErrorViewName(java.lang.String sEVN)
setErrorViewName
in interface
CheckPaymentAcceptPolicyCmd
sEVN
- the Error View nameCheckPaymentAcceptPolicyCmd.ERRTASK_NAME
public void setOrder(OrderAccessBean ab)
setOrder
in interface
CheckPaymentAcceptPolicyCmd
ab
- the OrderAccessBean representing the order for which the
approved amount is to be checkedpublic void setReturnCode(java.lang.String s)
s
- the return code stringgetReturnCode