|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.portal.alert.PortalMessage
public class PortalMessage
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.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public PortalMessage()
public PortalMessage(java.lang.String pMessageType)
public PortalMessage(java.lang.String pMessageType, java.util.Date pStartDate, java.util.Date pEndDate, java.util.Date pExpirationDate)
Method Detail |
---|
public java.lang.String getMessageType()
public void setMessageType(java.lang.String pMessageType)
pMessage
- the JMS message typepublic java.lang.String getSourceId()
public void setSourceId(java.lang.String pSourceId)
pSourceId
- the source id.public java.lang.String getSourceType()
public void setSourceType(java.lang.String pSourceType)
pSourceType
- the source type.public java.util.Date getStartDate()
public void setStartDate(java.util.Date pStartDate)
pStartDate
- the Date the alert should be publishedpublic java.util.Date getEndDate()
public void setEndDate(java.util.Date pEndDate)
pEndDate
- the Date the alert should stop being publishedpublic java.util.Date getCreationDate()
public void setCreationDate(java.util.Date pCreationDate)
pCreationDate
- the Date the alert was createdpublic java.util.Date getExpirationDate()
the
- Date to remove the alert from the repositorypublic void setExpirationDate(java.util.Date pExpirationDate)
pExpirationDate
- the Date to remove the alert from the repositorypublic void preFormatMessage(java.util.Locale pLocale) throws java.lang.Exception
java.lang.Exception
public void postFormatMessage(java.util.Locale pLocale) throws java.lang.Exception
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |