com.ibm.commerce.marketing.runtime.engine

Class PrioritizeActivityTaskCmdImpl

  • java.lang.Object
    • com.ibm.websphere.command.TargetableCommandImpl
      • com.ibm.websphere.command.CacheableCommandImpl
        • com.ibm.commerce.marketing.runtime.engine.PrioritizeActivityTaskCmdImpl
  • All Implemented Interfaces:
    PrioritizeActivityTaskCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable


    public class PrioritizeActivityTaskCmdImpl
    extends com.ibm.websphere.command.CacheableCommandImpl
    implements PrioritizeActivityTaskCmd
    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.
    See Also:
    Serialized Form
    • 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.
      • Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

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

        serialVersionUID
    • Method Summary

      All Methods Instance Methods Concrete 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.
      boolean isReadyToCallExecute()
      This method returns true.
      void performExecute()
      This method performs no action.
      void setPreviewReport(java.util.List newPreviewReport)
      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[] newTriggerListenerArray)
      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 newTriggerParameters)
      This method sets the trigger parameters string that contains the values of the request amount of data to return.
      void setTriggerParameters(java.lang.String newTriggerParameters)
      This method sets the trigger parameters string that contains the values of the request amount of data to return.
      • Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

        execute, executeFromCache, getCaller, getEntryInfo, getId, getObjectSize, getSharingPolicy, postExecute, preExecute, reset, setCaller, setObjectSize, unionDependencies, updateCache
      • Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

        getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.websphere.command.Command

        execute, reset
      • Methods inherited from interface com.ibm.websphere.command.TargetableCommand

        getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties
    • Field Detail

      • COPYRIGHT

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

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

      • PrioritizeActivityTaskCmdImpl

        public PrioritizeActivityTaskCmdImpl()
        This method is the default constructor. It currently performs no actions.
    • Method Detail

      • performExecute

        public void performExecute()
        This method performs no action.
        Specified by:
        performExecute in interface com.ibm.websphere.command.TargetableCommand
        Specified by:
        performExecute in class com.ibm.websphere.command.TargetableCommandImpl
      • setTriggerListeners

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

        public void setTriggerParameters(java.lang.String newTriggerParameters)
        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.
        Specified by:
        setTriggerParameters in interface PrioritizeActivityTaskCmd
        Parameters:
        newTriggerParameters - The trigger parameters string.
      • setTriggerParameters

        public void setTriggerParameters(java.util.Map newTriggerParameters)
        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.
        Specified by:
        setTriggerParameters in interface PrioritizeActivityTaskCmd
        Parameters:
        newTriggerParameters - The trigger parameters string.
      • setPreviewReport

        public void setPreviewReport(java.util.List newPreviewReport)
        This method sets the list of information about the activity evaluation on the e-Marketing Spot.
        Specified by:
        setPreviewReport in interface PrioritizeActivityTaskCmd
        Parameters:
        newPreviewReport - A list of information about the activity evaluation on the e-Marketing Spot..
      • getRunCurrentTriggerListener

        public 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.
        Specified by:
        getRunCurrentTriggerListener in interface PrioritizeActivityTaskCmd
        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.
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        This method returns true.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Specified by:
        isReadyToCallExecute in class com.ibm.websphere.command.TargetableCommandImpl
        Returns:
        This method returns true.