com.ibm.commerce.payment.extern
Class DebitAccountCmdImpl
java.lang.Object
|
+--com.ibm.commerce.command.AbstractECCommand
|
+--com.ibm.commerce.command.TaskCommandImpl
|
+--com.ibm.commerce.payment.extern.DebitAccountCmdImpl
- All Implemented Interfaces:
- DebitAccountCmd, ECCommand, TaskCommand
- public class DebitAccountCmdImpl
- extends TaskCommandImpl
- implements DebitAccountCmd
This DebitAccountCmdImpl
Task Command implementation class is called
to debit the customer account through an external accounting system. However,
this sample implementation class only generates an Order XML with information about the order
and stores the XML as a String in the ORDPAYMTHD table. It is intended for third-parties to
extend and write implementation code for integration with an external accounting system.
Method Summary |
protected java.math.BigDecimal |
getDepositAmount()
Returns the amount to be deposited. |
protected java.lang.String |
getErrorViewName()
Returns the error view name to be used in case of error. |
protected OrderAccessBean |
getOrder()
Returns the order for which 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 amount to be deposited. |
void |
setErrorViewName(java.lang.String sEVN)
Sets the optional error view name to be used in case of error. |
void |
setOrder(OrderAccessBean ab)
Sets the order for which payment is 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 |
DebitAccountCmdImpl
public DebitAccountCmdImpl()
getDepositAmount
protected java.math.BigDecimal getDepositAmount()
- Returns the amount to be deposited.
getErrorViewName
protected java.lang.String getErrorViewName()
- Returns the error view name to be used in case of error. This may be null if the
errorViewName property of the command is not set.
getOrder
protected OrderAccessBean getOrder()
- Returns the order for which payment is to be deposited.
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)
- Sets the amount to be deposited.
- Specified by:
setDepositAmount
in interface DebitAccountCmd
setErrorViewName
public void setErrorViewName(java.lang.String sEVN)
- Sets the optional error view name to be used in case of error.
- Specified by:
setErrorViewName
in interface DebitAccountCmd
setOrder
public void setOrder(OrderAccessBean ab)
- Sets the order for which payment is to be deposited.
- Specified by:
setOrder
in interface DebitAccountCmd