com.ibm.commerce.payment.extern
Class CheckAccountPaymentCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.payment.extern.CheckAccountPaymentCmdImpl
All Implemented Interfaces:
CheckAccountPaymentCmd, ECCommand, TaskCommand

public class CheckAccountPaymentCmdImpl
extends TaskCommandImpl
implements CheckAccountPaymentCmd

This CheckAccountPaymentCmdImpl Task Command implementation class is called to check the payment against the customer account through an external accounting system. This implementation class is empty. It is intended for third-parties to extend and write implementation code for integration with an external accounting system.


Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.extern.CheckAccountPaymentCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
CheckAccountPaymentCmdImpl()
           
 
Method Summary
protected  java.math.BigDecimal getApproveAmount()
          Returns the amount of the order to be checked and approved if necessary.
protected  java.lang.String getErrorViewName()
          Returns the error view name to be used in case of error.
protected  OrderAccessBean getOrder()
          Returns the order for which payment is to be deposited.
 java.lang.String getReturnCode()
          Returns the String return code indicating the approval status of the payment for the specified order.
 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 amount of the order to be checked and approved if necessary.
 void setErrorViewName(java.lang.String sEVN)
          Sets the optional error view name to be used in case of error.
 void setOrder(OrderAccessBean ab)
          Sets the order for which payment is to be checked.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, 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.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Constructor Detail

CheckAccountPaymentCmdImpl

public CheckAccountPaymentCmdImpl()
Method Detail

getApproveAmount

protected java.math.BigDecimal getApproveAmount()
Returns the amount of the order to be checked and approved if necessary.

getErrorViewName

protected java.lang.String getErrorViewName()
Returns the error view name to be used in case of error. This may be null if the errorViewName property of the command is not set.

getOrder

protected OrderAccessBean getOrder()
Returns the order for which payment is to be deposited.

getReturnCode

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

Possible values for the return code String are:

Specified by:
getReturnCode in interface CheckAccountPaymentCmd
Returns:
String the String return code indicating the payment approval status.

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

setApproveAmount

public void setApproveAmount(java.math.BigDecimal approveAmount)
Sets the amount of the order to be checked and approved if necessary.
Specified by:
setApproveAmount in interface CheckAccountPaymentCmd

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Sets the optional error view name to be used in case of error.
Specified by:
setErrorViewName in interface CheckAccountPaymentCmd

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order for which payment is to be checked.
Specified by:
setOrder in interface CheckAccountPaymentCmd