com.ibm.commerce.payment.commands
Interface CheckPaymentAcceptCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
CheckPaymentAcceptCmdImpl

public interface CheckPaymentAcceptCmd
extends TaskCommand

The CheckPaymentAcceptCmd Task Command

This Task Command is normally called during ReleaseToFulfillment. It checks if the previously approved payment for an order is still valid and if the Approved Amount is the same as the Order Amount.

The command returns one of three possible answers:

See Also:
CheckPaymentAcceptCmdImpl

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 Error View for this command.
static java.lang.String NAME
          The name of this command.
 
Method Summary
 java.lang.String getReturnCode()
          Returns a code indicating the result of the check.
 void setApproveAmount(java.math.BigDecimal approveAmount)
          Sets the approveAmount property of the command.
 void setOrder( OrderAccessBean abOrder)
          Sets the order property of the command.
 void setReleaseToFulfillment(java.lang.Boolean bRelease)           Sets the bRelease property of the command.
 

Field Detail
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 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 a code indicating the result of the check.

Possible return codes are:

Returns:
the String return code

setApproveAmount

public void setApproveAmount(java.math.BigDecimal approveAmount)
Sets the approveAmount property of the command.
Parameters:
approveAmount - the approved amount to be checked

setOrder

public void setOrder(OrderAccessBean abOrder)
Sets the order property of the command.
Parameters:
abOrder - the OrderAccessBean representing the order for which the approved amount is to be checked

setReleaseToFulfillment

public void setReleaseToFulfillment(java.lang.Boolean bRelease)
Sets the bRelease property of the command.
Parameters:
bRelease - true to indicate the checking was requested as part of release to fulfillment