com.ibm.commerce.payment.commands
Class CheckPaymentAcceptTestCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                          |
                          +--com.ibm.commerce.payment.commands.CheckPaymentAcceptTestCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, CheckPaymentAcceptPolicyCmd, ECCommand, ECTargetableCommand, TaskCommand

public class CheckPaymentAcceptTestCmdImpl
extends BusinessPolicyCommandImpl
implements CheckPaymentAcceptPolicyCmd

The CheckPaymentAcceptPolicyCmd implementation class for the TestPaymentMethod policy. This sample implementation class always returns the return code String that indicates the payment approval status of "YES" (PaymentConstants.APPROVAL_YES).

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
CheckPaymentAcceptTestCmdImpl()
          CheckPaymentAcceptTestCmdImpl constructor.
 
Method Summary
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.
 void performExecute()
          Performs the main business logic 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 abOrder)
          Sets the order property 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, isReadyToCallExecute, reset, 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

CheckPaymentAcceptTestCmdImpl

public CheckPaymentAcceptTestCmdImpl()
CheckPaymentAcceptTestCmdImpl constructor.
Method Detail

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.

This sample implementation class for the TestPaymentMethod policy always returns the constant String PaymentConstants.APPROVAL_YES indicating the payment approval status of the order is valid.

Specified by:
getReturnCode in interface CheckPaymentAcceptPolicyCmd
Returns:
the String return code

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command. For the TestPaymentMethod policy this command always returns the return code String that indicate a payment approval status of "YES".
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException

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 abOrder)
Sets the order property of the command.
Specified by:
setOrder in interface CheckPaymentAcceptPolicyCmd
Parameters:
abOrder - the OrderAccessBean representing the order for which the approved amount is to be checked