com.ibm.commerce.edp.commands

Interface TriggerPaymentActionsCmd

  • All Superinterfaces:
    AEDPPaymentTaskCmd, AEDPTaskCmd, com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    TriggerPaymentActionsCmdImpl, TriggerPaymentActionsVoidCmdImpl


    public interface TriggerPaymentActionsCmd
    extends AEDPPaymentTaskCmd

    This task command is used to trigger payment actions in the payments subcomponent.

    The TriggerPaymentActionsCmd usually occurs after a series of edits has been made. Because the system cannot predict how many edits will occur before it should balance amounts, the TriggerPaymentActionsCmd causes any required payment actions to be executed and puts payments in a consistent state. The TriggerPaymentActionsCmd is also invoked when temporary connectivity problems have disrupted transactions.

    The possible payment actions associated with this event are: Approve, ReverseApproval, Deposit. Payment actions for this event are not configurable. This event is used internally by the Payment Rules�component and is mentioned here only to provide a complete list of events. Developers do not need to consider this event or any other Payment Rules�business event when writing payment plug-ins.

    The default implementation of this command is TriggerPaymentActionsCmdImpl.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The IBM Copyright notice field.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full name of this command.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values
    • Method Detail

      • setInitialAmount

        void setInitialAmount(java.math.BigDecimal initialAmount)
        This method sets the initial amount to be used in the trigger payment action business event request.
        Parameters:
        initialAmount - A BigDecimal that specifies the initial amount to be used in the trigger payment action business event request.
      • setTotalAmount

        void setTotalAmount(java.math.BigDecimal totalAmount)
        This method sets the total amount of the order.
        Parameters:
        totalAmount - A BigDecimal that specifies the total amount of the order.