|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.uplanet.lucy.server.newsagent.Message
public final class Message
Represents a message that is managed by a NewsAgent
.
Method Summary | |
---|---|
void |
addRecipient(java.lang.String p_strRecipientId)
Add a recipient of this message. |
void |
addRecipients(java.lang.String[] p_astrRecipientList)
Add recipients of this message. |
void |
clearRecipients()
Remove all recipients from this message. |
java.lang.String |
dump()
|
java.lang.Object |
get(java.lang.String p_strName)
Get a property of this message. |
java.lang.String |
getAppGuid()
Get the message's application GUID. |
java.lang.String |
getBody()
Get the body of the message. |
java.sql.Timestamp |
getCreationDate()
Get the creation date of the message. |
java.sql.Timestamp |
getExpirationDate()
Get the expiration date of the message. |
java.lang.String |
getId()
Get the GUID of the message. |
java.lang.String |
getRecId()
Get the message's record identifier. |
java.util.Iterator<de.uplanet.lucy.server.newsagent.RecipientStatus> |
getRecipients()
Get an (ordered) iterator over the recipients GUID collection. |
java.lang.String |
getSender()
Get the GUID of the sender. |
java.lang.String |
getSubject()
Get the subject of the message. |
java.lang.String |
getTargetGuid()
Get the message's target GUID. |
java.lang.String |
getUrl()
The URL that is associated to the message. |
boolean |
hasRecipient(java.lang.String p_strRecipientId)
Test if this message has the specified individual recipient. |
boolean |
hasRecipients()
Test if this message has the specified individual recipient. |
boolean |
isComplete()
Determine if the message is properly initialized. |
boolean |
isDirty()
Determine if the message was modified. |
boolean |
isVisited()
Determine if the message has been read by the current user. |
void |
markDeleted()
Mark this message as deleted if it is currently associated with a certain recipient. |
void |
markRead()
Mark this message as read if it is currently associated with a certain recipient. |
boolean |
save()
Save the message to the database. |
void |
set(java.lang.String p_strName,
java.lang.Object p_objValue)
Set a property for this message. |
void |
setAppGuid(java.lang.String p_strAppGuid)
Set the message's application GUID. |
void |
setBody(java.lang.String p_strBody)
Set the body of the message. |
void |
setExpirationDate(java.sql.Timestamp p_dtExpire)
Set the expiration date of the message. |
void |
setRecId(java.lang.String p_strRecId)
Set the messages record identifier. |
void |
setSender(java.lang.String p_strSenderId)
Set the sender of the message. |
void |
setSubject(java.lang.String p_strSubject)
Set the subject of the message. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean save()
save
in interface de.uplanet.lucy.server.newsagent.IMessage
true
if the message could be saved, false
otherwise.public java.lang.String getId()
getId
in interface de.uplanet.lucy.server.newsagent.IMessage
public boolean isComplete()
isComplete
in interface de.uplanet.lucy.server.newsagent.IMessage
true
if the message is properly initialized, false
otherwise.public boolean isDirty()
isDirty
in interface de.uplanet.lucy.server.newsagent.IMessage
true
if the message was modifier, false
otherwise.public java.sql.Timestamp getCreationDate()
getCreationDate
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setAppGuid(java.lang.String p_strAppGuid)
The target identifier is adjusted properly.
p_strAppGuid
- The GUID to be set.public java.lang.String getAppGuid()
getAppGuid
in interface de.uplanet.lucy.server.newsagent.IMessage
public java.lang.String getTargetGuid()
getTargetGuid
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setRecId(java.lang.String p_strRecId)
public java.lang.String getRecId()
getRecId
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setSender(java.lang.String p_strSenderId)
p_strSenderId
- The GUID of the sender.public java.lang.String getSender()
getSender
in interface de.uplanet.lucy.server.newsagent.IMessage
public boolean hasRecipients()
hasRecipients
in interface de.uplanet.lucy.server.newsagent.IMessage
true
if the message has recipients, false
otherwise.public boolean hasRecipient(java.lang.String p_strRecipientId)
hasRecipient
in interface de.uplanet.lucy.server.newsagent.IMessage
p_strRecipientId
- The GUID of the individual recipient.
return true
if the message has the specified individual recipient.public void addRecipient(java.lang.String p_strRecipientId)
addRecipient
in interface de.uplanet.lucy.server.newsagent.IMessage
p_strRecipientId
- The GUID of the recipient.
Insert debug code. |
public void addRecipients(java.lang.String[] p_astrRecipientList)
addRecipients
in interface de.uplanet.lucy.server.newsagent.IMessage
p_astrRecipientList
- The GUIDs of the recipients of this message.
Insert debug code. |
public java.util.Iterator<de.uplanet.lucy.server.newsagent.RecipientStatus> getRecipients()
RecipientStatus
objects so users must apply the RecipientStatus.toString()
method to obtain
the string representation.
getRecipients
in interface de.uplanet.lucy.server.newsagent.IMessage
public void clearRecipients()
clearRecipients
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setSubject(java.lang.String p_strSubject)
p_strSubject
- The subject.public java.lang.String getSubject()
getSubject
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setBody(java.lang.String p_strBody)
p_strBody
- The body.public java.lang.String getBody()
getBody
in interface de.uplanet.lucy.server.newsagent.IMessage
public void setExpirationDate(java.sql.Timestamp p_dtExpire)
p_dtExpire
- The expiration date.public java.sql.Timestamp getExpirationDate()
getExpirationDate
in interface de.uplanet.lucy.server.newsagent.IMessage
public java.lang.String getUrl()
Implement this method. |
public boolean isVisited()
true
if the message has been read by the current user,
false
if this is not the case or if the visited-status can
not be determined.public void set(java.lang.String p_strName, java.lang.Object p_objValue)
p_strName
- The name of the property.p_objValue
- The value of the property.
This method is not implemented yet. |
public java.lang.Object get(java.lang.String p_strName)
p_strName
- The name of the property.
This method is not implemented yet. |
public void markRead()
m_strRecipientId
public void markDeleted()
m_strRecipientId
public java.lang.String dump()
dump
in interface de.uplanet.util.IDumpable
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |