com.ibm.commerce.emarketing.beans

Class EmailActivityListDataBean

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


    public class EmailActivityListDataBean
    extends EmailActivityListDataBeanBase
    Used to find all e-mail activities for a given store.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      Copyright.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      EmailActivityDataBean getEmailActivity(java.lang.String emailActivityId)
      Gets an e-mail activity for the given store as an EmailActivityDataBean.
      EmailActivityListEntry[] getEmailActivityList()
      Gets all e-mail activities for the given store as an array of EmailActivityEntry objects.
      void populate()
      Populates the databean.
      void setCampaignIdStr(java.lang.String campaignIdStr)
      Sets filter requirements, campaign ID, for the e-mail activity list
      • 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.security.Protectable

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

        getRequestProperties, setRequestProperties
    • Field Detail

    • Constructor Detail

      • EmailActivityListDataBean

        public EmailActivityListDataBean()
        Null argument constructor.
    • Method Detail

      • getEmailActivity

        public EmailActivityDataBean getEmailActivity(java.lang.String emailActivityId)
                                               throws java.lang.Exception
        Gets an e-mail activity for the given store as an EmailActivityDataBean.
        Parameters:
        emailActivityId - The ID of the desired e-mail activity.
        Returns:
        The EmailActivityDataBean representation of the e-mail activity.
        Throws:
        java.lang.Exception - thrown when the EmailActivityDataBean cannot be populated.
      • getEmailActivityList

        public EmailActivityListEntry[] getEmailActivityList()
        Gets all e-mail activities for the given store as an array of EmailActivityEntry objects.
        Returns:
        all e-mail activities for the given store.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the databean.
        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 the corresponding finder method in EmailPromotionAccessBean cannot successfully find the e-mail activities for the store.
      • setCampaignIdStr

        public void setCampaignIdStr(java.lang.String campaignIdStr)
        Sets filter requirements, campaign ID, for the e-mail activity list
        Parameters:
        campaignId - campaign ID