com.ibm.commerce.tools.campaigns

Class CampaignDataBean

  • 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, CampaignConstants, java.io.Serializable


    public class CampaignDataBean
    extends CampaignDataBeanBase
    implements CampaignConstants
    This class extends the SmartDataBeanImpl class to create a data bean for a campaign.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

      • CampaignDataBean

        public CampaignDataBean()
    • Method Detail

      • getCampaignInitiative

        public CampaignDataBean.CampaignInitiative[] getCampaignInitiative()
        Gets an array of all assigned initiatives to this campaign, represented by the CampaignInitiative inner class.
        Returns:
        An array of all assigned initiatives to this campaign.
      • getCampaignName

        public java.lang.String getCampaignName()
        Gets the campaign name.
        Returns:
        The name of the campaign.
      • getCampaignOwner

        public java.lang.String getCampaignOwner()
        Gets the campaign sponsor.
        Returns:
        The sponsor of the campaign.
      • getDescription

        public java.lang.String getDescription()
        Gets the campaign description.
        Returns:
        The description of the campaign.
      • getEmailActivity

        public CampaignDataBean.EmailActivity[] getEmailActivity()
        Gets an array of all assigned e-mail activities to this campaign, represented by the EmailActivity inner class.
        Returns:
        An array of all assigned e-mail activities to this campaign.
      • getId

        public java.lang.Integer getId()
        Gets the campaign ID.
        Returns:
        The ID of the campaign.
      • getLastUpdateDate

        public java.lang.Long getLastUpdateDate()
        Gets the campaign last updated date.
        Returns:
        The last updated date of the campaign.
      • getLastUpdatedBy

        public java.lang.String getLastUpdatedBy()
        Gets the campaign last updated user.
        Returns:
        The last updated user of the campaign.
      • getNumberOfInitiative

        public java.lang.Integer getNumberOfInitiative()
        Gets the number of assigned initiative to this campaign.
        Returns:
        The number of assigned initiative to this campaign.
      • getObjective

        public java.lang.String getObjective()
        Gets the campaign business objective.
        Returns:
        The business objective of the campaign.
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        Returns the member reference number of the owner.
        Specified by:
        getOwner in interface com.ibm.commerce.security.Protectable
        Overrides:
        getOwner in class CampaignDataBeanBase
        Returns:
        the member ID of the of the owner.
        Throws:
        java.lang.Exception - thrown when the owner's member ID cannot be retrieved through the StoreAccessBean.
        See Also:
        Protectable.getOwner()
      • getStoreId

        public java.lang.Integer getStoreId()
        Gets the ID of the store which this campaign belongs to.
        Returns:
        The ID of the store which this campaign belongs to.
      • populate

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

        public void setId(java.lang.Integer id)
        Sets the campaign ID.
        Parameters:
        id - The campaign ID.
      • setXML

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