com.ibm.commerce.payment.commands
Class DoCancelPMCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.command.BusinessPolicyCommandImpl
                    |
                    +--com.ibm.commerce.payment.commands.DoCancelPMCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, DoCancelPolicyCmd, ECCommand, TaskCommand

public class DoCancelPMCmdImpl
extends BusinessPolicyCommandImpl
implements DoCancelPolicyCmd

This DoCancelPMCmdImpl Business Policy Command implementation is called by the DoCancelCmdImpl Task command to cancel the payment for an order that has been submitted to the Payment Manager for processing. Only Order that has no payment in the deposited state (or above) can be cancelled.


Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
 
Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.DoCancelPolicyCmd
COPYRIGHT, defaultCommandClassName, ERRTASK_NAME, NAME
 
Constructor Summary
DoCancelPMCmdImpl()
           
 
Method Summary
protected  java.lang.String getErrorViewName()
          Retrieve the error view name passed in by the Caller.
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 setErrorViewName(java.lang.String sEVN)
          Optional error view name passed in by the Caller.
 void setOrder(OrderAccessBean ab)
          The order to be ReApproved.
 
Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
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.BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
 
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

DoCancelPMCmdImpl

public DoCancelPMCmdImpl()
Method Detail

getErrorViewName

protected java.lang.String getErrorViewName()
Retrieve the error view name passed in by the Caller.

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

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Optional error view name passed in by the Caller.
Specified by:
setErrorViewName in interface DoCancelPolicyCmd

setOrder

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