com.ibm.commerce.marketingcenter.events.databeans

Class ExperimentResultDataBean

  • java.lang.Object
    • com.ibm.commerce.marketingcenter.events.databeans.ExperimentResultDataBean


  • public class ExperimentResultDataBean
    extends java.lang.Object
    This data bean returns all the statistics associated with an experiment test element.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ExperimentResultDataBean()
      This constructor creates an ExperimentResultDataBean and does not set any values.
      ExperimentResultDataBean(java.lang.String experimentName, java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId, java.lang.String frequency, java.lang.String testElementName, boolean isControlTestElement, java.lang.Integer experimentTypeId)
      This construtor creates an ExperimentResultDataBean by calling the superclass constructor then setting the values specified by its parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getClickedAverageOrderAmount()
      This method gets the average total revenue of the orders associated with the test element being clicked.
      java.lang.String getClickedConversionRate()
      This method gets the conversion rate of the test element clicks.
      java.lang.String getClickedTotalOrderAmount()
      This method gets the total of the orders associated with the test element being clicked.
      java.lang.String getClickOrders()
      This method gets the number of orders associated with the test element being clicked.
      java.lang.String getClickRatio()
      This methog gets the click ratio of the test element.
      java.lang.String getClicks()
      This method gets the number of times the test element has been clicked.
      java.lang.String getCurrency()
      This method gets the currency of the orders associated with the test element.
      java.lang.String getDisplayAverageOrderAmount()
      This method gets the average total revenue of the orders associated with the test element being displayed.
      java.lang.String getDisplayConversionRate()
      This method gets the conversion rate of the test element displays.
      java.lang.String getDisplayFrequency()
      This method gets the display frequency of the test element.
      java.lang.String getDisplayOrders()
      This method gets the number of orders associated with the test element displayed.
      java.lang.String getDisplays()
      This method gets the number of times the test element displayed.
      java.lang.String getDisplayTotalOrderAmount()
      This element gets the total revenue of the orders associated with the test element being displayed.
      java.lang.String getExperimentId()
      This method gets the experiment ID.
      java.lang.String getExperimentName()
      This method gets the name of the experiment.
      java.lang.String getExperimentTypeId()
      This method gets the type of the experiment.
      boolean getIsControlTestElement()
      This method returns the value that specifies whether or not this test element is the control test element.
      java.lang.String getStoreId()
      This method gets the store ID.
      java.lang.String getTestElementId()
      This method gets the test element ID.
      java.lang.String getTestElementName()
      This method gets the test element name.
      void setClickData(java.lang.Integer clicks, java.lang.Integer clickOrders, java.math.BigDecimal clickRevenue)
      This method sets the data associated with the test element being clicked by the user.
      void setClickedTotalOrderAmount(java.math.BigDecimal c)
      This method sets the total of the orders associated with the test element being clicked.
      void setClickOrders(java.lang.Integer c)
      This method sets the number of orders associated with the test element being clicked.
      void setClicks(java.lang.Integer c)
      This method sets the number of times the test element has been clicked.
      void setCurrency(java.lang.String c)
      This method sets the currency of the orders associated with the test element.
      void setDisplayData(java.lang.Integer displays, java.lang.Integer displayOrders, java.math.BigDecimal displayRevenue, java.lang.String currency)
      This method sets the data associated with test element being displayed.
      void setDisplayFrequency(java.lang.String freq)
      This method sets the display frequency of the test element.
      void setDisplayOrders(java.lang.Integer d)
      This method sets the number of orders associated with the test element being displayed.
      void setDisplays(java.lang.Integer d)
      This method sets the number of times the test element has been displayed.
      void setDisplayTotalOrderAmount(java.math.BigDecimal d)
      This method sets the total of the orders associated with the test element being displayed.
      void setExperimentData(java.lang.String experimentName, java.lang.Integer experimentId, java.lang.Integer testElementId, java.lang.Integer storeId, java.lang.String frequency, java.lang.String testElementName, boolean isControlTestElement, java.lang.Integer experimentTypeId)
      This method sets the experiment data.
      void setExperimentId(java.lang.Integer id)
      This value sets the experiment ID.
      void setExperimentName(java.lang.String name)
      This value sets the name of the experiment.
      void setExperimentTypeId(java.lang.Integer id)
      This method sets the type of the experiment.
      void setIsControlTestElement(boolean b)
      This method sets the value that specifies whether or not this test element is the control test element.
      void setStoreId(java.lang.Integer id)
      This method sets the store ID.
      void setTestElementId(java.lang.Integer id)
      This method sets the test element ID.
      void setTestElementName(java.lang.String name)
      This method sets the test element name.
      java.lang.String toString()
      This method gets the string respresentation of this data bean.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ExperimentResultDataBean

        public ExperimentResultDataBean()
        This constructor creates an ExperimentResultDataBean and does not set any values.
      • ExperimentResultDataBean

        public ExperimentResultDataBean(java.lang.String experimentName,
                                        java.lang.Integer experimentId,
                                        java.lang.Integer testElementId,
                                        java.lang.Integer storeId,
                                        java.lang.String frequency,
                                        java.lang.String testElementName,
                                        boolean isControlTestElement,
                                        java.lang.Integer experimentTypeId)
        This construtor creates an ExperimentResultDataBean by calling the superclass constructor then setting the values specified by its parameters.
        Parameters:
        experimentName - The experiment name.
        experimentId - The experiment ID.
        testElementId - The test element ID.
        storeId - The store ID.
        frequency - The display frequency of the test element.
        testElementName - The test element name.
        isControlTestElement - '1' if the test element is the control test element, '0' otherwise.
        experimentTypeId - The experiment type ID.
    • Method Detail

      • getClickedAverageOrderAmount

        public java.lang.String getClickedAverageOrderAmount()
        This method gets the average total revenue of the orders associated with the test element being clicked. This value is the total revenue of the orders divided by the number of orders.
        Returns:
        The average total revenue of the orders associated with the test element being clicked.
      • getClickedConversionRate

        public java.lang.String getClickedConversionRate()
        This method gets the conversion rate of the test element clicks. This value is the number of orders divided by the number of clicks of the test element.
        Returns:
        The conversion rate of the test element clicks.
      • getClickedTotalOrderAmount

        public java.lang.String getClickedTotalOrderAmount()
        This method gets the total of the orders associated with the test element being clicked.
        Returns:
        The total of the orders associated with the test element being clicked.
      • getClickOrders

        public java.lang.String getClickOrders()
        This method gets the number of orders associated with the test element being clicked.
        Returns:
        The number of orders associated with the test element being clicked.
      • getClickRatio

        public java.lang.String getClickRatio()
        This methog gets the click ratio of the test element. This value is the number of clicks divided by the number of times the test element was displayed.
        Returns:
        The click ratio of the test element.
      • getClicks

        public java.lang.String getClicks()
        This method gets the number of times the test element has been clicked.
        Returns:
        The number of times the test element has been clicked.
      • getCurrency

        public java.lang.String getCurrency()
        This method gets the currency of the orders associated with the test element. This value is the store's default currency.
        Returns:
        The currency of the orders associated with the test element.
      • getDisplayAverageOrderAmount

        public java.lang.String getDisplayAverageOrderAmount()
        This method gets the average total revenue of the orders associated with the test element being displayed. This value is the total revenue of the orders divided by the number of orders.
        Returns:
        The average total revenue of the orders associated with the test element being displayed.
      • getDisplayConversionRate

        public java.lang.String getDisplayConversionRate()
        This method gets the conversion rate of the test element displays. This value is the number of orders divided by the number of displays of the test element.
        Returns:
        The conversion rate of the test element displays.
      • getDisplayFrequency

        public java.lang.String getDisplayFrequency()
        This method gets the display frequency of the test element.
        Returns:
        The display frequency of the test element.
      • getDisplayOrders

        public java.lang.String getDisplayOrders()
        This method gets the number of orders associated with the test element displayed.
        Returns:
        The number of orders associated with the test element displayed.
      • getDisplays

        public java.lang.String getDisplays()
        This method gets the number of times the test element displayed.
        Returns:
        The number of times the test element displayed.
      • getDisplayTotalOrderAmount

        public java.lang.String getDisplayTotalOrderAmount()
        This element gets the total revenue of the orders associated with the test element being displayed.
        Returns:
        The total revenue of the orders associated with the test element being displayed.
      • getExperimentId

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

        public java.lang.String getExperimentName()
        This method gets the name of the experiment.
        Returns:
        The name of the experiment.
      • getExperimentTypeId

        public java.lang.String getExperimentTypeId()
        This method gets the type of the experiment.
        Returns:
        The experiment type ID.
      • getIsControlTestElement

        public boolean getIsControlTestElement()
        This method returns the value that specifies whether or not this test element is the control test element.
        Returns:
        True if the test element is the control test element; false otherwise.
      • getStoreId

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

        public java.lang.String getTestElementId()
        This method gets the test element ID.
        Returns:
        The ID of the test element.
      • getTestElementName

        public java.lang.String getTestElementName()
        This method gets the test element name.
        Returns:
        The name of the test element.
      • setClickData

        public void setClickData(java.lang.Integer clicks,
                                 java.lang.Integer clickOrders,
                                 java.math.BigDecimal clickRevenue)
        This method sets the data associated with the test element being clicked by the user.
        Parameters:
        clicks - The number of times the test element was clicked.
        clickOrders - The number of orders associated with the test element being clicked.
        clickRevenue - The total revenue of the orders associated with the test element being clicked.
      • setClickedTotalOrderAmount

        public void setClickedTotalOrderAmount(java.math.BigDecimal c)
        This method sets the total of the orders associated with the test element being clicked.
        Parameters:
        c - The total of the orders associated with the test element being clicked.
      • setClickOrders

        public void setClickOrders(java.lang.Integer c)
        This method sets the number of orders associated with the test element being clicked.
        Parameters:
        c - The number of orders associated with the test element being clicked.
      • setClicks

        public void setClicks(java.lang.Integer c)
        This method sets the number of times the test element has been clicked.
        Parameters:
        c - The number of times the test element has been clicked.
      • setCurrency

        public void setCurrency(java.lang.String c)
        This method sets the currency of the orders associated with the test element. This value is the store's default currency.
        Parameters:
        c - The currency of the orders associated with the test element.
      • setDisplayData

        public void setDisplayData(java.lang.Integer displays,
                                   java.lang.Integer displayOrders,
                                   java.math.BigDecimal displayRevenue,
                                   java.lang.String currency)
        This method sets the data associated with test element being displayed.
        Parameters:
        displays - The number of times the test element is displayed.
        displayOrders - The number of orders associated with the test element being displayed.
        displayRevenue - The total revenue of the orders associated with the test element being displayed.
        currency - The currency of the total of the orders associated with the test element being displayed.
      • setDisplayFrequency

        public void setDisplayFrequency(java.lang.String freq)
        This method sets the display frequency of the test element.
        Parameters:
        freq - The display frequency of the test element.
      • setDisplayOrders

        public void setDisplayOrders(java.lang.Integer d)
        This method sets the number of orders associated with the test element being displayed.
        Parameters:
        d - The number of orders associated with the test element being displayed.
      • setDisplays

        public void setDisplays(java.lang.Integer d)
        This method sets the number of times the test element has been displayed.
        Parameters:
        d - The number of times the test element has been displayed.
      • setDisplayTotalOrderAmount

        public void setDisplayTotalOrderAmount(java.math.BigDecimal d)
        This method sets the total of the orders associated with the test element being displayed.
        Parameters:
        d - The total of the orders associated with the test element being displayed.
      • setExperimentData

        public void setExperimentData(java.lang.String experimentName,
                                      java.lang.Integer experimentId,
                                      java.lang.Integer testElementId,
                                      java.lang.Integer storeId,
                                      java.lang.String frequency,
                                      java.lang.String testElementName,
                                      boolean isControlTestElement,
                                      java.lang.Integer experimentTypeId)
        This method sets the experiment data.
        Parameters:
        experimentName - The experiment name.
        experimentId - The experiment ID.
        testElementId - The test element ID.
        storeId - The store ID.
        frequency - The display frequency of the test element.
        testElementName - The test element name.
        isControlTestElement - '1' if the test element is the control test element, '0' otherwise.
        experimentTypeId - The experiment type ID.
      • setExperimentId

        public void setExperimentId(java.lang.Integer id)
        This value sets the experiment ID.
        Parameters:
        id - The ID of the experiment.
      • setExperimentName

        public void setExperimentName(java.lang.String name)
        This value sets the name of the experiment.
        Parameters:
        name - The name of the experiment.
      • setExperimentTypeId

        public void setExperimentTypeId(java.lang.Integer id)
        This method sets the type of the experiment.
        Parameters:
        id - The experiment type ID.
      • setIsControlTestElement

        public void setIsControlTestElement(boolean b)
        This method sets the value that specifies whether or not this test element is the control test element.
        Parameters:
        b - True is this test element the control test element, false otherwise.
      • setStoreId

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

        public void setTestElementId(java.lang.Integer id)
        This method sets the test element ID.
        Parameters:
        id - The ID of the test element.
      • setTestElementName

        public void setTestElementName(java.lang.String name)
        This method sets the test element name.
        Parameters:
        name - The name of the test element.
      • toString

        public java.lang.String toString()
        This method gets the string respresentation of this data bean.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string respresentation of this data bean.