oracle.discussions.ws.beans
Class ForumMessage

java.lang.Object
oracle.discussions.ws.beans.ForumMessage

Direct Known Subclasses:

Topic

public class ForumMessage

extends java.lang.Object

Represents an individual message of a forum.

Every independent forum message in the forum is called a topic. It is the root from which, all other messages stem from. Replies to a topic are called messages. A message can have attachments and text.

See Also:

Topic

Method Summary

Annotation[]	getAnnotations() Returns the message annotations.
java.lang.String	getBodyPlainText() Returns the message body.
long	getForumId() Returns the id of the forum, in which the message is present.
java.lang.String[]	getFromAddresses() Returns the email addresses of the message authors.
int	getLevel() Returns a message's level in a topic.
int	getMessageId() Returns the current message's id.
int	getNumberOfReplies() Returns the number of replies to this message.
java.util.Date	getSentDate() Returns the message's sent date.
int	getSize() Returns the message size in bytes.
java.lang.String	getSubject() Returns the message subject.
int	getTopicId() Returns the parent topic's id.
java.lang.String	getWebUIUrl() Returns the webui url for the web page displaying this element.
java.lang.String	getXPriority() Returns the message priority.
boolean	isByModerator() Returns if this is a sticky thread.
boolean	isHasAttachments() Returns if the message has attachments.
boolean	isHidden() Sets if the forum message is hidden.
boolean	isHTMLContentType() Returns if the message is composed of html text.
boolean	isNewMessage() Returns if the message is NEW.
boolean	isNewSinceLastVisit() Returns if the message is new from the users last visit.
boolean	isNewSinceSession() Returns if the message is new from the user's curretn session.

Methods inherited from class java.lang.Object

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

Method Detail

getBodyPlainText

public java.lang.String getBodyPlainText()

Returns the message body. If the body is composed of plain text, it is returned. If the body is composed of html text the html text is converted to plain text and the same is returned.

Returns:

String - Message body text

getFromAddresses

public java.lang.String[] getFromAddresses()

Returns the email addresses of the message authors.

Returns:

String[] - Array of email ids, representing the message authors.

getLevel

public int getLevel()

Returns a message's level in a topic.

Returns:

int - Message's level inside a topic.

getNumberOfReplies

public int getNumberOfReplies()

Returns the number of replies to this message.

Returns:

int -Reply count for this message.

getMessageId

public int getMessageId()

Returns the current message's id.

Returns:

int - Id of the message

getSentDate

public java.util.Date getSentDate()

Returns the message's sent date.

Returns:

Date

getSize

public int getSize()

Returns the message size in bytes.

Returns:

int

getSubject

public java.lang.String getSubject()

Returns the message subject. Returns the string "NO_SUBJECT", if the message doesnot have a subject.

Returns:

message subject

getXPriority

public java.lang.String getXPriority()

Returns the message priority.

Returns:

message priority - String

isHasAttachments

public boolean isHasAttachments()

Returns if the message has attachments. Returns true if the message has attachments, false otherwise.

Returns:

boolean

isByModerator

public boolean isByModerator()

Returns if this is a sticky thread.

Returns:

boolean

isNewMessage

public boolean isNewMessage()

Returns if the message is NEW. Returns true, if any of the two methods

• setNewSinceLastVisit returns true
• setNewSinceSession returns true

Returns:

boolean

isNewSinceLastVisit

public boolean isNewSinceLastVisit()

Returns if the message is new from the users last visit.

Returns:

boolean

isNewSinceSession

public boolean isNewSinceSession()

Returns if the message is new from the user's curretn session.

Returns:

boolean

getWebUIUrl

public java.lang.String getWebUIUrl()

Returns the webui url for the web page displaying this element. Sets the web ui url for the page displaying the current element. The user can copy-paste this url to his browser and can access the

Returns:

String - Webui url of the element.

getAnnotations

public Annotation[] getAnnotations()

Returns the message annotations. Message annotations represent the message history. It contains information about the operation carried out, arguments passed in the operation, author invoking the operation etc.

Returns:

ann - Array of message annotations.

getTopicId

public int getTopicId()

Returns the parent topic's id.

Returns:

int - Returns the id of the parent topic to this message.

getForumId

public long getForumId()

Returns the id of the forum, in which the message is present.

Returns:

long - Forum's id.

isHTMLContentType

public boolean isHTMLContentType()

Returns if the message is composed of html text.

Returns:

boolean - Indicates if the message content is of html type.

isHidden

public boolean isHidden()

Sets if the forum message is hidden.

Returns:

boolean - Value indicating if the message is hidden.