com.ibm.commerce.payment.commands
Class DoDepositCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.payment.commands.DoDepositCmdImpl
All Implemented Interfaces:
DoDepositCmd, ECCommand, TaskCommand

public class DoDepositCmdImpl
extends TaskCommandImpl
implements DoDepositCmd

Default DoDeposit task command implementation.

Parameter:
Parameter Name Type Descriptions
order OrderAccessBean The Order Access Bean
depositAmount BigDecimal The amount of the deposit


Behavior:

Error View Name: ErrorCodes:


Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoDepositCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoDepositCmdImpl()
           
 
Method Summary
protected  java.math.BigDecimal getDepositAmount()
          Retrieve Deposit Amount
protected  OrderAccessBean getOrder()
          Retrieve Order
 boolean isReadyToCallExecute()
          This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command.
 void performExecute()
          Performs the main business logic of the command.
 void reset()
          Resets the instance variables of the command.
 void setDepositAmount(java.math.BigDecimal depositAmount)
          Sets the depositAmount property of the command.
 void setOrder(OrderAccessBean ab)
          The order to be deposited.
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Constructor Detail

DoDepositCmdImpl

public DoDepositCmdImpl()
Method Detail

getDepositAmount

protected java.math.BigDecimal getDepositAmount()
Retrieve Deposit Amount

getOrder

protected OrderAccessBean getOrder()
Retrieve Order

isReadyToCallExecute

public boolean isReadyToCallExecute()
This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
Overrides:
isReadyToCallExecute in class AbstractECCommand
Following copied from class: com.ibm.commerce.command.AbstractECCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

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 AbstractECCommand

setDepositAmount

public void setDepositAmount(java.math.BigDecimal depositAmount)
Description copied from interface: DoDepositCmd
Sets the depositAmount property of the command.
Specified by:
setDepositAmount in interface DoDepositCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoDepositCmd
Parameters:
depositAmount - the amount to be deposited.

setOrder

public void setOrder(OrderAccessBean ab)
The order to be deposited.
Specified by:
setOrder in interface DoDepositCmd
Following copied from interface: com.ibm.commerce.payment.commands.DoDepositCmd
Parameters:
abOrder - the OrderAccessBean of the Order for which is going to be deposited.