com.ibm.commerce.marketing.runtime.engine

Interface PrioritizeActivityTaskCmd

  • All Superinterfaces:
    com.ibm.websphere.command.Command, java.io.Serializable
    All Known Implementing Classes:
    PrioritizeActivityTaskCmdImpl

    public interface PrioritizeActivityTaskCmd
extends com.ibm.websphere.command.Command
    This command evaluates if an activity should be run in relation to other activities currently running on the same e-Marketing Spot. If the e-Marketing Spot does not specify any requested amount of data, then the activities are run from highest priority down until one of the activities returns some data. Equal priority activities are all run even when an activity of the same priority has already returned some data. If the e-Marketing Spot specifies a requested amount of data for categories, products or marketing content, then the activities are run from highest priority down until the requested amount of data has been returned. Equal priority activities are all run even when the requested amount of data has already been reached.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLASSNAME
      The name of this class.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      Default implementation class for this command.

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      boolean getRunCurrentTriggerListener(int index, java.util.List curVectorOfEmsDataBeans)
      This method evaluates if an activity should be run in relation to other activities currently running on the same e-Marketing Spot.
      void setPreviewReport(java.util.List previewReport)
      This method sets the list of information about the activity evaluation on the e-Marketing Spot.
      void setTriggerListeners(com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] triggerListenerArray)
      This method sets the list of activities (with the associated trigger listener information) that are to be run on an e-Marketing Spot.
      void setTriggerParameters(java.util.Map triggerParameters)
      This method sets the trigger parameters string that contains the values of the request amount of data to return.
      void setTriggerParameters(java.lang.String triggerParameters)
      This method sets the trigger parameters string that contains the values of the request amount of data to return.

      • Methods inherited from interface com.ibm.websphere.command.Command

        execute, isReadyToCallExecute, reset

    • Field Detail

      • COPYRIGHT

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

      • CLASSNAME

        static final java.lang.String CLASSNAME
        The name of this class.
        See Also:
        Constant Field Values

      • defaultCommandClassName

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

    • Method Detail

      • setTriggerListeners

        void setTriggerListeners(com.ibm.commerce.marketing.internal.runtime.objects.TriggerListen[] triggerListenerArray)
        This method sets the list of activities (with the associated trigger listener information) that are to be run on an e-Marketing Spot.
        Parameters:
        triggerListenerArray - The list of activities (with the associated trigger listener information) that are to be run on an e-Marketing Spot.

      • setTriggerParameters

        void setTriggerParameters(java.lang.String triggerParameters)
        This method sets the trigger parameters string that contains the values of the request amount of data to return. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Parameters:
        triggerParameters - The trigger parameters.

      • setTriggerParameters

        void setTriggerParameters(java.util.Map triggerParameters)
        This method sets the trigger parameters string that contains the values of the request amount of data to return. It is preferable to use the Map representation of the trigger parameters than the String representation.
        Parameters:
        triggerParameters - The trigger parameters.

      • setPreviewReport

        void setPreviewReport(java.util.List previewReport)
        This method sets the list of information about the activity evaluation on the e-Marketing Spot.
        Parameters:
        previewReport - A list of information about the activity evaluation on the e-Marketing Spot..

      • getRunCurrentTriggerListener

        boolean getRunCurrentTriggerListener(int index,
                                     java.util.List curVectorOfEmsDataBeans)
        This method evaluates if an activity should be run in relation to other activities currently running on the same e-Marketing Spot.
        Parameters:
        index - The index into the list of activities of the current activity to evaluate.
        curVectorOfEmsDataBeans - The current set of data that is to be returned to the e-Marketing Spot. This is a List of EMarketingSpotDataBeans.
        Returns:
        This method is true if this activity should be run, otherwise the method returns false.
Skip navigation links