com.ibm.commerce.emarketing.utils
Class EmailActivitySummary

java.lang.Object
  |
  +--com.ibm.commerce.emarketing.utils.EmailActivitySummary

public class EmailActivitySummary
extends java.lang.Object

Provides summary information for a given e-mail activity.


Constructor Summary
EmailActivitySummary(int activityId, java.lang.String name, java.lang.String description, java.lang.String emailTemplateName, java.lang.String customerProfileName, int numOfRecipients, int numOfBounced, int numOfClicked, int numOfOpened)
          Constructor.
 
Method Summary
 int getActivityId()
          Returns the activityId of the e-mail activity upon which the summary is based.
 java.lang.String getCustomerProfileName()
          Returns the name of the customer profile that is part of the e-mail activity upon which the summary is based.
 java.lang.String getDescription()
          Returns the description of the e-mail activity upon which the summary is based.
 java.lang.String getEmailTemplateName()
          Returns the name of the e-mail template that is part of the e-mail activity upon which the summary is based.
 java.lang.String getName()
          Returns the name of the e-mail activity upon which the summary is based.
 int getNumberOfAssumeReceived()
          Returns the number of recipients to whom this e-mail activity was assumed to be delivered to his/her mailbox.
 int getNumberOfBounced()
          Returns the number of bounced message that have resulted from sending this e-mail activity.
 int getNumberOfClicked()
          Returns the number of recipients that have clicked this e-mail activity.
 int getNumberOfOpened()
          Returns the number of recipients that have opened this e-mail activity.
 int getNumberOfRecipients()
          Returns the number of recipients to whom this e-mail activity was attempted to be sent.
 double getPercentageAssumeReceived()
          Returns the percentage of recipients that have recieved 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmailActivitySummary

public EmailActivitySummary(int activityId,
                            java.lang.String name,
                            java.lang.String description,
                            java.lang.String emailTemplateName,
                            java.lang.String customerProfileName,
                            int numOfRecipients,
                            int numOfBounced,
                            int numOfClicked,
                            int numOfOpened)
Constructor. Builds summary information for the e-mail activity.
Parameters:
activityId - the ID used to represent the e-mail activity.
name - the name of the the e-mail activity.
description - the description of the e-mail activity.
emailTemplateName - the e-mail template used by the e-mail activity.
customerProfileName - the customer profile used by the e-mail activity.
numOfRecipients - the number of people were sent the e-mail activity.
numOfBounced - the number of bounced messages that were caused by the e-mail activity.
numOfClicked - the number of messages within the activity that had a URL clicked.
numOfOpened - the number of messages within the activity that were opened.
Method Detail

getActivityId

public int getActivityId()
Returns the activityId of the e-mail activity upon which the summary is based.
Returns:
The activityId of the e-mail activity.

getName

public java.lang.String getName()
Returns the name of the e-mail activity upon which the summary is based.
Returns:
The name of the e-mail activity.

getDescription

public java.lang.String getDescription()
Returns the description of the e-mail activity upon which the summary is based.
Returns:
The description of the e-mail activity.

getCustomerProfileName

public java.lang.String getCustomerProfileName()
Returns the name of the customer profile that is part of the e-mail activity upon which the summary is based.
Returns:
The name of the customer profile.

getEmailTemplateName

public java.lang.String getEmailTemplateName()
Returns the name of the e-mail template that is part of the e-mail activity upon which the summary is based.
Returns:
The name of the e-mail template.

getNumberOfRecipients

public int getNumberOfRecipients()
Returns the number of recipients to whom this e-mail activity was attempted to be sent.
Returns:
The number of attempted recipients.

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 assumed recieved recipients.

getNumberOfClicked

public int getNumberOfClicked()
Returns the number of recipients that have clicked this e-mail activity.
Returns:
The number of clicks recorded.

getNumberOfOpened

public int getNumberOfOpened()
Returns the number of recipients that have opened this e-mail activity.
Returns:
The number of openings recorded.

getNumberOfBounced

public int getNumberOfBounced()
Returns the number of bounced message that have resulted from sending this e-mail activity.
Returns:
The number of bounces recorded.

getPercentageAssumeReceived

public double getPercentageAssumeReceived()
Returns the percentage of recipients that have recieved e-mail activity.
Returns:
The percentage of assumed 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.

getPercentageOpened

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

getPercentageClicked

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