com.ibm.commerce.payment.commands
Class DoCancelCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.DoCancelCmdImpl
All Implemented Interfaces:
DoCancelCmd, ECCommand, ECTargetableCommand, 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.

Parameters:

Parameter Name Type Descriptions
orderId Order ID ID of the order whose payment is to be canceled
sPurge String Flag to indicate cleanup of the ORDPAYMTHD record is required.

Behavior:

Error View Name:

ErrorCodes:

This command uses the following AccessBeans:

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. DoCancelCmd
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
DoCancelCmdImpl()
           
 
Method Summary
protected  OrderAccessBean getOrder()
          Returns the OrderAccessBean representing the order whose payment is to be canceled.
protected  java.lang.Long getOrderId()
          Returns 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. 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

DoCancelCmdImpl

public DoCancelCmdImpl()
Method Detail

getOrder

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

This method first checks if the local variable is set or not. If not set, it will attempt to get it by creating a new AccessBean.

Returns:
the OrderAccessBean

getOrderId

protected java.lang.Long getOrderId()
Returns the orderId property of the command.
Returns:
the ID of the order whose payment is to be canceled

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

setOrderId

public void setOrderId(java.lang.Long orderId)
Sets the orderId property of the command.
Specified by:
setOrderId in interface DoCancelCmd
Parameters:
orderId - the ID of the Order whose payment is to be canceled

setPurge

public void setPurge(java.lang.String sPurge)
Sets the purge property of the command.
Specified by:
setPurge in interface DoCancelCmd