CheckAccountPaymentCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.payment.extern.CheckAccountPaymentCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, CheckAccountPaymentCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
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.

Field Summary
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.payment.extern.CheckAccountPaymentCmd
  defaultCommandClassName, ERRTASK_NAME, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Constructor Summary

Constructors
Constructor and Description

CheckAccountPaymentCmdImpl()

Constructors
Constructor and Description
`CheckAccountPaymentCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- 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(BigDecimal)
  - 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:
    - com.ibm.commerce.payment.commands.PaymentConstants.APPROVAL_YES
      String constant for "YES" indicating the approval of the order is still valid.
    - com.ibm.commerce.payment.commands.PaymentConstants.APPROVAL_NO
      String constant for "NO" indicating the approval of the order is invalid and reapproval is not possible.
    - com.ibm.commerce.payment.commands.PaymentConstants.APPROVAL_WORKING
      String constant for "WORKING" indicating the approval of the order is invalid and reapproval is in progress.
    Specified by:
    
    getReturnCode in interface CheckAccountPaymentCmd
    
    Returns:
    
    the String return code indicating the payment approval status. (For this empty implementation class, this method 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
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    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.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    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

Class CheckAccountPaymentCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Fields inherited from interface com.ibm.commerce.payment.extern.CheckAccountPaymentCmd

Fields inherited from interface com.ibm.websphere.command.Command

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.websphere.command.CommandCaller

Methods inherited from interface com.ibm.commerce.command.ECCommand

Constructor Detail

CheckAccountPaymentCmdImpl

Method Detail

getApproveAmount

getErrorViewName

getOrder

getReturnCode

performExecute

reset

setApproveAmount

setErrorViewName

setOrder