CheckAccountPaymentCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

CheckAccountPaymentCmdImpl
```
public interface CheckAccountPaymentCmd
extends TaskCommand
```
The CheckAccountPaymentCmd Task Command is called by the CheckPaymentAcceptCmdImpl command implementation to check the payment against the customer account through an external accounting system.
This command returns one of three possible answers. See getReturnCode() method for details.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.
`static java.lang.String`	`defaultCommandClassName` The default implementation of this command.
`static java.lang.String`	`ERRTASK_NAME` Name of the default error view for this command.
`static java.lang.String`	`NAME` The name of this command.

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

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getReturnCode()` Returns the String return code indicating the approval status of the payment for the specified order.
`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 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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

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, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    The name of this command.
    
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The default implementation of this command.
    
    See Also:
    
    Constant Field Values
  - ERRTASK_NAME
```
static final java.lang.String ERRTASK_NAME
```
    Name of the default error view for this command. The constant value of this field is "CheckPaymentAcceptErrorView".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getReturnCode
```
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.
    Returns:
    
    the String return code indicating the payment approval status.
  - setApproveAmount
```
void setApproveAmount(java.math.BigDecimal approveAmount)
```
    The amount of the order to be checked and reapproved if necessary.
    
    Parameters:
    
    approveAmount - the amount in the currency of the order
  - setErrorViewName
```
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.
    
    Parameters:
    
    sEVN - the Error View name
  - setOrder
```
void setOrder(OrderAccessBean ab)
```
    Sets the order for which payment is to be checked.
    
    Parameters:
    
    ab - the OrderAccessBean representing the order

Interface CheckAccountPaymentCmd

Field Summary

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

Method Summary

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

Field Detail

COPYRIGHT

NAME

defaultCommandClassName

ERRTASK_NAME

Method Detail

getReturnCode

setApproveAmount

setErrorViewName

setOrder