com.ibm.commerce.marketingcenter.events.util

Class ExperimentEventUtilities

  • java.lang.Object
    • com.ibm.commerce.marketingcenter.events.util.ExperimentEventUtilities


  • public class ExperimentEventUtilities
    extends java.lang.Object
    Utility methods to send an experiment logging event, serialize the logging data into the common base event, and retrieve the data from the common base event.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CLICKED
      Experiment Logging event data element constant in the common base event.
      static java.lang.String CONTROL
      Experiment Logging event data element constant in the common base event.
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String CUSTOM1
      Experiment Logging event data element constant in the common base event.
      static java.lang.String CUSTOM2
      Experiment Logging event data element constant in the common base event.
      static java.lang.String CUSTOM3
      Experiment Logging event data element constant in the common base event.
      static java.lang.String CUSTOM4
      Experiment Logging event data element constant in the common base event.
      static java.lang.String CUSTOM5
      Experiment Logging event data element constant in the common base event.
      static java.lang.String EXPERIMENT
      Experiment Logging event data element constant in the common base event.
      static java.lang.String EXPERIMENT_ID
      Experiment Logging event data element constant in the common base event.
      static java.lang.String EXPERIMENT_LOGGING_EVENT
      The experiment logging event name.
      static java.lang.String EXPERIMENT_NAME
      Experiment Logging event data element constant in the common base event.
      static java.lang.String EXPERIMENT_TYPE
      Experiment Logging event data element constant in the common base event.
      static java.lang.String FREQUENCY
      Experiment Logging event data element constant in the common base event.
      static java.lang.String RESULT_TYPE
      Experiment Logging event data element constant in the common base event.
      static java.lang.String RESULTS
      Experiment Logging event data element constant in the common base event.
      static java.lang.String SESSION
      Experiment Logging event data element constant in the common base event.
      static java.lang.String STORE_ID
      Experiment Logging event data element constant in the common base event.
      static java.lang.String TESTELEMENT_ID
      Experiment Logging event data element constant in the common base event.
      static java.lang.String TESTELEMENT_NAME
      Experiment Logging event data element constant in the common base event.
      static java.lang.String VIEWED
      Experiment Logging event data element constant in the common base event.
    • Field Detail

      • CLICKED

        public static final java.lang.String CLICKED
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • CONTROL

        public static final java.lang.String CONTROL
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • COPYRIGHT

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

        public static final java.lang.String CUSTOM1
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • CUSTOM2

        public static final java.lang.String CUSTOM2
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • CUSTOM3

        public static final java.lang.String CUSTOM3
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • CUSTOM4

        public static final java.lang.String CUSTOM4
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • CUSTOM5

        public static final java.lang.String CUSTOM5
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • EXPERIMENT

        public static final java.lang.String EXPERIMENT
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • EXPERIMENT_ID

        public static final java.lang.String EXPERIMENT_ID
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • EXPERIMENT_LOGGING_EVENT

        public static final java.lang.String EXPERIMENT_LOGGING_EVENT
        The experiment logging event name. There is an event container and an event factory with this name.
        See Also:
        Constant Field Values
      • EXPERIMENT_NAME

        public static final java.lang.String EXPERIMENT_NAME
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • EXPERIMENT_TYPE

        public static final java.lang.String EXPERIMENT_TYPE
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • FREQUENCY

        public static final java.lang.String FREQUENCY
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • RESULT_TYPE

        public static final java.lang.String RESULT_TYPE
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • RESULTS

        public static final java.lang.String RESULTS
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • SESSION

        public static final java.lang.String SESSION
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • STORE_ID

        public static final java.lang.String STORE_ID
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • TESTELEMENT_ID

        public static final java.lang.String TESTELEMENT_ID
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • TESTELEMENT_NAME

        public static final java.lang.String TESTELEMENT_NAME
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
      • VIEWED

        public static final java.lang.String VIEWED
        Experiment Logging event data element constant in the common base event.
        See Also:
        Constant Field Values
    • Method Detail

      • getExperimentLoggingData

        public static ExperimentLoggingDataBean getExperimentLoggingData(CommonBaseEvent cbe)
        Extracts the experiment logging data from the common base event.
        Parameters:
        cbe - The common base event.
        Returns:
        The experiment logging data that the event contains. If the event does not contain any experiment logging data, null will be returned.
      • sendExperimentLoggingEvent

        public static void sendExperimentLoggingEvent(ExperimentLoggingDataBean eldb)
        Sends an experiment logging event to the event infrastructure for processing. When the scheduled RaiseECEvent command runs, it will process the events, and forward them to the appropriate event listeners.
        Parameters:
        eldb - the experiment log data
      • sendExperimentLoggingEvent

        public static void sendExperimentLoggingEvent(ExperimentLoggingDataBean eldb,
                                                      com.ibm.commerce.command.CommandContext context)
        Sends an experiment logging event to the event infrastructure for processing. When the scheduled RaiseECEvent command runs, it will process the events, and forward them to the appropriate event listeners.
        Parameters:
        eldb - the experiment log data
        context - the command context
      • serializeExperiementLoggingData

        public static void serializeExperiementLoggingData(CommonBaseEvent cbe,
                                                           ExperimentLoggingDataBean expLogData)
        Serializes the experiment logging data and stores it in the common base event.
        Parameters:
        cbe - The common base event.
        expLogData - The experiment logging data.