|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.ForumThread
public class ForumThread
A ForumThread is a container for a hierarchy of ForumMessages.
Constructor Summary | |
---|---|
ForumThread()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.util.Date |
getCreationDate()
Returns the date that this thread was created. |
long |
getForumID()
Returns the ID of the forum this thread belongs to. |
long |
getID()
Returns the unique ID of this thread. |
ForumMessage |
getLatestMessage()
Returns the most recently created messages in this thread. |
int |
getMessageCount()
Returns the number of messages in the thread. |
int |
getModerationValue()
Returns the number of moderation points this thread has. |
java.util.Date |
getModificationDate()
Returns the date that this thread was last modified. |
java.lang.String |
getName()
Returns the subject of the root message of this thread. |
ForumMessage |
getRootMessage()
Returns the root message this thread. |
int |
hashCode()
|
void |
setCreationDate(java.util.Date creationDate)
Sets the creation date of this thread. |
void |
setForumID(long forumID)
Called by the ForumThreadService to set the ID of the thread this forum belongs too. |
void |
setID(long id)
Called by ForumThreadService to set the value of this thread into this object. |
void |
setLatestMessage(ForumMessage latestMessage)
Called by the ForumThreadService to set the appropriate latestMessage into the thread. |
void |
setMessageCount(int messageCount)
Set the number of messages in this thread. |
void |
setModerationValue(int moderationValue)
Used to change the moderation value of the forum. |
void |
setModificationDate(java.util.Date modificationDate)
Sets the date this thread was last modified. |
void |
setName(java.lang.String name)
Used by ForumThreadService to set the value of this field. |
void |
setRootMessage(ForumMessage rootMessage)
Called by the ForumThreadService to set the appropriate rootMessage into the thread. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ForumThread()
Method Detail |
---|
public long getID()
public void setID(long id)
id
- The ID of this thread.public java.lang.String getName()
getRootMessage().getSubject()
.
public void setName(java.lang.String name)
name
- The name of the thread.public java.util.Date getCreationDate()
public void setCreationDate(java.util.Date creationDate)
creationDate
- the date this thread was created.public java.util.Date getModificationDate()
public void setModificationDate(java.util.Date modificationDate)
modificationDate
- the date this thread was modified.public int getModerationValue()
Forum.getModerationDefaultThreadValue()
If the moderation value is less than
JiveConstants.FORUM_MODERATION_VISIBLE
then the thread will not be displayed by default. Because a thread and
its root message are intrinsically bound together, their moderation values
are linked and are always the same. This means that setting the moderation
value on the thread or setting the moderation value of a root message will
always affect both objects.
public void setModerationValue(int moderationValue)
moderationValue
- The moderation value of this forumpublic long getForumID()
public void setForumID(long forumID)
forumID
- The ID of the thread that this forum belongs too.public ForumMessage getRootMessage()
public void setLatestMessage(ForumMessage latestMessage)
latestMessage
- The the lastest message in the thread.public void setRootMessage(ForumMessage rootMessage)
rootMessage
- The root message of the thread.public ForumMessage getLatestMessage()
public int getMessageCount()
public void setMessageCount(int messageCount)
messageCount
- The number of message in this threadpublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |