com.ibm.commerce.payment.rules.commands

Interface DetermineSortedPaymentsCmd

  • All Superinterfaces:
    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:
    DetermineSortedPaymentsCmdImpl, DetermineSortedPaymentsVoidCmdImpl

    public interface DetermineSortedPaymentsCmd
extends TaskCommand
    This payments task command is used to sort payments align with order release. By default, the payments will be sorted by default arithmetic, this command will re-sort the payments. At the same time, this command will build the relationship between the order releases and the payments.

    The default implementation of this command is DetermineSortedPaymentsVoidCmdImpl. The DetermineSortedPaymentsCmd URL is mapped to this command by default.

  • Input parameters:

    paymentContainer: All available com.ibm.commerce.payment.rules.AtomicPaymentToBackendLinkObject objects which can be used. Each com.ibm.commerce.payment.rules.AtomicPaymentToBackendLinkObject object corresponds to an available payment object. This parameter is passed in by setPaymentContainer(Collection).

    releasesWithAmount: The LinkedHashMap object containing all releases to process. The key of this LinkedHashMap is ID of the release object with Long type. The value of this LinkedHashMap is the amount with BigDecimal that needs to process of the corresponding release. This parameter should be set to the request properties in the command context with the key "releasesWithAmount".

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values

      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.payment.rules.commands.DetermineSortedPaymentsCmd".
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class name is "com.ibm.commerce.payment.rules.commands.DetermineSortedPaymentsVoidCmdImpl".
        See Also:
        Constant Field Values

    • Method Detail

      • getPaymentContainer

        java.util.Collection getPaymentContainer()
        This method gets the current payment container.
        Returns:
        The payment container.

      • setPaymentContainer

        void setPaymentContainer(java.util.Collection paymentContainer)
        This method sets the current payment container.
        Parameters:
        paymentContainer - The current payment container.

      • setOrderId

        void setOrderId(java.lang.Long orderId)
        This method sets the current order ID.
        Parameters:
        orderId - the current order ID