com.ibm.commerce.marketing.beans

Class EMarketingSpotBase

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.marketing.beans.EMarketingSpotBase
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable
    Direct Known Subclasses:
    EMarketingSpot

    public class EMarketingSpotBase
extends com.ibm.commerce.beans.SmartDataBeanImpl
    The base class for the e-Marketing Spot bean. This bean may be extended to provide different types of e-Marketing Spots.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      boolean useDialogMarketing
      Should the bean use dialog marketing campaigns and activities.

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

        emptyString

    • Constructor Summary

      Constructors 
      Constructor and Description
      EMarketingSpotBase()
      Constructor for EMarketingSpotBase.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getExperimentId()
      This method gets the ID of the experiment associated with the e-Marketing Spot.
      java.lang.Integer getId()
      Gets the ID of the e-Marketing Spot.
      com.ibm.commerce.marketing.facade.datatypes.MarketingSpotDataType getMarketingSpotData()
      This method returns the marketing spot data returned from the marketing runtime.
      java.lang.String getName()
      Gets the name of the e-Marketing Spot.
      java.lang.String getTestElementId()
      This method gets the ID of the test element associated with the experiment running on the e-Marketing Spot.
      void populate()
      Populates this data bean that represents the e-Marketing Spot on a store page.
      void setExperimentId(java.lang.String expId)
      This method sets the ID of the experiment associated with the e-Marketing Spot.
      void setName(java.lang.String name)
      Sets the name of the e-Marketing Spot.
      void setTestElementId(java.lang.String testElemId)
      This method sets the ID of the test element associated with the experiment running on the e-Marketing Spot.
      void setUseDialogMarketing(boolean newUDMFlag)
      Sets the flag to determine whether to use dialog marketing or not.

      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties

    • Field Detail

      • COPYRIGHT

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

      • useDialogMarketing

        public boolean useDialogMarketing
        Should the bean use dialog marketing campaigns and activities.

    • Constructor Detail

      • EMarketingSpotBase

        public EMarketingSpotBase()
        Constructor for EMarketingSpotBase.

    • Method Detail

      • getExperimentId

        public java.lang.String getExperimentId()
        This method gets the ID of the experiment associated with the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.
        Returns:
        The ID of the experiment associated with the e-Marketing Spot.

      • getId

        public java.lang.Integer getId()
        Gets the ID of the e-Marketing Spot.
        Returns:
        The ID of the e-Marketing Spot.

      • getMarketingSpotData

        public com.ibm.commerce.marketing.facade.datatypes.MarketingSpotDataType getMarketingSpotData()
        This method returns the marketing spot data returned from the marketing runtime. It contains the data to display in the eMarketing Spot.
        Returns:
        This method returns the marketing spot data returned from the marketing runtime.

      • getName

        public java.lang.String getName()
        Gets the name of the e-Marketing Spot.
        Returns:
        The name of the e-Marketing Spot.

      • getTestElementId

        public java.lang.String getTestElementId()
        This method gets the ID of the test element associated with the experiment running on the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.
        Returns:
        The ID of the test element associated with the experiment running on the e-Marketing Spot.

      • populate

        public void populate()
              throws java.lang.Exception
        Populates this data bean that represents the e-Marketing Spot on a store page.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception - Thrown when an error occurs during the population of this data bean.

      • setExperimentId

        public void setExperimentId(java.lang.String expId)
        This method sets the ID of the experiment associated with the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.
        Parameters:
        expId - The ID of the experiment associated with the e-Marketing Spot. This is determined by the CampaignsFilter.

      • setName

        public void setName(java.lang.String name)
        Sets the name of the e-Marketing Spot.
        Parameters:
        name - The name of the e-Marketing Spot.

      • setTestElementId

        public void setTestElementId(java.lang.String testElemId)
        This method sets the ID of the test element associated with the experiment running on the e-Marketing Spot. This method is used to help cache the CampaignInitiativeEvaluateCmd controller command, and the e-Marketing Spot JSP snippet.
        Parameters:
        testElemId - The ID of the test element associated with the experiment running on the e-Marketing Spot. If the test element is not yet determined, then do not call this method, or set the value to null.

      • setUseDialogMarketing

        public void setUseDialogMarketing(boolean newUDMFlag)
        Sets the flag to determine whether to use dialog marketing or not.
        Parameters:
        newUDMFlag - True if dialog marketing is to be used; false otherwise.
Skip navigation links