Jive Forums API (5.5.20.2-oracle) Core Javadocs

Uses of Interface
com.jivesoftware.forum.Forum

Packages that use Forum
com.jivesoftware.forum Core interfaces and classes for Jive Forums. 
com.jivesoftware.forum.event Provides mechanisms to be notified of actions in the system such as new messages being created. 
 

Uses of Forum in com.jivesoftware.forum
 

Methods in com.jivesoftware.forum that return Forum
abstract  Forum ForumFactory.createForum(java.lang.String name, java.lang.String description)
          Creates a new forum.
abstract  Forum ForumFactory.createForum(java.lang.String name, java.lang.String description, ForumCategory category)
          Creates a new forum in the specified category.
 Forum ArchiveManager.getArchiveForum(Forum forum)
          Returns the "archive forum" for the specified forum.
 Forum ForumMessage.getForum()
          Returns the forum this message belongs to.
 Forum ForumThread.getForum()
          Returns the forum this thread belongs to.
abstract  Forum ForumFactory.getForum(long forumID)
          Returns the forum with the specified forumID.
abstract  Forum ForumFactory.getForum(java.lang.String nntpName)
          Returns the forum with the specified NNTP name.
 

Methods in com.jivesoftware.forum with parameters of type Forum
 Announcement AnnouncementManager.createAnnouncement(User user, Forum forum)
          Creates a new forum announcement.
abstract  Query ForumFactory.createQuery(Forum[] forums)
          Creates a query object to search through the specified list of forums.
 Query QueryManager.createQuery(Forum[] forums)
          Creates a query object to search through the specified array of forums.
 Watch WatchManager.createWatch(User user, Forum forum)
          Create a watch on a forum for the specified user.
 void ForumCategory.deleteForum(Forum forum)
          Deletes a forum and all of its content.
abstract  void ForumFactory.deleteForum(Forum forum)
          Deprecated. the ForumCategory.deleteForum(Forum) method should now be used instead of this method.
 int ArchiveManager.getArchiveDays(Forum forum)
          Returns the number of days that threads in forum must be inactive before being archived.
 Forum ArchiveManager.getArchiveForum(Forum forum)
          Returns the "archive forum" for the specified forum.
 int ArchiveManager.getArchiveMode(Forum forum)
          Returns the archive mode for the forum.
 long[] StatusLevelCalculator.getLeaderIds(Forum forum, int startIndex, int numResults)
          Returns a long array of user ids of forum leaders
 java.util.Iterator StatusLevelManager.getLeaders(Forum forum)
          Returns an Iterator of leaders for a specific forum
 java.util.Iterator StatusLevelManager.getLeaders(Forum forum, int startIndex, int numResults)
          Returns an Iterator of leaders for a specific forum
 int StatusLevelCalculator.getPointLevel(User user, Forum forum)
          Returns the status level points for a user in regards to a specific forum
 int StatusLevelManager.getPointLevel(User user, Forum forum)
          Returns the status level points for a user in regards to a specific forum
 int RewardManager.getPointsEarned(User user, Forum forum)
          Returns the total number of points the user has earned in a particular forum.
 int Query.getResultForumCount(Forum forum)
          Returns the number of results in the search that match the given forum.
 int Query.getResultForumCountByThread(Forum forum)
          Returns the number of results in the search that match the given forum where search results are grouped by thread.
 StatusLevel StatusLevelManager.getStatusLevel(User user, Forum forum)
          Returns the status level for a user in a specific forum. if a status level cannot be determined for this user in this forum null will be returned.
 java.util.Iterator RewardManager.getTopUsers(int startIndex, int numResults, Forum forum)
          Returns an iterator for the top point earners in a forum.
 int ReadTracker.getUnreadMessageCount(User user, Forum forum)
          Returns the count of unread messages that the user has in the forum.
 java.util.Iterator ReadTracker.getUnreadMessages(User user, Forum forum)
          Returns an iterator for the unread messages in the forum.
 int ReadTracker.getUnreadThreadCount(User user, Forum forum)
          Returns the count of unread threads that the user has in the forum.
 java.util.Iterator ReadTracker.getUnreadThreads(User user, Forum forum)
          Returns an iterator for the unread threads in the forum.
 Watch WatchManager.getWatch(User user, Forum forum)
          Returns a watch on a particular forum, or null if there isn't a watch.
 int WatchManager.getWatchCount(User user, Forum forum)
          Return the count of all thread watches in a particular forum for the given user.
 java.util.Iterator WatchManager.getWatches(User user, Forum forum)
          Returns an Iterator for all the thread objects a user is watching in a forum.
 java.util.Iterator WatchManager.getWatches(User user, Forum forum, int startIndex, int numResults)
          Returns all the ForumThreads watched by the User under the given Forum.
 boolean ArchiveManager.isArchivingEnabled(Forum forum)
          Returns true if archiving is enabled for the specified forum.
 boolean WatchManager.isWatched(User user, Forum forum)
          Returns true if the user is watching the specified forum.
 void ReadTracker.markRead(User user, Forum forum)
          Marks an entire forum as read up until the current instant in time.
abstract  void ForumFactory.mergeForums(Forum forum1, Forum forum2)
          Merges the content of two forums by copying the threads from forum2 to forum1.
 void ForumCategory.moveForum(Forum forum, ForumCategory destinationCategory)
          Moves a forum from this category to another.
 void Forum.moveThread(ForumThread thread, Forum newForum)
          Moves a thread from one forum to another.
 void SearchManager.removeFromIndex(Forum forum)
          Removes a forum from the index.
 void ArchiveManager.setArchiveDays(Forum forum, int days)
          Sets the number of days that threads in forum must be inactive before being archived.
 void ArchiveManager.setArchiveForum(Forum forum, Forum archiveForum)
          Sets the "archive forum" for the specified forum.
 void ArchiveManager.setArchiveMode(Forum forum, int mode)
          Returns the archive mode for the forum.
 void ArchiveManager.setArchivingEnabled(Forum forum, boolean enabled)
          Enables or disables archiving for the specified forum.
 void ForumCategory.setForumIndex(Forum forum, int newIndex)
          Sets the index of the forum in the category.
 

Uses of Forum in com.jivesoftware.forum.event
 

Methods in com.jivesoftware.forum.event that return Forum
 Forum ForumEvent.getForum()
          Returns the Forum that the event corresponds to.
 

Constructors in com.jivesoftware.forum.event with parameters of type Forum
ForumEvent(int eventType, Forum forum, java.util.Map params)
          Creates a new forum event.
 


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.