com.ibm.commerce.payment.commands

Class DoCancelCmdImpl

  • All Implemented Interfaces:
    com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, DoCancelCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
    Deprecated. 
    Replaced by CancelOrderCmdImpl

    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:

    • Calls the DoCancelPolicy command for the Payment Policy used for the Purchase. (The ID of the Payment Policy is stored in the ORDPAYMTHD Table).
    • If sPurge is equal to PaymentConstants.ORDER_PURGE (1) perform the following:
      • remove entry in LPOPURAMT table, if exists
      • remove all entry in ORDPAYMTHD table
      • remove entry in TRDPURAMT table, if exists

    Error View Name:

    • DoDepositErrorView

    ErrorCodes:

    • (Include error codes from the other subordinate commands)

    This command uses the following AccessBeans:

    • BuyerPurchaseOrderAccessBean
    • OrderAccessBean
    • OrderPaymentMethodAccessBean
    • POPurchaseAmountAccessBean
    • TradingPurchaseAmountAccessBean

    This command calls the following BusinessPolicyCommands:

    See Also:
    Serialized Form

    • Constructor Detail

      • DoCancelCmdImpl

        public DoCancelCmdImpl()
        Deprecated. 

    • Method Detail

      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        Deprecated. 
        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.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Overrides:
        isReadyToCallExecute in class AbstractECTargetableCommand
        Returns:
        true if we can execute the command; false otherwise.

      • reset

        public void reset()
        Deprecated. 
        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.

        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand

      • setOrderId

        public void setOrderId(java.lang.Long orderId)
        Deprecated. 
        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)
        Deprecated. 
        Sets the purge property of the command.
        Specified by:
        setPurge in interface DoCancelCmd
        Parameters:
        sPurge - set to "1" to remove the ORDPAYMTHD record of the canceled order; otherwise, the ORDPAYMTHD record for the order is left intact.
Skip navigation links