com.ibm.commerce.payment.commands
Class CheckPaymentAcceptCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.CheckPaymentAcceptCmdImpl
All Implemented Interfaces:
CheckPaymentAcceptCmd, ECCommand, ECTargetableCommand, TaskCommand

public class CheckPaymentAcceptCmdImpl
extends TaskCommandImpl
implements CheckPaymentAcceptCmd

Default CheckPaymentAccept task command implementation class.

Parameters:

Parameter Name Type Descriptions
abOrder OrderAccessBean The Order Access Bean
dApproveAmount BigDecimal The approved amount to be checked
bReleaseToFulfillment Boolean The command is called as part of release to fulfillment.

This Task Command implements the CheckPaymentAccept Interface. 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:

Behavior:

Error View Name:

ErrorCodes:

This command uses the following AccessBeans:

This command calls the following TaskCommands:

This command calls the following BusinessPolicyCommands:

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands. CheckPaymentAcceptCmd
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
CheckPaymentAcceptCmdImpl()
           
 
Method Summary
protected  java.math.BigDecimal getApproveAmount()
          Returns the approveAmount property of the command.
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the order for which the approved amount is to be checked.
protected  java.lang.Boolean getReleaseToFulfillment()
          Returns the bRelease property of the command.
 java.lang.String getReturnCode()
          Returns a code indicating the result of the check.
 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)
          Sets the approveAmount property of the command.
 void setOrder( OrderAccessBean ab)
          Sets the order property of the command.
 void setReleaseToFulfillment(java.lang.Boolean b)
          Sets the bRelease property of the command.
 void setReturnCode(java.lang.String s)
          Sets the return code to be returned to the caller of the command.
 
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

CheckPaymentAcceptCmdImpl

public CheckPaymentAcceptCmdImpl()
Method Detail

getApproveAmount

protected java.math.BigDecimal getApproveAmount()
Returns the approveAmount property of the command.
Returns:
the approved amount to be checked

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the order for which the approved amount is to be checked.
Returns:
the OrderAccessBean

getReleaseToFulfillment

protected java.lang.Boolean getReleaseToFulfillment()
Returns the bRelease property of the command.
Returns:
true to indicate the checking was requested as part of release to fulfillment; false otherwise.

getReturnCode

public java.lang.String getReturnCode()
Returns a code indicating the result of the check.

Possible return codes are:

Specified by:
getReturnCode in interface CheckPaymentAcceptCmd
Returns:
the String return code

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)
Sets the approveAmount property of the command.
Specified by:
setApproveAmount in interface CheckPaymentAcceptCmd
Parameters:
approveAmount - the approved amount to be checked

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface CheckPaymentAcceptCmd
Parameters:
ab - the OrderAccessBean representing the order for which the approved amount is to be checked

setReleaseToFulfillment

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

setReturnCode

public void setReturnCode(java.lang.String s)
Sets the return code to be returned to the caller of the command.
Parameters:
s - the return code string
See Also:
getReturnCode