com.ibm.commerce.emarketing.beans

Class EmailActivitySummaryDataBean

  • 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 EmailActivitySummaryDataBean
extends EmailActivitySummaryDataBeanBase
    Used to gather summary information for an e-mail activity.
    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
      java.lang.String getCampaignName()
      Gets the campaign name to which the e-mail activity is associated.
      java.sql.Timestamp getDeliveryDate()
      Gets the time and date the activity will be delivered.
      java.lang.String getDescription()
      Gets the e-mail activity description.
      java.lang.Integer getId()
      Gets the ID of the e-mail activity.
      java.lang.Long getJobNum()
      Gets the scheduler job number associated with this activity.
      java.lang.Long getMemberGroupId()
      Gets the ID of the Customer Segment assigned to the activity.
      java.lang.String getMemberGroupName()
      Gets the name of the Customer Segment assigned to the activity.
      java.lang.Integer getMessageContentId()
      Gets the ID of the e-mail message assigned to the activity.
      java.lang.String getMessageContentName()
      Gets the name of the e-mail message assigned to the activity.
      java.lang.String getName()
      Gets the e-mail activity name.
      int getNumberOfAssumeReceived()
      Returns the number of recipients to whom this e-mail activity was assumed to be delivered to his/her mailbox.
      int getNumBounced()
      Gets the number of bounced back e-mails of the e-mail activity.
      int getNumClicked()
      Gets the number of click through e-mails of the e-mail activity.
      int getNumOpened()
      Gets the number of opened e-mails of the e-mail activity.
      java.lang.Long getOwner()
      Return the member reference number of the owner.
      double getPercentageAssumeReceived()
      Returns the percentage of recipients that have received e-mail activity.
      double getPercentageBounced()
      Returns the percentage of recipients for which a bounced message has been detected.
      double getPercentageClicked()
      Returns the percentage of recipients that have clicked on the e-mail activity.
      double getPercentageOpened()
      Returns the percentage of recipients that have opened the e-mail activity.
      java.lang.String getReplyTo()
      Gets the reply-to email address assigned to this email activity.
      java.lang.Integer getStatus()
      Gets the status of the e-mail activity.
      java.lang.Integer getTotalNumOfAttemptedUser()
      Gets the total number of attempted recipients of the e-mail activity.
      boolean isCustomerProfileExist()
      Checks whether the customer segment associated with the e-mail activity still exists.
      void populate()
      Populate the data bean.
      void setId(java.lang.Integer id)
      Sets the e-mail activity ID.

      • 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

      • EmailActivitySummaryDataBean

        public EmailActivitySummaryDataBean()

    • Method Detail

      • getCampaignName

        public java.lang.String getCampaignName()
        Gets the campaign name to which the e-mail activity is associated.
        Returns:
        The campaign name to which the e-mail activity is associated.

      • getDeliveryDate

        public java.sql.Timestamp getDeliveryDate()
        Gets the time and date the activity will be delivered.
        Returns:
        when the activity will be delivered.

      • getDescription

        public java.lang.String getDescription()
        Gets the e-mail activity description.
        Returns:
        The description of the e-mail activity.

      • getId

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

      • getJobNum

        public java.lang.Long getJobNum()
        Gets the scheduler job number associated with this activity.
        Returns:
        the scheduler job number.

      • getMemberGroupId

        public java.lang.Long getMemberGroupId()
        Gets the ID of the Customer Segment assigned to the activity.
        Returns:
        The ID of the Customer Segment assigned to the activity.

      • getMemberGroupName

        public java.lang.String getMemberGroupName()
        Gets the name of the Customer Segment assigned to the activity.
        Returns:
        The name of the Customer Segment assigned to the activity.

      • getMessageContentId

        public java.lang.Integer getMessageContentId()
        Gets the ID of the e-mail message assigned to the activity.
        Returns:
        The ID of the e-mail message assigned to the activity.

      • getMessageContentName

        public java.lang.String getMessageContentName()
        Gets the name of the e-mail message assigned to the activity.
        Returns:
        The name of the e-mail message assigned to the activity.

      • getName

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

      • getNumberOfAssumeReceived

        public int getNumberOfAssumeReceived()
        Returns the number of recipients to whom this e-mail activity was assumed to be delivered to his/her mailbox.
        Returns:
        The number of assume received recipients.

      • getNumBounced

        public int getNumBounced()
        Gets the number of bounced back e-mails of the e-mail activity.
        Returns:
        The number of bounce back e-mails of the e-mail activity.

      • getNumClicked

        public int getNumClicked()
        Gets the number of click through e-mails of the e-mail activity.
        Returns:
        The number of click through e-mail of the e-mail activity.

      • getNumOpened

        public int getNumOpened()
        Gets the number of opened e-mails of the e-mail activity.
        Returns:
        The number of opened e-mails of the e-mail activity.

      • getOwner

        public java.lang.Long getOwner()
                        throws java.lang.Exception
        Return the member reference number of the owner.
        Specified by:
        getOwner in interface com.ibm.commerce.security.Protectable
        Overrides:
        getOwner in class EmailActivitySummaryDataBeanBase
        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.

      • getPercentageAssumeReceived

        public double getPercentageAssumeReceived()
        Returns the percentage of recipients that have received e-mail activity.
        Returns:
        The percentage of assume received message.

      • getPercentageBounced

        public double getPercentageBounced()
        Returns the percentage of recipients for which a bounced message has been detected.
        Returns:
        The percentage of bounced message.

      • getPercentageClicked

        public double getPercentageClicked()
        Returns the percentage of recipients that have clicked on the e-mail activity.
        Returns:
        The percentage of clicks.

      • getPercentageOpened

        public double getPercentageOpened()
        Returns the percentage of recipients that have opened the e-mail activity.
        Returns:
        The percentage of openings.

      • getReplyTo

        public java.lang.String getReplyTo()
        Gets the reply-to email address assigned to this email activity.
        Returns:
        The reply-to address of the email activity.

      • getStatus

        public java.lang.Integer getStatus()
        Gets the status of the e-mail activity.
        Returns:
        The status of the e-mail activity.

      • getTotalNumOfAttemptedUser

        public java.lang.Integer getTotalNumOfAttemptedUser()
        Gets the total number of attempted recipients of the e-mail activity.
        Returns:
        The total number of attempted recipients of the e-mail activity.

      • isCustomerProfileExist

        public boolean isCustomerProfileExist()
        Checks whether the customer segment associated with the e-mail activity still exists.
        Returns:
        Returns true when the customer segment associated with the e-mail activity exists, returns false otherwise.

      • populate

        public void populate()
              throws java.lang.Exception
        Populate the data bean.
        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 any of the EmailPromotionMemberGroupRelationAccessBean, MemberGroupAccessBean, EmailRecipientEventsAccessBean, SchedulerConfigAccessBean, EmailPromotionRecipientsAccessBean or EmailPromotionAccessBean cannot be successfully called to retreive the data for this e-mail activity.

      • setId

        public void setId(java.lang.Integer id)
        Sets the e-mail activity ID.
        Parameters:
        id - The e-mail activity ID.
Skip navigation links