|
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.Forum
public class Forum
A container for a list of threads. Each forum belongs to a single category. A forum offers the finest granularity of permissions in the system.
Constructor Summary | |
---|---|
Forum()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
long |
getCategoryID()
Returns the parent category ID for this forum. |
java.util.Date |
getCreationDate()
Returns the Date that the forum was created. |
java.lang.String |
getDescription()
Returns the description of the forum. |
Locale |
getFinalLocale()
Returns the locale for this forum. |
long |
getID()
Returns the unique id of the forum. |
ForumMessage |
getLatestMessage()
Returns the Lastmessage object of the forum. |
long |
getLatestMessageID()
Returns the ID of the most recently created or edited message in this forum. |
Locale |
getLocale()
Returns the locale for this forum. |
int |
getMaxForumIndex()
Returns the largest forum index value for a message in the forum. |
int |
getMinForumIndex()
Returns the smallest forum index value for a message in the forum. |
int |
getModerationDefaultMessageValue()
Returns the default number of moderation points for messages created in the forum. |
int |
getModerationDefaultThreadValue()
Returns the default number of moderation points for threads created in the forum. |
java.util.Date |
getModificationDate()
Returns the Date that the forum was last modified. |
java.lang.String |
getName()
Returns the name of the forum. |
java.lang.String |
getNNTPName()
Returns the NNTP name for the forum, which is the name of the forum used in the NNTP protocol (newsgroups). |
int |
getThreadCount()
Returns the complete thread count for this forum. |
int |
hashCode()
|
void |
setCategoryID(long categoryID)
|
void |
setCreationDate(java.util.Date creationDate)
Sets the creation date of the forum. |
void |
setDescription(java.lang.String description)
Sets the description of the forum. |
void |
setFinalLocale(Locale finalLocale)
|
void |
setID(long id)
|
void |
setLatestMessage(ForumMessage latestMessage)
|
void |
setLatestMessageID(long latestMessageID)
|
void |
setLocale(Locale locale)
Sets the locale for this forum. |
void |
setMaxForumIndex(int maxForumIndex)
|
void |
setMinForumIndex(int minForumIndex)
|
void |
setModerationDefaultMessageValue(int value)
Sets the default number of moderation points for threads created in the forum. |
void |
setModerationDefaultThreadValue(int value)
Sets the default number of moderation points for threads created in the forum. |
void |
setModificationDate(java.util.Date modificationDate)
Sets the date the forum was last modified. |
void |
setName(java.lang.String name)
Sets the name of a the forum. |
void |
setNNTPName(java.lang.String nntpName)
Sets the NNTP name for the forum, which is the name of the forum used in the NNTP protocol (newsgroups). |
void |
setThreadCount(int threadCount)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Forum()
Method Detail |
---|
public long getID()
public void setID(long id)
public java.lang.String getName()
public void setName(java.lang.String name)
name
- the name of the forum.public java.lang.String getNNTPName()
NNTP names must follow certain rules. In particular:
public void setNNTPName(java.lang.String nntpName)
NNTP names must follow certain rules. Therefore, any name passed into this method will automatically converted based on the following rules:
nntpName
- the NNTP name of the forum.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description of the forum.public java.util.Date getCreationDate()
public void setCreationDate(java.util.Date creationDate)
creationDate
- the date the forum was created.public java.util.Date getModificationDate()
public void setModificationDate(java.util.Date modificationDate)
modificationDate
- the date the forum was modified.public int getModerationDefaultThreadValue()
public void setModerationDefaultThreadValue(int value)
value
- default number of moderation points for threads.public int getModerationDefaultMessageValue()
public void setModerationDefaultMessageValue(int value)
value
- default number of moderation points for messages.public int getMinForumIndex()
public void setMinForumIndex(int minForumIndex)
public int getMaxForumIndex()
public void setMaxForumIndex(int maxForumIndex)
public Locale getLocale()
public void setLocale(Locale locale)
locale
- the locale of this forum.public Locale getFinalLocale()
public void setFinalLocale(Locale finalLocale)
public long getLatestMessageID()
ResultFilter
, but this
method offers a simpler, more optimized way to access the data.
public void setLatestMessageID(long latestMessageID)
public ForumMessage getLatestMessage()
public void setLatestMessage(ForumMessage latestMessage)
public long getCategoryID()
public void setCategoryID(long categoryID)
public int getThreadCount()
public void setThreadCount(int threadCount)
public 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 |