|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.ForumCategory
public class ForumCategory
A container for forums and a hierarchy of other forum categories. In other words, the category structure is a tree, with lists of forums for every category node. There is always a "root" forum category (ID of 1), of which all other categories are children.
Constructor Summary | |
---|---|
ForumCategory()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
int |
getCategoryCount()
Returns the number of child categories for this category. |
int |
getCategoryDepth()
Returns the depth of a this category relative to the root. |
java.util.Date |
getCreationDate()
Returns the Date that the category was created. |
java.lang.String |
getDescription()
Returns the description of the forum category. |
Locale |
getFinalLocale()
Returns the locale for this category. |
int |
getForumCount()
Returns the number of forums in the category. |
long |
getID()
Returns the ID of the category. |
long |
getLatestMessageID()
Returns the most recently created or edited message in this category (including all sub-categories). |
Locale |
getLocale()
Returns the locale for this category. |
int |
getMessageCount()
Returns the number of messages in the category. |
java.util.Date |
getModificationDate()
Returns the Date this category was last modified. |
java.lang.String |
getName()
Returns the name of the category. |
long |
getParentCategoryID()
Returns ID of the parent category of this category. |
int |
getRecursiveForumCount()
Returns the number of forums in the category and all sub-categories. |
int |
getThreadCount()
Returns number of forums in the category and all sub-categories |
int |
hashCode()
|
void |
setCategoryCount(int categoryCount)
Sets the number of child categories for this category. |
void |
setCategoryDepth(int categoryDepth)
|
void |
setCreationDate(java.util.Date creationDate)
Sets the creation date of the category. |
void |
setDescription(java.lang.String description)
Sets the description of the forum category. |
void |
setFinalLocale(Locale finalLocale)
|
void |
setForumCount(int forumCount)
|
void |
setID(long id)
|
void |
setLatestMessageID(long latestMessageID)
|
void |
setLocale(Locale locale)
Sets the locale for this category. |
void |
setMessageCount(int messageCount)
|
void |
setModificationDate(java.util.Date modificationDate)
Sets the date the category was last modified. |
void |
setName(java.lang.String name)
Sets the name of the forum category. |
void |
setParentCategoryID(long parentCategoryID)
|
void |
setRecursiveForumCount(int recursiveForumCount)
|
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 ForumCategory()
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 category.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the description of the forum category.public java.util.Date getCreationDate()
public void setCreationDate(java.util.Date creationDate)
creationDate
- the date the forum category was created.public java.util.Date getModificationDate()
By default, this feature is
public void setModificationDate(java.util.Date modificationDate)
modificationDate
- the date the forum was modified.public Locale getLocale()
public void setLocale(Locale locale)
locale
- the locale of this category.public Locale getFinalLocale()
public void setFinalLocale(Locale finalLocale)
public int getForumCount()
public void setForumCount(int forumCount)
public int getRecursiveForumCount()
public void setRecursiveForumCount(int recursiveForumCount)
public int getThreadCount()
public void setThreadCount(int threadCount)
public int getMessageCount()
public void setMessageCount(int messageCount)
public long getLatestMessageID()
ResultFilter
, but this method offers a simpler, more optimized way to
access the data.
public void setLatestMessageID(long latestMessageID)
public long getParentCategoryID()
public void setParentCategoryID(long parentCategoryID)
public int getCategoryDepth()
1 |-- 3 |-- |-- 4 |-- |-- |-- 7The depth of message 4 is 2, the depth of category 7 is 3, etc.
public void setCategoryDepth(int categoryDepth)
public int getCategoryCount()
public void setCategoryCount(int categoryCount)
categoryCount
- the number of child categories for this category.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 |