atg.userprofiling.email
Class TemplateEmailEvent

java.lang.Object
  extended by java.util.EventObject
      extended by atg.service.event.GenericEvent
          extended by atg.userprofiling.email.TemplateEmailEvent
All Implemented Interfaces:
java.io.Serializable

public class TemplateEmailEvent
extends GenericEvent

An event that is used to notify the TemplateEmailListener objects of sent/unsent email messages.

See Also:
TemplateEmailListener, Serialized Form

Field Summary
static int[] ALL_TYPES
          An array of all of the event types for this event
static java.lang.String CLASS_VERSION
          Class version string
static int TYPE_EMAIL_NOT_SENT
          Event type corresponding to a failure to send
static int TYPE_EMAIL_SENT
          Event type corresponding to a successful email send
 
Fields inherited from class atg.service.event.GenericEvent
mDate, mTime, mTimestamp, mType, TYPE_VANILLA
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
TemplateEmailEvent(java.lang.Object pSource)
          Constructs a new TemplateEmailEvent.
TemplateEmailEvent(java.lang.Object pSource, int pEventType)
          Constructs a new TemplateEmailEvent of the given type.
 
Method Summary
 TemplateEmailInfo getEmailInfo()
          Returns the TemplateEmailInfo describing the email message.
 java.lang.String getErrorMessage()
          Returns the error message generated while trying to send the email, or null if the email was sent successfully.
 javax.mail.Message getMessage()
          Returns the Message constructed to send the email.
 java.lang.Object getRecipient()
          Returns the recipient profile object.
 void setEmailInfo(TemplateEmailInfo pEmailInfo)
          Sets the TemplateEmailInfo describing the email message.
 void setErrorMessage(java.lang.String pErrorMessage)
          Sets the error message generated while trying to send the email.
 void setMessage(javax.mail.Message pMessage)
          Sets the Message constructed to send the email.
 void setRecipient(java.lang.Object pRecipient)
          Sets the recipient profile object.
 
Methods inherited from class atg.service.event.GenericEvent
getAllTypes, getSource, getTime, getTimeAsDate, getTimeAsTimestamp, getType
 
Methods inherited from class java.util.EventObject
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string


TYPE_EMAIL_SENT

public static final int TYPE_EMAIL_SENT
Event type corresponding to a successful email send

See Also:
Constant Field Values

TYPE_EMAIL_NOT_SENT

public static final int TYPE_EMAIL_NOT_SENT
Event type corresponding to a failure to send

See Also:
Constant Field Values

ALL_TYPES

public static int[] ALL_TYPES
An array of all of the event types for this event

Constructor Detail

TemplateEmailEvent

public TemplateEmailEvent(java.lang.Object pSource)
Constructs a new TemplateEmailEvent.


TemplateEmailEvent

public TemplateEmailEvent(java.lang.Object pSource,
                          int pEventType)
Constructs a new TemplateEmailEvent of the given type.

Method Detail

getEmailInfo

public TemplateEmailInfo getEmailInfo()
Returns the TemplateEmailInfo describing the email message.


setEmailInfo

public void setEmailInfo(TemplateEmailInfo pEmailInfo)
Sets the TemplateEmailInfo describing the email message.


getRecipient

public java.lang.Object getRecipient()
Returns the recipient profile object.


setRecipient

public void setRecipient(java.lang.Object pRecipient)
Sets the recipient profile object.


getMessage

public javax.mail.Message getMessage()
Returns the Message constructed to send the email.


setMessage

public void setMessage(javax.mail.Message pMessage)
Sets the Message constructed to send the email.


getErrorMessage

public java.lang.String getErrorMessage()
Returns the error message generated while trying to send the email, or null if the email was sent successfully.


setErrorMessage

public void setErrorMessage(java.lang.String pErrorMessage)
Sets the error message generated while trying to send the email.