atg.portal.alert

Class PortalMessage

java.lang.Object

atg.portal.alert.PortalMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdministrationMessage, FrameworkMessage, GearMessage

public class PortalMessage
extends java.lang.Object
implements java.io.Serializable

This class is the base class for all PAF message beans. It is a serializable Java Object that will contain all of the necessary properties which are common to all PAF messages including admin, framework, gear, and custom application messages.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
PortalMessage()
PortalMessage(java.lang.String pMessageType)
PortalMessage(java.lang.String pMessageType, java.util.Date pStartDate, java.util.Date pEndDate, java.util.Date pExpirationDate)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreationDate() Get the Date the alert was created.
java.util.Date	getEndDate() Get the Date the alert should stop being published
java.util.Date	getExpirationDate() Get the Date the alert should be removed from the repository.
java.lang.String	getMessageType() Get the JMS messsage type of this message bean.
java.lang.String	getSourceId() Get the source id of this message bean.
java.lang.String	getSourceType() Get the source type of this message bean.
java.util.Date	getStartDate() Get the Date that the alert should be published.
void	postFormatMessage(java.util.Locale pLocale) This method should be called by any AlertHandler implementation after formatting and delivery of the alert message.
void	preFormatMessage(java.util.Locale pLocale) This method should be called by any AlertHandler implementation prior to the formatting and delivery of the alert message.
void	setCreationDate(java.util.Date pCreationDate) Sets the time the alert was created
void	setEndDate(java.util.Date pEndDate) Sets the time the alert should stop being published
void	setExpirationDate(java.util.Date pExpirationDate) Sets the Date the alert should be removed from the repository.
void	setMessageType(java.lang.String pMessageType) Sets the JMS message type of this message bean.
void	setSourceId(java.lang.String pSourceId) Sets the source id for this message bean.
void	setSourceType(java.lang.String pSourceType) Sets the source type for this message bean.
void	setStartDate(java.util.Date pStartDate) Sets the Date the alert should start being published

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

PortalMessage

public PortalMessage()

PortalMessage

public PortalMessage(java.lang.String pMessageType)

PortalMessage

public PortalMessage(java.lang.String pMessageType,
             java.util.Date pStartDate,
             java.util.Date pEndDate,
             java.util.Date pExpirationDate)

Method Detail

getMessageType

public java.lang.String getMessageType()

Get the JMS messsage type of this message bean.

Returns:

the JMS message type

setMessageType

public void setMessageType(java.lang.String pMessageType)

Sets the JMS message type of this message bean.

Parameters:

pMessage - the JMS message type

getSourceId

public java.lang.String getSourceId()

Get the source id of this message bean.

Returns:

the source id

setSourceId

public void setSourceId(java.lang.String pSourceId)

Sets the source id for this message bean.

Parameters:

pSourceId - the source id.

getSourceType

public java.lang.String getSourceType()

Get the source type of this message bean.

Returns:

the source type

setSourceType

public void setSourceType(java.lang.String pSourceType)

Sets the source type for this message bean.

Parameters:

pSourceType - the source type.

getStartDate

public java.util.Date getStartDate()

Get the Date that the alert should be published.

Returns:

the Date the alert should be published

setStartDate

public void setStartDate(java.util.Date pStartDate)

Sets the Date the alert should start being published

Parameters:

pStartDate - the Date the alert should be published

getEndDate

public java.util.Date getEndDate()

Get the Date the alert should stop being published

Returns:

the Date the alert should stop being published

setEndDate

public void setEndDate(java.util.Date pEndDate)

Sets the time the alert should stop being published

Parameters:

pEndDate - the Date the alert should stop being published

getCreationDate

public java.util.Date getCreationDate()

Get the Date the alert was created.

Returns:

the Date the alert was created

setCreationDate

public void setCreationDate(java.util.Date pCreationDate)

Sets the time the alert was created

Parameters:

pCreationDate - the Date the alert was created

getExpirationDate

public java.util.Date getExpirationDate()

Get the Date the alert should be removed from the repository.

Parameters:

the - Date to remove the alert from the repository

setExpirationDate

public void setExpirationDate(java.util.Date pExpirationDate)

Sets the Date the alert should be removed from the repository.

Parameters:

pExpirationDate - the Date to remove the alert from the repository

preFormatMessage

public void preFormatMessage(java.util.Locale pLocale)
                      throws java.lang.Exception

This method should be called by any AlertHandler implementation prior to the formatting and delivery of the alert message. Its purpose is to allow any special handling of message bean properties that needs to take place prior to the alert message being formated and delivered.

Throws:

java.lang.Exception

postFormatMessage

public void postFormatMessage(java.util.Locale pLocale)
                       throws java.lang.Exception

This method should be called by any AlertHandler implementation after formatting and delivery of the alert message. Its purpose is to allow any configuration or special handling of message bean properties that needs to take place after the alert message has been formated and delivered.

Throws:

java.lang.Exception