com.ibm.commerce.edp.commands

Interface EvaluatePaymentRulesCmd

  • 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:
    EvaluatePaymentRulesCmdImpl, EvaluatePaymentRulesVoidCmdImpl

    public interface EvaluatePaymentRulesCmd
extends TaskCommand
    This task command is for evaluating the payment rule from the payment rule configuration. When the task commands(For example, PrimePaymentCmd) intend to get what payment actions need to execute, this command is called. This command further calls RuleReader that actually execute the business logic. This command needs the following parameter to decide the corresponding payment actions according to the payment rules configuration:

  • The identifier of EDPOrder
  • The amount to process currently
  • The identifier of EDPReleases
  • The current business event phase
  • The Payment instruction id in payment rule
  • The atomic payment id in payment rule
  • The rule type
  • The order channel
  • The store identifier

    • The default implementation of this command is EvaluatePaymentRulesCmdImpl
See Also:
PrimePaymentCmd, RuleReader

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The IBM Copyright notice field.
        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

      • setEDPOrderId

        void setEDPOrderId(java.lang.Long edpOrderId)
        This method sets the current identifier of EDPOrder .
        Parameters:
        edpOrderId - A Long that specifies the current identifier of EDPOrder to set.

      • setAmountToProcess

        void setAmountToProcess(java.math.BigDecimal amountToProcess)
        This method sets the amount to be processed.
        Parameters:
        amountToProcess - A BigDecimal that specifies the amount to be processed to set.

      • setEDPReleaseId

        void setEDPReleaseId(java.util.List edpReleaseIds)
        This method sets the involved EDPRelease.
        Parameters:
        edpReleaseIds - A List that represents the identifier of involved EDPRelease.

      • setPhase

        void setPhase(int phase)
        This method sets the current phase. The value of current phase could be the following value:

        1 -- The phase of validation.

        2 -- The phase of reservation.

        3 -- The phase of finalization.

        Parameters:
        phase - An in that indicates the current phase.

      • getActionDatas

        java.util.HashMap getActionDatas()
        This method returns the current action datas.
        Returns:
        A HashMap that represents the current action datas.

      • setRuleType

        void setRuleType(java.lang.String ruleType)
        This method sets the rule type.
        Parameters:
        ruleType - A String that specifies the rule type to set.

      • setEDPPaymentInstructionId

        void setEDPPaymentInstructionId(java.lang.Long edpPIId)
        This method sets the Payment instruction id in payment rule.
        Parameters:
        edpPIId - A Long that specifies the identifier of payment instruction in payment rule to set.

      • setAtomicPaymentId

        void setAtomicPaymentId(java.lang.Long atmPaymentId)
        This method sets the atomic payment id in payment rule.
        Parameters:
        atmPaymentId - A Long that specifies the atomic payment id to set.

      • getHashOfActionList

        java.util.HashMap getHashOfActionList()
        This method returns the hashmap which stores the current action list.
        Returns:
        A HashMap that represents the hashmap that stores the current action list.

      • setHashOfActionList

        void setHashOfActionList(java.util.HashMap hashOfActionList)
        This method sets the hashmap which stores the current action list.
        Parameters:
        hashOfActionList - A HashMap that represents the hashmap that stores the current action list to set.

      • getListOfActionList

        java.util.List getListOfActionList()
        This method returns the list of current action list.
        Returns:
        A List that represents the list of current action list.

      • setListOfActionList

        void setListOfActionList(java.util.List listOfActionList)
        This method sets the list of current action list.
        Parameters:
        listOfActionList - A List that represents the list of current action list.

      • getException

        java.lang.Throwable getException()
        This method returns the thrown exception.
        Returns:
        A Throwable that represents the exception thrown.

      • setRulePhase

        void setRulePhase(int i)
        This method sets the current phase. The value of current rule phase could be the following value:

        1 -- The phase unhandling amount.

        2 -- The phase unhandling rule.

        3 -- The phase reversing rule.

        Parameters:
        i - An int that indicates the rule phase to set.

      • setOrderChannel

        void setOrderChannel(java.lang.String string)
        This method sets the current order channel to set.
        Parameters:
        string - A String that specifies the current order channel to set.

      • setStoreId

        void setStoreId(java.lang.Integer integer)
        This method sets the current store id.
        Parameters:
        integer - An Integer that specifies the current store id.