com.ibm.commerce.marketingcenter.events.databeans

Class ExperimentResultsListDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.marketingcenter.events.databeans.ExperimentResultsListDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, java.io.Serializable


    public class ExperimentResultsListDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    implements com.ibm.commerce.security.Protectable, com.ibm.commerce.security.Delegator
    This data bean gets the statistics for an experiment.

    When customizing the experiment statistics, this class needs to be extended to return the custom statistics information from the EXPSTATS table.

    1. Extend ExperimentResultsListDataBean and override the following methods:
      1. StringBuffer addCustomDataToExpstatsQuery(StringBuffer sb)
        Loads the custom fields from the EXPSTATS table.
      2. ExperimentCustomResultDataBean populateCustomDataBean(ResultSet, int)
        Populates the extended ExperimentCustomResultDataBean.
      3. ExperimentCustomResultDataBean getCustomDataBean()
        Returns an empty instance of the extended ExperimentCustomResultDataBean.
    2. Extend ExperimentCustomResultDataBean to add getters and setters for the custom data.
    3. Change the experiment report JSP to use the extended ExperimentResultsListDataBean and display data from the extended ExperimentCustomResultDataBean
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Constructor Summary

      Constructors 
      Constructor and Description
      ExperimentResultsListDataBean()
      This method constructs an ExperimentResultsListDataBean and calls the superclass constructor, then sets the value if tracing is enabled for the marketing component.
      ExperimentResultsListDataBean(java.lang.Integer experimentId, java.lang.Integer storeId)
      This method constructs an ExperimentResultsListDataBean and sets the values specified by its parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      This method gets the current command's context.
      ExperimentResultDataBean getControlElementResult()
      This method gets the statistics for the control test element.
      ExperimentCustomResultDataBean getCustomControlElementResult()
      This method gets the custom statistics for the control test element.
      ExperimentCustomResultDataBean[] getCustomTestElementResults()
      This method gets the custom statistics for the test elements, not including the control test element.
      com.ibm.commerce.security.Protectable getDelegate()
      This method retrieves the bean's delegatee.
      java.lang.String getExperimentId()
      This method gets the experiment ID.
      java.lang.Long getOwner()
      This method returns the member ID of the owner of the store in which the experiment runs.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      This method gets the request properties.
      java.lang.String getStoreId()
      This method gets the store ID.
      ExperimentResultDataBean[] getTestElementResults()
      This method gets the statistics for the test elements, not including the control test element.
      void populate()
      This method gets the statistics for an experiment.
      void runQuery()
      This method constructs and runs the database query to get the experiment statistics.
      void setCommandContext(com.ibm.commerce.command.CommandContext newICommandContext)
      This method sets the command context.
      void setExperimentId(java.lang.Integer experimentId)
      This method sets the experiment ID.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
      This method sets the request properties.
      void setStoreId(java.lang.Integer storeId)
      This method sets the store ID.
      void setTestData(com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition data)
      Reserved for IBM internal use.
      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.security.Protectable

        fulfills
    • Constructor Detail

      • ExperimentResultsListDataBean

        public ExperimentResultsListDataBean()
        This method constructs an ExperimentResultsListDataBean and calls the superclass constructor, then sets the value if tracing is enabled for the marketing component.
      • ExperimentResultsListDataBean

        public ExperimentResultsListDataBean(java.lang.Integer experimentId,
                                             java.lang.Integer storeId)
        This method constructs an ExperimentResultsListDataBean and sets the values specified by its parameters.
        Parameters:
        experimentId - The experiment ID for which this databean lists statistics.
        storeId - The store ID in which the experiment runs.
    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        This method gets the current command's context.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        getCommandContext in class com.ibm.commerce.beans.SmartDataBeanImpl
        Returns:
        The command context.
      • getControlElementResult

        public ExperimentResultDataBean getControlElementResult()
        This method gets the statistics for the control test element.
        Returns:
        The ExperimentResultDataBean containing the control test element statistics.
      • getCustomControlElementResult

        public ExperimentCustomResultDataBean getCustomControlElementResult()
        This method gets the custom statistics for the control test element.
        Returns:
        The ExperimentCustomResultDataBean containing the control test element custom statistics.
      • getCustomTestElementResults

        public ExperimentCustomResultDataBean[] getCustomTestElementResults()
        This method gets the custom statistics for the test elements, not including the control test element.
        Returns:
        An array containing the set of ExperimentCustomResultDataBeans containing the test element custom statistics.
      • getDelegate

        public com.ibm.commerce.security.Protectable getDelegate()
                                                          throws java.lang.Exception
        This method retrieves the bean's delegatee.
        Specified by:
        getDelegate in interface com.ibm.commerce.security.Delegator
        Returns:
        the com.ibm.commerce.accesscontrol.policymanager.Protectable object
        Throws:
        java.lang.Exception
        See Also:
        Delegator.getDelegate()
      • getExperimentId

        public java.lang.String getExperimentId()
        This method gets the experiment ID.
        Returns:
        The experiment ID.
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        This method returns the member ID of the owner of the store in which the experiment runs.
        Specified by:
        getOwner in interface com.ibm.commerce.security.Protectable
        Returns:
        The member ID of the owner.
        Throws:
        java.lang.Exception
        See Also:
        Protectable.getOwner()
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        This method gets the request properties.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Overrides:
        getRequestProperties in class com.ibm.commerce.beans.InputDataBeanImpl
        Returns:
        The request properties.
      • getStoreId

        public java.lang.String getStoreId()
        This method gets the store ID.
        Returns:
        The store ID.
      • getTestElementResults

        public ExperimentResultDataBean[] getTestElementResults()
        This method gets the statistics for the test elements, not including the control test element.
        Returns:
        An array containing the set of ExperimentResultDataBeans containing the test element statistics.
      • populate

        public void populate()
                      throws java.lang.Exception
        This method gets the statistics for an experiment.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception
        See Also:
        runQuery()
      • runQuery

        public void runQuery()
                      throws java.lang.Exception
        This method constructs and runs the database query to get the experiment statistics.
        Throws:
        Exception
        java.lang.Exception
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext newICommandContext)
        This method sets the command context.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        setCommandContext in class com.ibm.commerce.beans.SmartDataBeanImpl
        Parameters:
        newICommandContext - The command context.
      • setExperimentId

        public void setExperimentId(java.lang.Integer experimentId)
        This method sets the experiment ID.
        Parameters:
        experimentId - The experiment ID.
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
        This method sets the request properties.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Overrides:
        setRequestProperties in class com.ibm.commerce.beans.InputDataBeanImpl
        Parameters:
        param - The request properties.
      • setStoreId

        public void setStoreId(java.lang.Integer storeId)
        This method sets the store ID.
        Parameters:
        storeId - The store ID.
      • setTestData

        public void setTestData(com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition data)
        Reserved for IBM internal use.
        Parameters:
        data - Reserved for IBM internal use.