com.ibm.commerce.tools.campaigns

Class CampaignInitiativeDetailsDataBean

  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.condition.ConditionConstants, com.ibm.commerce.security.Delegator, com.ibm.commerce.security.Protectable, CampaignConstants, java.io.Serializable


    public class CampaignInitiativeDetailsDataBean
    extends CampaignInitiativeDetailsDataBeanBase
    implements com.ibm.commerce.condition.ConditionConstants
    This class extends the CampaignInitiativeDataBean class to create a detailed data bean for a campaign initiative.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

        public static final java.lang.String FIND_CATENTRY_NAME
        Constant used to identify the method findNameByIdentifier is performing a search on catalog entry.
        See Also:
        Constant Field Values
      • FIND_CATGROUP_NAME

        public static final java.lang.String FIND_CATGROUP_NAME
        Constant used to identify the method findNameByIdentifier is performing a search on catalog group.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CampaignInitiativeDetailsDataBean

        public CampaignInitiativeDetailsDataBean()
    • Method Detail

      • getAvailableCollateral

        public java.util.Vector getAvailableCollateral()
        Gets the campaign initiative available general ad copies.
        Returns:
        The campaign initiative available general ad copies.
      • getAvailableDiscountCollateral

        public java.util.Vector getAvailableDiscountCollateral()
        Gets the campaign initiative available discount ad copies.
        Returns:
        The campaign initiative available discount ad copies.
      • getAvailableSegmentIds

        public java.util.Vector getAvailableSegmentIds()
        Gets the campaign initiative available segment IDs.
        Returns:
        The campaign initiative available segment IDs.
      • getAvailableSegments

        public java.util.Vector getAvailableSegments()
        Gets the campaign initiative available segments.
        Returns:
        The campaign initiative available segments.
      • getCampaignId

        public java.lang.Integer getCampaignId()
        Gets the campaign ID of the initiative.
        Overrides:
        getCampaignId in class CampaignInitiativeDataBean
        Returns:
        The campaign ID of the initiative.
      • getCampaignName

        public java.lang.String getCampaignName()
        Gets the campaign name of the initiative.
        Overrides:
        getCampaignName in class CampaignInitiativeDataBean
        Returns:
        The campaign name of the initiative.
      • getCategoryLanguageDescription

        public java.lang.String getCategoryLanguageDescription()
        Gets the campaign initiative category language description.
        Returns:
        The campaign initiative category language description.
      • getCurrency

        public java.lang.String getCurrency()
        Gets the currency used in this campaign initiative.
        Returns:
        The currency used in this campaign initiative.
      • getDaysOfTheWeek

        public java.util.Vector getDaysOfTheWeek()
        Gets the days of the week used in this campaign initiative WHEN condition.
        Returns:
        The days of the week used in this campaign initiative WHEN condition.
      • getDefaultLanguageId

        public java.lang.Integer getDefaultLanguageId()
        Gets the default language ID of the current store.
        Returns:
        The default language ID of the current store.
      • getDescription

        public java.lang.String getDescription()
        Gets the campaign initiative description.
        Overrides:
        getDescription in class CampaignInitiativeDataBean
        Returns:
        The campaign initiative description.
      • getDisabled

        public boolean getDisabled()
        Gets the campaign initiative disable flag.
        Overrides:
        getDisabled in class CampaignInitiativeDataBean
        Returns:
        True if this campaign initiative is disabled; false otherwise.
      • getEveryday

        public boolean getEveryday()
        Gets the everyday flag used in this campaign initiative WHEN condition.
        Returns:
        True if this campaign initiative is targeted everyday; false otherwise.
      • getId

        public java.lang.Integer getId()
        Gets the campaign initiative ID.
        Overrides:
        getId in class CampaignInitiativeDataBean
        Returns:
        The campaign initiative ID.
      • getLanguageId

        public java.lang.Integer getLanguageId()
        Gets the language ID used in this campaign initiative.
        Returns:
        The language ID used in this campaign initiative.
      • getLastUpdateDate

        public java.lang.Long getLastUpdateDate()
        Gets the campaign initiative last updated date.
        Overrides:
        getLastUpdateDate in class CampaignInitiativeDataBean
        Returns:
        The campaign initiative last updated date.
      • getLastUpdatedBy

        public java.lang.String getLastUpdatedBy()
        Gets the campaign initiative last updated user.
        Overrides:
        getLastUpdatedBy in class CampaignInitiativeDataBean
        Returns:
        The campaign initiative last updated user.
      • getProductAttributes

        public java.util.Vector getProductAttributes()
        Gets the product attributes used in this campaign initiative WHAT condition.
        Returns:
        The product attributes used in this campaign initiative WHAT condition.
      • getProductAttributesCGName

        public java.lang.String getProductAttributesCGName()
        Gets the product attributes name used in this campaign initiative WHAT condition.
        Returns:
        The product attributes name used in this campaign initiative WHAT condition.
      • getProductLanguageDescription

        public java.lang.String getProductLanguageDescription()
        Gets the description of the product language used in this campaign initiative WHAT condition.
        Returns:
        The description of the product language used in this campaign initiative WHAT condition.
      • getProductNames

        public java.util.Vector getProductNames()
        Gets the product names used in this campaign initiative WHAT condition.
        Returns:
        The product names used in this campaign initiative WHAT condition.
      • getProductSkus

        public java.util.Vector getProductSkus()
        Gets the product SKUs used in this campaign initiative WHAT condition.
        Returns:
        The product SKUs used in this campaign initiative WHAT condition.
      • getSelectedCategories

        public java.util.Vector getSelectedCategories()
        Gets the selected categories in this campaign initiative WHAT condition.
        Returns:
        The selected categories in this campaign initiative WHAT condition.
      • getSelectedCategoriesCGName

        public java.lang.String getSelectedCategoriesCGName()
        Gets the selected categories name in this campaign initiative WHAT condition.
        Returns:
        The selected categories name in this campaign initiative WHAT condition.
      • getSelectedCategoriesNames

        public java.util.Vector getSelectedCategoriesNames()
        Gets the selected categories' name in this campaign initiative WHAT condition.
        Returns:
        The selected categories' name in this campaign initiative WHAT condition.
      • getSelectedCollateral

        public java.util.Vector getSelectedCollateral()
        Gets the selected campaign initiative general ad copies.
        Returns:
        The selected campaign initiative general ad copies.
      • getSelectedDiscountCode

        public java.lang.String getSelectedDiscountCode()
        Gets the code of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
        Returns:
        The code of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
      • getSelectedDiscountCollateral

        public java.util.Vector getSelectedDiscountCollateral()
        Gets the selected campaign initiative discount ad copies.
        Returns:
        The selected campaign initiative discount ad copies.
      • getSelectedDiscountStoreId

        public java.lang.String getSelectedDiscountStoreId()
        Gets the ID of the store that owns the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
        Returns:
        The ID of the store that owns the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
      • getSelectedDiscountUsage

        public java.lang.String getSelectedDiscountUsage()
        Gets the details of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
        Returns:
        The details of the discount used in the selected discount ad copies in the campaign initiative WHAT condition.
      • getSelectedSegmentIds

        public java.util.Vector getSelectedSegmentIds()
        Gets the selected segment IDs in this campaign initiative WHO condition.
        Returns:
        The selected segment IDs in this campaign initiative WHO condition.
      • getSelectedSegments

        public java.util.Vector getSelectedSegments()
        Gets the selected segment IDs in this campaign initiative WHO condition.
        Returns:
        The selected segment IDs in this campaign initiative WHO condition.
      • getSellContentType

        public java.lang.String getSellContentType()
        Gets the campaign initiative content type for cross-sell and up-sell.
        Returns:
        The campaign initiative content type for cross-sell and up-sell.
      • getSellType

        public java.lang.Integer getSellType()
        Gets the campaign initiative sell type.
        Overrides:
        getSellType in class CampaignInitiativeDataBean
        Returns:
        The campaign initiative sell type.
      • getTargetAllShoppers

        public boolean getTargetAllShoppers()
        Gets the target all customers flag used in the campaign initiative WHO condition.
        Returns:
        true if this campaign initiative is targeted at all customers; false otherwise.
      • getWhatType

        public java.lang.String getWhatType()
        Gets the type of the campaign initiative WHAT condition.
        Returns:
        The type of the campaign initiative WHAT condition.
      • getWhenChoices

        public java.util.Vector getWhenChoices()
        Gets the choices of the campaign initiative WHICH condition.
        Returns:
        The choices of the campaign initiative WHICH condition.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean that includes all the data related to this campaign initiative.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class CampaignInitiativeDataBean
        Throws:
        java.lang.Exception - Thrown whenever an exception is encountered.
      • setCategoryLanguageDescription

        public void setCategoryLanguageDescription(java.lang.String newCategoryLanguageDescription)
        Sets the campaign initiative category language description.
        Parameters:
        newCategoryLanguageDescription - The campaign category language description.
      • setProductLanguageDescription

        public void setProductLanguageDescription(java.lang.String newProductLanguageDescription)
        Sets the campaign initiative product language description.
        Parameters:
        newProductLanguageDescription - The campaign product language description.
      • setXML

        public void setXML(java.util.Hashtable xml)
        Sets the XML.
        Overrides:
        setXML in class CampaignInitiativeDataBean
        Parameters:
        xml - The XML that describes this campaign initiative.