|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV NEXT | FRAMES NO FRAMES |
Packages that use ForumCategory | |
---|---|
com.jivesoftware.forum | Core interfaces and classes for Jive Forums. |
com.jivesoftware.forum.action | Jive Forums WebWork actions. |
com.jivesoftware.forum.action.rss | Jive Forums WebWork RSS actions. |
com.jivesoftware.forum.database | DB implementation of core Jive Forums interfaces. |
com.jivesoftware.forum.event | Provides mechanisms to be notified of actions in the system such as new messages being created. |
com.jivesoftware.forum.everywhere.action | |
com.jivesoftware.forum.expert | |
com.jivesoftware.forum.proxy | Protection proxies for Jive Forums objects. |
com.jivesoftware.forum.stats | Jive Forums reporting engine. |
com.jivesoftware.forum.util | Jive Forums utility classes. |
com.jivesoftware.forum.webservices.server |
Uses of ForumCategory in com.jivesoftware.forum |
---|
Methods in com.jivesoftware.forum that return ForumCategory | |
---|---|
ForumCategory |
ForumCategory.createCategory(java.lang.String name,
java.lang.String description)
Creates a new ForumCategory as a sub-category of this category using the name and description. |
ForumCategory |
Forum.getForumCategory()
Returns the forum category that this forum belongs to. |
abstract ForumCategory |
ForumFactory.getForumCategory(long categoryID)
Returns the forum category with the specified categoryID. |
ForumCategory |
ForumCategory.getParentCategory()
Returns the parent category of this category. |
abstract ForumCategory |
ForumFactory.getRootForumCategory()
Returns the "root" forum category, that all other categories are children of. |
Methods in com.jivesoftware.forum with parameters of type ForumCategory | |
---|---|
Announcement |
AnnouncementManager.createAnnouncement(User user,
ForumCategory category)
Creates a new category announcement. |
abstract Forum |
ForumFactory.createForum(java.lang.String name,
java.lang.String description,
ForumCategory category)
Creates a new forum in the specified category. |
Watch |
WatchManager.createWatch(User user,
ForumCategory category)
Create a watch on a category for the specified user. |
void |
ForumCategory.deleteCategory(ForumCategory subCategory)
Deletes a sub-category. |
long[] |
StatusLevelCalculator.getLeaderIds(ForumCategory category,
int startIndex,
int numResults)
Returns a long array of user ids of forum category leaders given a start index and desired number of results. |
java.util.Iterator |
StatusLevelManager.getLeaders(ForumCategory category)
Returns an Iterator of leaders for a specific forum category |
java.util.Iterator |
StatusLevelManager.getLeaders(ForumCategory category,
int startIndex,
int numResults)
Returns an Iterator of leaders for a specific forum category |
int |
StatusLevelCalculator.getPointLevel(User user,
ForumCategory category)
Returns the status level points for a user in regards to a specific category |
int |
StatusLevelManager.getPointLevel(User user,
ForumCategory category)
Returns the status level points for a user in regards to a specific category |
int |
RewardManager.getPointsEarned(User user,
ForumCategory category)
Returns the total number of points the user has earned in a particular category. |
java.util.Iterator |
TagManager.getPopularTags(ForumCategory forumCategory)
Get popular tags |
int |
AnnouncementManager.getRecursiveAnnouncementCount(ForumCategory category)
Returns the count of all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
java.util.Iterator |
AnnouncementManager.getRecursiveAnnouncements(ForumCategory category,
int startIndex,
int numResults)
Returns all currently viewable announcements in a ForumCategory and its child Forums and SubCategories. |
int |
WatchManager.getRecursiveForumWatchCount(User user,
ForumCategory category)
Returns number of Forum objects the user is watching under the category and its subcategories. |
java.util.Iterator |
WatchManager.getRecursiveForumWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns all the Forum objects the user is watching under the category and its subcategories. |
int |
WatchManager.getRecursiveThreadWatchCount(User user,
ForumCategory category)
Returns the number of ForumThread objects the user is watching under the provided ForumCategory. |
java.util.Iterator |
WatchManager.getRecursiveThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. |
StatusLevel |
StatusLevelManager.getStatusLevel(User user,
ForumCategory category)
Returns the status level for a user in a specific category. if a status level cannot be determined for this user in this category null will be returned. |
java.util.Iterator |
WatchManager.getThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the ForumThread objects the user is watching under the provided ForumCategory. |
java.util.Iterator |
RewardManager.getTopUsers(int startIndex,
int numResults,
ForumCategory category)
Returns an iterator for the top point earners in a category. |
int |
ReadTracker.getUnreadMessageCount(User user,
ForumCategory category)
Returns the count of unread messages that the user has in the category. |
java.util.Iterator |
ReadTracker.getUnreadMessages(User user,
ForumCategory category)
Returns an iterator for the unread messages in the category. |
int |
ReadTracker.getUnreadThreadCount(User user,
ForumCategory category)
Returns the count of unread threads that the user has in the category. |
java.util.Iterator |
ReadTracker.getUnreadThreads(User user,
ForumCategory category)
Returns an iterator for the unread threads in the category. |
Watch |
WatchManager.getWatch(User user,
ForumCategory category)
Returns a watch on a particular category, or null if there isn't a watch. |
int |
WatchManager.getWatchCount(User user,
ForumCategory category)
Return the count of all forum watches in a particular category for the given user. |
java.util.Iterator |
WatchManager.getWatches(User user,
ForumCategory category)
Returns an Iterator for all the forum objects a user is watching in a category. |
java.util.Iterator |
WatchManager.getWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
Returns the Forums watched by the User under the given Category. |
boolean |
WatchManager.isWatched(User user,
ForumCategory category)
Returns true if the user is watching the specified category. |
void |
ReadTracker.markRead(User user,
ForumCategory category)
Marks an entire category as read up until the current instant in time. |
void |
ForumCategory.moveCategory(ForumCategory subCategory,
ForumCategory destinationCategory)
Moves a sub-category to another category. |
void |
ForumCategory.moveForum(Forum forum,
ForumCategory destinationCategory)
Moves a forum from this category to another. |
void |
ForumCategory.setCategoryIndex(ForumCategory subCategory,
int newIndex)
Sets the display order of a sub-category. |
Uses of ForumCategory in com.jivesoftware.forum.action |
---|
Fields in com.jivesoftware.forum.action declared as ForumCategory | |
---|---|
protected ForumCategory |
TagCloudAction.category
|
Methods in com.jivesoftware.forum.action that return ForumCategory | |
---|---|
ForumCategory |
AnnounceAction.getCategory()
Returns the category this announcement was created in or null if it was not created in a category. |
ForumCategory |
Breadcrumbs.getCategory()
|
ForumCategory |
ForumCategoryAction.getCategory()
Returns the requested ForumCategory. |
ForumCategory |
PollAction.getCategory()
|
ForumCategory |
PollPostAction.getCategory()
Returns the category we're posting the poll in or null if this is not a category specific poll. |
ForumCategory |
PollsViewAction.getCategory()
Returns the category object loaded by the given category ID or null if no category was specified. |
ForumCategory |
PostAnnounceAction.getCategory()
Returns the category we're posting the announcement in or null if this is not a category specific announcement. |
ForumCategory |
ReadAction.getCategory()
Returns the category we've loaded. |
ForumCategory |
StatusLevelLeadersAction.getCategory()
Returns the category we're working with or null if this is a forum or global leader list. |
ForumCategory |
TagCloudAction.getCategory()
|
ForumCategory |
EditRenderFilter.getCategoryObject()
|
ForumCategory |
FilterSettings.getCategoryObject()
|
ForumCategory |
SearchAction.getSearchedCategory()
Returns the single category being searched, or null if no categories are being searched or if there is more than one category being searched. |
Methods in com.jivesoftware.forum.action with parameters of type ForumCategory | |
---|---|
boolean |
ForumActionSupport.getCanCreatePoll(ForumCategory category)
Returns true if the page user is authorized to create polls in the given category, false otherwise. |
boolean |
ForumActionSupport.getCanCreateThread(ForumCategory category)
Returns true if the page user is authorized to create threads in the given category, false otherwise. |
boolean |
ForumActionSupport.getCanEditPoll(ForumCategory category,
Poll poll)
|
boolean |
ForumActionSupport.getCanPostAnnounce(ForumCategory category)
Returns true if the page user is authorized to post announcements in the given category, false otherwise. |
boolean |
ForumActionSupport.getCanRead(ForumCategory category)
Returns true if the page user is authorized to view content given category, false otherwise. |
boolean |
ForumActionSupport.isAdmin(ForumCategory category)
Returns true if the page user is an administrator of the specified category, false otherwise. |
boolean |
ForumActionSupport.isModerator(ForumCategory category)
Returns true if the page user is a moderator of the specified category. |
void |
PollPostAction.setCategory(ForumCategory category)
Sets the category to work with. |
protected void |
ReadAction.setCategory(ForumCategory category)
Sets the forum to load. |
void |
ForumCategoryAware.setForumCategory(ForumCategory category)
|
void |
PostAction.setForumCategory(ForumCategory category)
|
Uses of ForumCategory in com.jivesoftware.forum.action.rss |
---|
Methods in com.jivesoftware.forum.action.rss that return ForumCategory | |
---|---|
ForumCategory |
RSSAnnouncements.getCategory()
Returns the requested category or null if one was not specified. |
ForumCategory |
RSSMessages.getCategory()
|
Uses of ForumCategory in com.jivesoftware.forum.database |
---|
Classes in com.jivesoftware.forum.database that implement ForumCategory | |
---|---|
class |
DbForumCategory
Database implementation of the ForumCategory interface. |
Methods in com.jivesoftware.forum.database that return ForumCategory | |
---|---|
ForumCategory |
DbForumCategory.createCategory(java.lang.String name,
java.lang.String description)
|
ForumCategory |
DbForum.getForumCategory()
|
ForumCategory |
DbForumFactory.getForumCategory(long categoryID)
|
ForumCategory |
DbForumCategory.getParentCategory()
|
protected ForumCategory |
DbForumCategory.getParentCategory(java.sql.Connection con)
|
ForumCategory |
DbForumFactory.getRootForumCategory()
|
Methods in com.jivesoftware.forum.database with parameters of type ForumCategory | |
---|---|
static java.lang.String |
DbForum.convertToNNTP(java.lang.String forumName,
ForumCategory category)
Returns the NNTP name of a forum. |
Announcement |
DbAnnouncementManager.createAnnouncement(User user,
ForumCategory category)
|
Forum |
DbForumFactory.createForum(java.lang.String name,
java.lang.String description,
ForumCategory category)
|
Watch |
DbWatchManager.createWatch(User user,
ForumCategory category)
|
void |
DbForumCategory.deleteCategory(ForumCategory forumCategory)
|
java.lang.String[] |
DbTagManager.getCategoryTags(ForumCategory forumCategory)
|
long[] |
PostCountStatusLevelCalculator.getLeaderIds(ForumCategory category,
int startIndex,
int numResults)
|
long[] |
RewardStatusLevelCalculator.getLeaderIds(ForumCategory category,
int startIndex,
int numResults)
|
java.util.Iterator |
DbStatusLevelManager.getLeaders(ForumCategory category)
|
java.util.Iterator |
DbStatusLevelManager.getLeaders(ForumCategory category,
int startIndex,
int numResults)
|
int |
DbStatusLevelManager.getPointLevel(User user,
ForumCategory category)
|
int |
PostCountStatusLevelCalculator.getPointLevel(User user,
ForumCategory category)
|
int |
RewardStatusLevelCalculator.getPointLevel(User user,
ForumCategory category)
|
int |
DbRewardManager.getPointsEarned(User user,
ForumCategory category)
|
java.util.Iterator |
DbTagManager.getPopularTags(ForumCategory forumCategory)
Returns an iterable collection of popular tags based on the current community and tag set. |
int |
DbAnnouncementManager.getRecursiveAnnouncementCount(ForumCategory category)
|
java.util.Iterator |
DbAnnouncementManager.getRecursiveAnnouncements(ForumCategory category,
int startIndex,
int numResults)
|
int |
DbWatchManager.getRecursiveForumWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
DbWatchManager.getRecursiveForumWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
int |
DbWatchManager.getRecursiveThreadWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
DbWatchManager.getRecursiveThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
StatusLevel |
DbStatusLevelManager.getStatusLevel(User user,
ForumCategory category)
|
java.util.Iterator |
DbWatchManager.getThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
java.util.Iterator |
DbRewardManager.getTopUsers(int startIndex,
int numResults,
ForumCategory category)
|
int |
DbReadTracker.getUnreadMessageCount(User user,
ForumCategory category)
|
java.util.Iterator |
DbReadTracker.getUnreadMessages(User user,
ForumCategory category)
|
int |
DbReadTracker.getUnreadThreadCount(User user,
ForumCategory category)
|
java.util.Iterator |
DbReadTracker.getUnreadThreads(User user,
ForumCategory category)
|
Watch |
DbWatchManager.getWatch(User user,
ForumCategory category)
|
int |
DbWatchManager.getWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
DbWatchManager.getWatches(User user,
ForumCategory category)
|
java.util.Iterator |
DbWatchManager.getWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
boolean |
DbWatchManager.isWatched(User user,
ForumCategory category)
|
void |
DbReadTracker.markRead(User user,
ForumCategory category)
|
void |
DbForumCategory.moveCategory(ForumCategory category,
ForumCategory destinationCategory)
|
void |
DbForumCategory.moveForum(Forum forum,
ForumCategory destinationCategory)
|
void |
DbForumCategory.setCategoryIndex(ForumCategory category,
int newIndex)
|
Constructors in com.jivesoftware.forum.database with parameters of type ForumCategory | |
---|---|
DbForum(java.lang.String name,
java.lang.String description,
ForumCategory category)
Creates a new forum with the specified name and description. |
Uses of ForumCategory in com.jivesoftware.forum.event |
---|
Methods in com.jivesoftware.forum.event that return ForumCategory | |
---|---|
ForumCategory |
CategoryEvent.getCategory()
Returns the ForumCategory that the event corresponds to. |
Constructors in com.jivesoftware.forum.event with parameters of type ForumCategory | |
---|---|
CategoryEvent(int eventType,
ForumCategory category,
java.util.Map params)
Creates a new forum event. |
Uses of ForumCategory in com.jivesoftware.forum.everywhere.action |
---|
Methods in com.jivesoftware.forum.everywhere.action that return ForumCategory | |
---|---|
ForumCategory |
CommunityEverywhereSettings.getRootCategory()
|
Uses of ForumCategory in com.jivesoftware.forum.expert |
---|
Methods in com.jivesoftware.forum.expert that return ForumCategory | |
---|---|
ForumCategory |
OpenQuestionAlertSettings.getCategory()
Returns the ForumCategory for which this instance holds open email alert settings. |
Uses of ForumCategory in com.jivesoftware.forum.proxy |
---|
Classes in com.jivesoftware.forum.proxy that implement ForumCategory | |
---|---|
class |
ForumCategoryProxy
A protection proxy for ForumCategories. |
Methods in com.jivesoftware.forum.proxy that return ForumCategory | |
---|---|
ForumCategory |
ForumCategoryProxy.createCategory(java.lang.String name,
java.lang.String description)
|
ForumCategory |
ForumProxy.getForumCategory()
|
ForumCategory |
ForumFactoryProxy.getForumCategory(long categoryID)
|
ForumCategory |
ForumCategoryProxy.getParentCategory()
|
ForumCategory |
ForumFactoryProxy.getRootForumCategory()
|
Methods in com.jivesoftware.forum.proxy with parameters of type ForumCategory | |
---|---|
Announcement |
AnnouncementManagerProxy.createAnnouncement(User user,
ForumCategory category)
|
Forum |
ForumFactoryProxy.createForum(java.lang.String name,
java.lang.String description,
ForumCategory category)
|
Watch |
WatchManagerProxy.createWatch(User user,
ForumCategory category)
|
void |
ForumCategoryProxy.deleteCategory(ForumCategory forumCategory)
|
java.util.Iterator |
StatusLevelManagerProxy.getLeaders(ForumCategory category)
|
java.util.Iterator |
StatusLevelManagerProxy.getLeaders(ForumCategory category,
int startIndex,
int numResults)
|
int |
StatusLevelManagerProxy.getPointLevel(User user,
ForumCategory category)
|
int |
RewardManagerProxy.getPointsEarned(User user,
ForumCategory category)
|
int |
AnnouncementManagerProxy.getRecursiveAnnouncementCount(ForumCategory category)
|
java.util.Iterator |
AnnouncementManagerProxy.getRecursiveAnnouncements(ForumCategory category,
int startIndex,
int numResults)
|
int |
WatchManagerProxy.getRecursiveForumWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
WatchManagerProxy.getRecursiveForumWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
int |
WatchManagerProxy.getRecursiveThreadWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
WatchManagerProxy.getRecursiveThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
StatusLevel |
StatusLevelManagerProxy.getStatusLevel(User user,
ForumCategory category)
|
java.util.Iterator |
WatchManagerProxy.getThreadWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
java.util.Iterator |
RewardManagerProxy.getTopUsers(int startIndex,
int numResults,
ForumCategory category)
|
int |
ReadTrackerProxy.getUnreadMessageCount(User user,
ForumCategory category)
|
java.util.Iterator |
ReadTrackerProxy.getUnreadMessages(User user,
ForumCategory category)
|
int |
ReadTrackerProxy.getUnreadThreadCount(User user,
ForumCategory category)
|
java.util.Iterator |
ReadTrackerProxy.getUnreadThreads(User user,
ForumCategory category)
|
Watch |
WatchManagerProxy.getWatch(User user,
ForumCategory category)
|
int |
WatchManagerProxy.getWatchCount(User user,
ForumCategory category)
|
java.util.Iterator |
WatchManagerProxy.getWatches(User user,
ForumCategory category)
|
java.util.Iterator |
WatchManagerProxy.getWatches(User user,
ForumCategory category,
int startIndex,
int numResults)
|
boolean |
WatchManagerProxy.isWatched(User user,
ForumCategory category)
|
void |
ReadTrackerProxy.markRead(User user,
ForumCategory category)
|
void |
ForumCategoryProxy.moveCategory(ForumCategory forumCategory,
ForumCategory destinationCategory)
|
void |
ForumCategoryProxy.moveForum(Forum forum,
ForumCategory destinationCategory)
|
void |
ForumCategoryProxy.setCategoryIndex(ForumCategory forumCategory,
int newIndex)
|
Constructors in com.jivesoftware.forum.proxy with parameters of type ForumCategory | |
---|---|
ForumCategoryProxy(ForumCategory category,
AuthToken authToken,
Permissions permissions)
Creates a new ForumCategoryProxy object. |
Uses of ForumCategory in com.jivesoftware.forum.stats |
---|
Methods in com.jivesoftware.forum.stats with parameters of type ForumCategory | |
---|---|
void |
ViewCountManager.addCategoryCount(ForumCategory category)
Increments the view count of the given category by 1 or does nothing if view counts are not enabled. |
void |
ViewCountManager.clearCount(ForumCategory category)
Resets the read count for the given category to 0 or does nothing if view counts are not enabled. |
int |
ViewCountManager.getCategoryCount(ForumCategory category)
Returns the number of times the given object has been read or -1 if view counts are not enabled. |
Uses of ForumCategory in com.jivesoftware.forum.util |
---|
Methods in com.jivesoftware.forum.util with parameters of type ForumCategory | |
---|---|
static boolean |
SkinUtils.isNew(ForumCategory category,
java.util.Date time)
Returns true if the category has been modified since the specified time. |
static boolean |
AdminUtils.parentCatHasReadPerm(ForumCategory rootCat,
ForumCategory cat,
Group group)
Returns true if any parent category of the specified category has read access to the group. |
static java.lang.String |
AdminUtils.printParentCategories(ForumCategory category,
java.lang.String delim)
Prints the list of parent categories in top-down order delimited by the given delimiter. |
Uses of ForumCategory in com.jivesoftware.forum.webservices.server |
---|
Methods in com.jivesoftware.forum.webservices.server with parameters of type ForumCategory | |
---|---|
static ForumCategory |
WSUtil.convert(ForumCategory category)
Converts a ForumCategory object to a webservice ForumCategory object. |
|
Jive Forums Project Page | |||||||||
PREV NEXT | FRAMES NO FRAMES |