Jive Forums API (5.5.20.2-oracle) Developer Javadocs

Package com.jivesoftware.forum

Core interfaces and classes for Jive Forums.

See:
          Description

Interface Summary
Announcement Alerts users to important information.
AnnouncementManager Manages announcements, including viewing, creating, and deleting them.
ArchiveManager Manages the archive feature of Jive Forums.
Attachment An object that encapsulates a message attachment.
AttachmentManager Manages attachment settings.
Avatar An object that represents a user's avatar.
AvatarManager Manages the avatar feature.
ContentRetrieval Interface for accessing threads, messages, documents, and blog posts - all the fundamental content elements in the system.
ContentTag Container for tags associated with a blog.
Draft  
DraftManager Manages the draft features of Jive Forums.
Forum A container for a list of threads.
ForumCategory A container for forums and a hierarchy of other forum categories.
ForumMessage A ForumMessage encapsulates message data.
ForumThread A ForumThread is a container for a hierarchy of ForumMessages.
InterceptorManager Manages interceptors.
JiveContentObject  
MessageInterceptor A message interceptor encapsulates an action that is invoked on a message immediately before or after it is added to the system and also when the message subject or body is being edited.
PrivateMessage Private messages are used for user to user communication.
PrivateMessageFolder Holds private messages.
PrivateMessageManager Manages the private message feature.
Query Encapsulates a search for content in a forum.
QueryLogger This manager provides methods to retrieve query objects previously used for searching either the whole system or just in particular forums.
QueryManager This manager provides methods to create query objects to be used for searching either the whole system or just in particular forums.
Rating A container object for Ratings.
RatingManager Provides optional rating of forum messages.
ReadTracker Provides optional tracking of the messages and threads that each user has read.
RewardManager Manages the reward points that users can trade back and forth when answerings questions.
SearchManager Manages the search feature of Jive Forums by defining properties of the search indexer.
StatusLevel Represents a status Level in the system.
StatusLevelCalculator Defines methods need to calculate status levels and leaders.
StatusLevelManager Manages status level feature.
Taggable  
TagManager  
TreeWalker Allows hierarchical navigation of a Thread.
Watch A watch is a way for a user to track updates to an object.
WatchManager Manages watches on categories, forums, and threads.
 

Class Summary
AvatarManagerFactory Used to create Managers for Avatar feature.
DraftImpl Data transfer object, ferries data between DWR and the database layer.
ForumFactory A ForumFactory provides access to and management of Forums.
ForumLocaleManager A Forums instance of LocaleManager.
ForumMessageIterator An iterator for ForumMessages that allows backwards and forwards iteration, as well as setting an index into the Iteration.
ForumPermissions Defines permissions specific to the Jive Forums product.
ForumsLicenseUtils Subclass of product manager that provides helper methods for forums specific functionality
ForumsLicenseUtils.Editions Possible forums addition constants
ForumsProductProvider Provides product information for Jive Forums
ForumThreadIterator An iterator for ForumThreads that allows backwards and forwards iteration, as well as setting an index into the Iteration.
QueryLoggerFactory A factory that returns a concrete instance of a query logger.
QueryResult Encapsulates a search result resulting from a search using the Query class.
RatingManagerFactory A factory that returns a concrete instance of a rating manager.
ResultFilter Filters and sorts lists of threads and messages.
StatusLevelManagerFactory A factory that returns a concrete instance of StatusLevelManager
StatusLevelManagerFactory.StatusCalculatorPropertyListener Checks to see if the calculator implementation has changes and reinitializes it if it has been
TagDelegator  
TagManagerFactory  
TagResultFilter  
 

Exception Summary
AnnouncementNotFoundException Thrown if a nonexistant Announcement was attempting to be loaded.
AttachmentException  
AttachmentNotFoundException Thrown if a attempting to load an Attachment fails.
AvatarException Thrown if there are problems with creation of Avatars
AvatarNotFoundException Thrown when trying to acquire an avatar that does not exist
ForumCategoryNotFoundException  
ForumMessageNotFoundException Thrown if a nonexistant ForumMessage was attempting to be loaded.
ForumNotFoundException  
ForumThreadNotFoundException Thrown if a nonexistant ForumThread was attempting to be loaded.
MessageRejectedException Thrown by a MessageInterceptor when a message is prevented from being posted.
NameAlreadyExistsException  
PrivateMessageFolderNotFoundException  
PrivateMessageNotFoundException Thrown when a private message could not be loaded.
PrivateMessageRejectedException Thrown when a private is prevented from being posted.
RewardException Thrown when an error occurs during a failed operation in the RewardManager.
StatusLevelAlreadyExistsException Thrown when attempting to create a status level that already exists in the system
StatusLevelException The StatusLevelException is thrown by the StatusLevel class.
StatusLevelNotFoundException Thrown by StatusLevelManager when attempting to acquire or perform an operation on a status level that does not exist.
TagAlreadyExistsException Thrown when attempting to create a tag that already exists.
TagObjectNotFoundException Thrown if the specified tag object was not found.
 

Package com.jivesoftware.forum Description

Core interfaces and classes for Jive Forums.


Jive Forums Project Page

Copyright © 1999-2006 Jive Software.