com.ibm.commerce.payment.commands
Class DoCancelCmdImpl

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

public class DoCancelCmdImpl
extends TaskCommandImpl
implements DoCancelCmd

Default DoCancel task command implementation is called by the AdminOrderCancel Controller command to cancel the payment for an order.

Parameter:
Parameter Name Type Descriptions
orderId Order ID The Order to be cancelled
sPurge String The flag to cleanup the row in ORDPAYMTHD table

Behavior:

Error View Name: ErrorCodes:


Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoCancelCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoCancelCmdImpl()
           
 
Method Summary
protected  OrderAccessBean getOrder()
          This method will first check if the local variable is set or not.
protected  java.lang.Long getOrderId()
          Gets the orderId property of the command.
 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 setOrderId(java.lang.Long orderId)
          Sets the orderId property of the command.
 void setPurge(java.lang.String sPurge)
          Sets the purge property of the command.
 
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

DoCancelCmdImpl

public DoCancelCmdImpl()
Method Detail

getOrder

protected OrderAccessBean getOrder()
This method will first check if the local variable is set or not. If not set it will attempt to get it by create a new AccessBean.

getOrderId

protected java.lang.Long getOrderId()
Gets the orderId property of the command.

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

setOrderId

public void setOrderId(java.lang.Long orderId)
Sets the orderId property of the command.
Specified by:
setOrderId in interface DoCancelCmd
Parameters:
orderId - the order reference number of the Order for which the detail order description is to be prepared.

setPurge

public void setPurge(java.lang.String sPurge)
Sets the purge property of the command.
Specified by:
setPurge in interface DoCancelCmd
Parameters:
purge - - with this set to "1" will remove row in ordpaymthd of the cancelling order