com.ibm.commerce.payment.commands
Class CheckPaymentAcceptCLCmdImpl

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
All Implemented Interfaces:
BusinessPolicyCommand, CheckPaymentAcceptPolicyCmd, ECCommand, ECTargetableCommand, TaskCommand

public class CheckPaymentAcceptCLCmdImpl
extends BusinessPolicyCommandImpl
implements CheckPaymentAcceptPolicyCmd

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:

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. 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

CheckPaymentAcceptCLCmdImpl

public CheckPaymentAcceptCLCmdImpl()
Method Detail

getApproveAmount

protected java.math.BigDecimal getApproveAmount()
Returns the approveAmount property of the command.
Returns:
the approved amount to be checked

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 for which the approved amount is to be checked.
Returns:
the OrderAccessBean

getReturnCode

public java.lang.String getReturnCode()
Returns the String return code indicating the payment approval status of the specified order.

For this command implementation the possible return codes are:

Specified by:
getReturnCode in interface CheckPaymentAcceptPolicyCmd
Returns:
the String return 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

setApproveAmount

public void setApproveAmount(java.math.BigDecimal approveAmount)
Sets the approveAmount property of the command.
Specified by:
setApproveAmount in interface CheckPaymentAcceptPolicyCmd
Parameters:
approveAmount - the approved amount to be checked

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 CheckPaymentAcceptPolicyCmd
Parameters:
sEVN - the Error View name
See Also:
CheckPaymentAcceptPolicyCmd.ERRTASK_NAME

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface CheckPaymentAcceptPolicyCmd
Parameters:
ab - the OrderAccessBean representing the order for which the approved amount is to be checked

setReturnCode

public void setReturnCode(java.lang.String s)
Sets the return code to be returned to the caller of the command.
Parameters:
s - the return code string
See Also:
getReturnCode