com.ibm.commerce.payment.commands
Class CheckPaymentAcceptPMCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.CheckPaymentAcceptPMCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, CheckPaymentAcceptPolicyCmd, ECCommand, java.lang.Runnable, TaskCommand

public class CheckPaymentAcceptPMCmdImpl
extends BusinessPolicyCommandImpl
implements CheckPaymentAcceptPolicyCmd, java.lang.Runnable

This CheckPaymentAcceptPolicy business policy command implementation class is the default implementation class for checking if the payment previously authorized to use the WebSphere Payment Manager is still valid.

Parameter:
Parameter Name Type Descriptions
abOrder OrderAccessBean The Order Access Bean
dApproveAmount BigDecimal The amount should have been or to be approved
errorViewName String Optional error view name passed in by the Caller.

This Task Command is normally called during ReleaseToFulfillment. It checks if the previously approved payment for an order is still valid and if the Approved Amount is same as the Order Amount.
(For WebSphere Payment Manager 2.2.1, a previously approved payment is no longer valid if it has expired.)
The command returns one of three possible answers:

Error View Name: ErrorCodes:


Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.CheckPaymentAcceptPolicyCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
CheckPaymentAcceptPMCmdImpl()
           
 
Method Summary
 java.math.BigDecimal getApproveAmount()
          Retrieve Approve Amount
protected  java.lang.String getErrorViewName()
          Retrieve the error view name passed in by the Caller.
protected  OrderAccessBean getOrder()
          Retrieve Order
 java.lang.String getReturnCode()
          Returns the String containing Return Code.
 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 run()
           
 void setApproveAmount(java.math.BigDecimal approveAmount)
          Sets the approveAmount property of the command.
protected  void setCurrencyExponent(java.lang.String astrCurrencyExponent)
          set Currency Exponent
 void setErrorViewName(java.lang.String sEVN)
          Optional error view name passed in by the Caller.
protected  void setNumericCurrencyCode(java.lang.String astrCurrencyCode)
          set Numeric Currency Code
 void setOrder(OrderAccessBean ab)
          The order to be ReApproved.
protected  void setPMApproveAmount(java.math.BigInteger approveAmount)
          set Approve Amount for WebSphere Payment Manager
protected  void setupNumericCurrencyCodeAndPMApproveAmount()
          This is called by performExecute to retrieve WebSphere Payment Manager ready amount
 
Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, 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
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Constructor Detail

CheckPaymentAcceptPMCmdImpl

public CheckPaymentAcceptPMCmdImpl()
Method Detail

getApproveAmount

public java.math.BigDecimal getApproveAmount()
Retrieve Approve Amount

getErrorViewName

protected java.lang.String getErrorViewName()
Retrieve the error view name passed in by the Caller.

getOrder

protected OrderAccessBean getOrder()
Retrieve Order

getReturnCode

public java.lang.String getReturnCode()
Returns the String containing Return Code. If the Payment System does not use Return Data then the byte Array will be null or of zero length.
Specified by:
getReturnCode in interface CheckPaymentAcceptPolicyCmd
Returns:
String
See Also:
#APPROVAL_YES, #APPROVAL_NO, #APPROVAL_WORKING

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 AbstractECCommand
Following copied from class: com.ibm.commerce.command.AbstractECCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

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 AbstractECCommand

run

public void run()
Specified by:
run in interface java.lang.Runnable

setApproveAmount

public void setApproveAmount(java.math.BigDecimal approveAmount)
Description copied from interface: CheckPaymentAcceptPolicyCmd
Sets the approveAmount property of the command.
Specified by:
setApproveAmount in interface CheckPaymentAcceptPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.CheckPaymentAcceptPolicyCmd
Parameters:
approveAmount - the amount to be approved.

setCurrencyExponent

protected void setCurrencyExponent(java.lang.String astrCurrencyExponent)
set Currency Exponent

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Optional error view name passed in by the Caller.
Specified by:
setErrorViewName in interface CheckPaymentAcceptPolicyCmd

setNumericCurrencyCode

protected void setNumericCurrencyCode(java.lang.String astrCurrencyCode)
set Numeric Currency Code

setOrder

public void setOrder(OrderAccessBean ab)
The order to be ReApproved.
Specified by:
setOrder in interface CheckPaymentAcceptPolicyCmd
Following copied from interface: com.ibm.commerce.payment.commands.CheckPaymentAcceptPolicyCmd
Parameters:
abOrder - the OrderAccessBean of the Order for which is going to be reapproved.

setPMApproveAmount

protected void setPMApproveAmount(java.math.BigInteger approveAmount)
set Approve Amount for WebSphere Payment Manager

setupNumericCurrencyCodeAndPMApproveAmount

protected void setupNumericCurrencyCodeAndPMApproveAmount()
                                                   throws javax.ejb.CreateException,
                                                          javax.ejb.FinderException,
                                                          javax.naming.NamingException,
                                                          java.rmi.RemoteException,
                                                          ECException
This is called by performExecute to retrieve WebSphere Payment Manager ready amount