com.ibm.commerce.emarketing.beans
Class EmailActivitySummaryDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.emarketing.beans.EmailActivitySummaryDataBeanBase
                    |
                    +--com.ibm.commerce.emarketing.beans.EmailActivitySummaryDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class EmailActivitySummaryDataBean
extends EmailActivitySummaryDataBeanBase

Used to gather summary information for an e-mail activity.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          Copyright.
 
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
commandContext
 
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl
requestProperties
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
EmailActivitySummaryDataBean()
           
 
Method Summary
 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 Profile assigned to the activity.
 java.lang.String getMemberGroupName()
          Gets the name of the Customer Profile 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-mail of the e-mail activity.
 int getNumClicked()
          Gets the number of click through e-mail of the e-mail activity.
 int getNumOpened()
          Gets the number of opened e-mail of the e-mail activity.
 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.
 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()
          If the customer profile 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.emarketing.beans. EmailActivitySummaryDataBeanBase
getDelegate, getOwner
 
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl
fulfills, getCommandContext, getResources, setCommandContext
 
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl
getRequestProperties, setRequestProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.beans. InputDataBean
getRequestProperties, setRequestProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright.
See Also:
Constant Field Values
Constructor Detail

EmailActivitySummaryDataBean

public EmailActivitySummaryDataBean()
Method Detail

getId

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

getName

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

getDescription

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

getStatus

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

isCustomerProfileExist

public boolean isCustomerProfileExist()
If the customer profile associated with the e-mail activity still exists.
Returns:
returns yes when the customer profile 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 SmartDataBean
Overrides:
populate in class 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.

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.

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.

getMemberGroupName

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

getMemberGroupId

public java.lang.Long getMemberGroupId()
Gets the id of the Customer Profile assigned to the activity.
Returns:
the id of the Customer Profile assigned to the 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.

getNumBounced

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

getNumClicked

public int getNumClicked()
Gets the number of click through e-mail 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-mail of the e-mail activity.
Returns:
the number of opened e-mail of the e-mail activity.

getPercentageAssumeReceived

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

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

getDeliveryDate

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

getJobNum

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