com.ibm.commerce.payment.commands
Class DoDepositCmdImpl

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

public class DoDepositCmdImpl
extends TaskCommandImpl
implements DoDepositCmd

Default DoDeposit task command implementation.

Parameters:

Parameter Name Type Descriptions
order OrderAccessBean The Order Access Bean
depositAmount BigDecimal The amount to be deposited

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. DoDepositCmd
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
DoDepositCmdImpl()
           
 
Method Summary
protected  java.math.BigDecimal getDepositAmount()
          Returns the Deposit Amount.
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the order whose payment is to be deposited.
 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)
          Sets the order property 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, 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

DoDepositCmdImpl

public DoDepositCmdImpl()
Method Detail

getDepositAmount

protected java.math.BigDecimal getDepositAmount()
Returns the Deposit Amount.
Returns:
the amount to be deposited

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the order whose payment is to be deposited.
Returns:
the OrderAccessBean

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 AbstractECTargetableCommand
Returns:
true if we can execute the command; false otherwise.

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

setDepositAmount

public void setDepositAmount(java.math.BigDecimal depositAmount)
Sets the depositAmount property of the command.
Specified by:
setDepositAmount in interface DoDepositCmd
Parameters:
depositAmount - the amount to be deposited.

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface DoDepositCmd
Parameters:
ab - the OrderAccessBean of the Order whose payment is to be deposited