com.ibm.commerce.payment.extern
Interface CheckAccountPaymentCmd

All Superinterfaces:
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
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.
Method Summary
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.
Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation of this command.
See Also:
Constant Field Values

ERRTASK_NAME

public 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

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.
Returns:
the String return code indicating the payment approval status.

setApproveAmount

public 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

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

setOrder

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

Feedback