com.ibm.commerce.payment.extern
Class CheckAccountPaymentCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.payment.extern.CheckAccountPaymentCmdImpl
All Implemented Interfaces:
CheckAccountPaymentCmd, ECCommand, ECTargetableCommand, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.extern. CheckAccountPaymentCmd
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
CheckAccountPaymentCmdImpl()
           
 
Method Summary
protected  java.math.BigDecimal getApproveAmount()
          Gets the amount to be checked and reapproved if necessary.
protected  java.lang.String getErrorViewName()
          Returns the name of the error view to use for reporting error.
protected  OrderAccessBean getOrder()
          Gets the order for which payment is to be checked.
 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)
          The amount of the order to be checked and reapproved if necessary.
 void setErrorViewName(java.lang.String sEVN)
          Sets the error view to be used to report error.
 void setOrder( OrderAccessBean ab)
          Sets the order for which payment is to be checked.
 
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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckAccountPaymentCmdImpl

public CheckAccountPaymentCmdImpl()
Method Detail

getApproveAmount

protected java.math.BigDecimal getApproveAmount()
Gets the amount to be checked and reapproved if necessary.
Returns:
the amount to be checked
See Also:
setApproveAmount

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()
Gets the order for which payment is to be checked.
Returns:
the OrderAccessBean representing the order

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:
the String return code indicating the payment approval status. (For this empty implementation class, this mothod always returns the value PaymentConstants.APPROVAL_YES.)

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)
The amount of the order to be checked and reapproved if necessary.
Specified by:
setApproveAmount in interface CheckAccountPaymentCmd
Parameters:
approveAmount - the amount in the currency of the order

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

setOrder

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