com.ibm.commerce.tools.experimentation.beans

Class ExperimentDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, com.ibm.commerce.tools.experimentation.ExperimentConstants, java.io.Serializable


    public class ExperimentDataBean
    extends com.ibm.commerce.tools.experimentation.beansrc.ExperimentDataBeanBase
    implements com.ibm.commerce.tools.experimentation.ExperimentConstants
    This class provides access to all of the data related to an experiment in the database. It takes either an experiment ID or an XML document that represents all of the experiment data, populates this data bean object, and used in a JSP to display the data.

    This bean extends com.ibm.commerce.beans.SmartDataBeanImpl which provides access to common methods that are used to activate this bean, and access command context and request properties.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      • Fields inherited from interface com.ibm.commerce.tools.experimentation.ExperimentConstants

        ELEMENT_EXPERIMENT, EXPERIMENT_ID_DELIMITER, EXPERIMENT_RESOURCES, EXPERIMENT_RESULT_SCOPE_LIFETIME, EXPERIMENT_RESULT_SCOPE_REQUEST, EXPERIMENT_RESULT_SCOPE_SESSION, EXPERIMENT_STATUS_ACTIVE, EXPERIMENT_STATUS_COMPLETED, EXPERIMENT_STATUS_DELETED, EXPERIMENT_STATUS_EXPIRED, EXPERIMENT_STATUS_INACTIVE, FRIDAY, MONDAY, MSG_BUTTON_ACTIVATE, MSG_BUTTON_ADD, MSG_BUTTON_ADD_NO_ELLIPSIS, MSG_BUTTON_BACK, MSG_BUTTON_CAMPAIGNS, MSG_BUTTON_CANCEL, MSG_BUTTON_CHANGE, MSG_BUTTON_CHANGE_INITIATIVE, MSG_BUTTON_CHANGE_INITIATIVE_ELLIPSIS, MSG_BUTTON_CHOOSE_COUPON, MSG_BUTTON_CHOOSE_DISCOUNT, MSG_BUTTON_CLEAR, MSG_BUTTON_CLOSE, MSG_BUTTON_CONFIRM, MSG_BUTTON_COPY, MSG_BUTTON_DEACTIVATE, MSG_BUTTON_DELETE, MSG_BUTTON_FIND, MSG_BUTTON_FIND_ELLIPSIS, MSG_BUTTON_HELP, MSG_BUTTON_LIST, MSG_BUTTON_LIST_ELLIPSIS, MSG_BUTTON_NEW, MSG_BUTTON_OK, MSG_BUTTON_PREVIEW, MSG_BUTTON_PRINT, MSG_BUTTON_PRIORITIZE, MSG_BUTTON_PROPERTIES, MSG_BUTTON_REMOVE, MSG_BUTTON_REPORTS, MSG_BUTTON_RESUME, MSG_BUTTON_SCHEDULE, MSG_BUTTON_STATISTICS, MSG_BUTTON_SUMMARY, MSG_BUTTON_SUSPEND, MSG_DAY_PROMPT, MSG_EXPERIMENT_EVALUATION_FAILED, MSG_EXPERIMENT_EXISTS, MSG_EXPERIMENT_NOT_SAVED, MSG_EXPERIMENT_SAVED, MSG_MONTH_PROMPT, MSG_NEVER, MSG_TIME_PROMPT, MSG_YEAR_PROMPT, ORDER_BY_CODE, ORDER_BY_DESCRIPTION, ORDER_BY_DISPLAYS, ORDER_BY_END_DATE, ORDER_BY_LAST_UPDATE, ORDER_BY_LAST_UPDATED_BY, ORDER_BY_NAME, ORDER_BY_PRIORITY, ORDER_BY_START_DATE, ORDER_BY_STATUS, ORDER_BY_TYPE, ORDER_BY_VIEWS, PARAMETER_CURRENT_TIME, PARAMETER_EXPERIMENT_COMPLETE_STATUS, PARAMETER_EXPERIMENT_DELETED, PARAMETER_EXPERIMENT_ID, PARAMETER_EXPERIMENT_ID_INVALID, PARAMETER_EXPERIMENT_IDS, PARAMETER_EXPERIMENT_NOT_DELETED, PARAMETER_EXPERIMENT_STATUS, PARAMETER_EXPERIMENT_STATUS_NOT_UPDATED, PARAMETER_EXPERIMENT_STATUS_UPDATED, PARAMETER_ORDER_BY, PARAMETER_PREFERRED_ELEMENT_ID, PARAMETER_STORE_ELEMENT_ID, PARAMETER_STORE_ELEMENT_TYPE_ID, PARAMETER_STORE_ID, SATURDAY, SEARCH_TYPE_EXACT_MATCH, SEARCH_TYPE_LIKE_CASE_SENSITIVE, SEARCH_TYPE_LIKE_IGNORE_CASE, SEARCH_TYPE_MATCH_CASE_SENSITIVE, SEARCH_TYPE_MATCH_IGNORE_CASE, SUNDAY, THURSDAY, TIMESTAMP_END_OF_TIME, TUESDAY, URL_EXPERIMENT_COMPLETE_REDIRECT_VIEW, URL_EXPERIMENT_DELETE_REDIRECT_VIEW, URL_EXPERIMENT_STATUS_UPDATE_REDIRECT_VIEW, WEDNESDAY
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getDescription()
      This method returns the description of the experiment.
      java.sql.Timestamp getEndDate()
      This method returns the end date of the experiment.
      java.lang.String getEndDay()
      This method returns the day value of the end date of the experiment.
      java.lang.String getEndMonth()
      This method returns the month value of the end date of the experiment.
      java.lang.String getEndTime()
      This method returns the time value of the end date of the experiment.
      java.lang.String getEndYear()
      This method returns the year value of the end date of the experiment.
      java.lang.String getExperimentName()
      This method returns the name of the experiment.
      java.lang.Integer getExpireCount()
      This method returns the expire count of the experiment, which is used to determine the number of customers to display the experiment to before the experiment expires.
      java.lang.Integer getId()
      This method returns the ID of the experiment.
      java.sql.Timestamp getLastUpdateDate()
      This method returns the date on which the experiment was last updated.
      java.lang.String getLastUpdatedBy()
      This method returns the logon ID of the user who last updated the experiment.
      java.lang.Short getPreferredElement()
      This method returns the preferred element of the experiment.
      java.lang.Short getPriority()
      This method returns the priority of the experiment.
      java.lang.String getResultScope()
      This method returns the result scope of the experiment.
      ExperimentRuleDefinition getRuleDefinition()
      This method returns the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.
      java.lang.String getRuleXml()
      This method returns the XML which describes the rule of the experiment.
      java.sql.Timestamp getStartDate()
      This method returns the start date of the experiment.
      java.lang.String getStartDay()
      This method returns the day value of the start date of the experiment.
      java.lang.String getStartMonth()
      This method returns the month value of the start date of the experiment.
      java.lang.String getStartTime()
      This method returns the time value of the start date of the experiment.
      java.lang.String getStartYear()
      This method returns the year value of the start date of the experiment.
      java.lang.String getStatus()
      This method returns the status of the experiment.
      java.lang.Integer getStoreElementTypeId()
      This method returns the ID of the type to which the store element selected in the experiment is assigned.
      java.lang.String getStoreElementTypeName()
      This method returns the name of the type to which the store element selected in the experiment is assigned.
      java.lang.Integer getStoreId()
      This method returns the ID of the store to which this experiment belongs.
      void populate()
      Populates the data bean that includes all of the data related to this experiment.
      void setId(java.lang.Integer id)
      This method sets the ID of this experiment.
      void setXML(java.util.Hashtable xml)
      This method sets the XML document which describes this experiment.
      • Methods inherited from class com.ibm.commerce.tools.experimentation.beansrc.ExperimentDataBeanBase

        getDelegate, getOwner
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • COPYRIGHT

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

      • ExperimentDataBean

        public ExperimentDataBean()
    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        This method returns the description of the experiment.
        Returns:
        The description of the experiment.
      • getEndDate

        public java.sql.Timestamp getEndDate()
        This method returns the end date of the experiment.
        Returns:
        The end date of the experiment.
      • getEndDay

        public java.lang.String getEndDay()
        This method returns the day value of the end date of the experiment.
        Returns:
        The day value of the end date of the experiment.
      • getEndMonth

        public java.lang.String getEndMonth()
        This method returns the month value of the end date of the experiment.
        Returns:
        The month value of the end date of the experiment.
      • getEndTime

        public java.lang.String getEndTime()
        This method returns the time value of the end date of the experiment.
        Returns:
        The time value of the end date of the experiment.
      • getEndYear

        public java.lang.String getEndYear()
        This method returns the year value of the end date of the experiment.
        Returns:
        The year value of the end date of the experiment.
      • getExpireCount

        public java.lang.Integer getExpireCount()
        This method returns the expire count of the experiment, which is used to determine the number of customers to display the experiment to before the experiment expires.
        Returns:
        The expire count of the experiment.
      • getId

        public java.lang.Integer getId()
        This method returns the ID of the experiment.
        Returns:
        The ID of the experiment.
      • getLastUpdateDate

        public java.sql.Timestamp getLastUpdateDate()
        This method returns the date on which the experiment was last updated.
        Returns:
        The date on which the experiment was last updated.
      • getLastUpdatedBy

        public java.lang.String getLastUpdatedBy()
        This method returns the logon ID of the user who last updated the experiment.
        Returns:
        The logon ID of the user who last updated the experiment.
      • getExperimentName

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

        public java.lang.Short getPreferredElement()
        This method returns the preferred element of the experiment.
        Returns:
        The preferred element of the experiment.
      • getPriority

        public java.lang.Short getPriority()
        This method returns the priority of the experiment.
        Returns:
        The priority of the experiment.
      • getResultScope

        public java.lang.String getResultScope()
        This method returns the result scope of the experiment.
        Returns:
        The result scope of the experiment.
      • getRuleDefinition

        public ExperimentRuleDefinition getRuleDefinition()
        This method returns the rule of the experiment represented by com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.
        Returns:
        The rule of the experiment represented by an instance of the com.ibm.commerce.tools.experimentation.ExperimentRuleDefinition class.
      • getRuleXml

        public java.lang.String getRuleXml()
        This method returns the XML which describes the rule of the experiment.
        Returns:
        The XML document that describes the rule of the experiment.
      • getStartDate

        public java.sql.Timestamp getStartDate()
        This method returns the start date of the experiment.
        Returns:
        The start date of the experiment.
      • getStartDay

        public java.lang.String getStartDay()
        This method returns the day value of the start date of the experiment.
        Returns:
        The day value of the start date of the experiment.
      • getStartMonth

        public java.lang.String getStartMonth()
        This method returns the month value of the start date of the experiment.
        Returns:
        The month value of the start date of the experiment.
      • getStartTime

        public java.lang.String getStartTime()
        This method returns the time value of the start date of the experiment.
        Returns:
        The time value of the start date of the experiment.
      • getStartYear

        public java.lang.String getStartYear()
        This method returns the year value of the start date of the experiment.
        Returns:
        The year value of the start date of the experiment.
      • getStatus

        public java.lang.String getStatus()
        This method returns the status of the experiment.
        Returns:
        The status of the experiment.
      • getStoreElementTypeId

        public java.lang.Integer getStoreElementTypeId()
        This method returns the ID of the type to which the store element selected in the experiment is assigned.
        Returns:
        The ID of the type to which the store element selected in the experiment is assigned.
      • getStoreElementTypeName

        public java.lang.String getStoreElementTypeName()
        This method returns the name of the type to which the store element selected in the experiment is assigned.
        Returns:
        The name of the type to which the store element selected in the experiment is assigned.
      • getStoreId

        public java.lang.Integer getStoreId()
        This method returns the ID of the store to which this experiment belongs.
        Returns:
        The ID of the store to which this experiment belongs.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean that includes all of the data related to this experiment.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown whenever an exception is encountered.
      • setId

        public void setId(java.lang.Integer id)
        This method sets the ID of this experiment.
        Parameters:
        id - The ID of experiment.
      • setXML

        public void setXML(java.util.Hashtable xml)
        This method sets the XML document which describes this experiment.
        Parameters:
        xml - The XML document which describes this experiment.