com.ibm.commerce.marketing.promotion.commands

Interface SimulatedPromotionEvaluationTaskCmd

  • 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:
    SimulatedPromotionEvaluationTaskCmdImpl


    public interface SimulatedPromotionEvaluationTaskCmd
    extends TaskCommand
    The command interface to evaluate a simulated order.
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        Default implementation class for this command.
      • SIMULATED_ID

        static final long SIMULATED_ID
        The ID constant uses for simulated order and order item.
        See Also:
        Constant Field Values
      • SIMULATED_ORDER_ID

        static final java.lang.Long SIMULATED_ORDER_ID
        The simulated order ID.
      • GENERIC_USER_ID

        static final long GENERIC_USER_ID
        The generic user ID -1002.
        See Also:
        Constant Field Values
      • SIMULATED_GENERIC_USER_ID

        static final java.lang.Long SIMULATED_GENERIC_USER_ID
        The generic user ID to use. Value of -1002.
      • ZERO

        static final java.math.BigDecimal ZERO
        The constant - ZERO.
      • ONE

        static final java.math.BigDecimal ONE
        The constant - ONE.
    • Method Detail

      • setPromotionTemplateName

        void setPromotionTemplateName(java.lang.String aTemplateName)
        Sets the promotion template name.
        Parameters:
        aTemplateName - The promotion template name to set.
      • setPromotionIDs

        void setPromotionIDs(java.util.List<java.lang.String> aPromotionIDs)
        Sets a list of promotion IDs that will be evaluated. If this list is empty, the command will evaluate all available promotions according to the specified promotion template.
        Parameters:
        aPromotionIDs - A list of promotion IDs.
      • setOrder

        void setOrder(Order aOrder)
        Sets simulated order. This method must be called before the evaluation process starts.
        Parameters:
        aOrder - The simulated order object.
      • setSimulatedConfiguration

        void setSimulatedConfiguration(java.util.Map<java.lang.String,java.lang.String> aSimulatedConfiguration)
        Sets the optional simulated configurations.
        Parameters:
        aSimulatedComponents - A map of optional simulated configurations.
      • getEvaluationResult

        PromotionArgument getEvaluationResult()
        Gets the promotion evaluation result.
        Returns:
        The result PromotionArgument object.