Index (Jive Forums API (5.5.8) Core Javadocs)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jive Forums API (5.5.8) Core Javadocs

PREV NEXT

FRAMES NO FRAMES

A B C D E F G H I J K L M N O P Q R S T U V W

A

ABUSE - Static variable in class com.jivesoftware.base.JiveConstants
activeAvatarCache - Static variable in class com.jivesoftware.forum.AvatarManagerFactory
addActiveAvatarToCache(Avatar, User) - Static method in class com.jivesoftware.forum.AvatarManagerFactory: Adds an avatar to the active avatar caches for a specific user
addAdministrator(User) - Method in interface com.jivesoftware.base.Group: Grants administrator privileges of the group to a user.
addAllowedType(String) - Method in interface com.jivesoftware.forum.AttachmentManager: Adds a content type to the list of explicitly allowed types.
addAnnouncement(Announcement) - Method in interface com.jivesoftware.forum.AnnouncementManager: Adds an an announcement to the database.
addAnonymousUserPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Add a permission of the specified PermissionType for anonymous users.
addAnonymousVote(int, String) - Method in interface com.jivesoftware.base.Poll: Add a guest vote for an option in the poll.
addBankPoints(User, int) - Method in interface com.jivesoftware.forum.RewardManager: Allows administrators to add or substract an arbitrary number of reward points from a user's point bank.
addBankPoints(int) - Method in interface com.jivesoftware.forum.RewardManager: Allows administrators to add or substract an arbitrary number of reward points from all user's point banks.
addDisallowedType(String) - Method in interface com.jivesoftware.forum.AttachmentManager: Adds a content type to the list of explicitly disallowed types.
addFilterRenderTypes(String, List) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Adds a set of render types for the given filter.
addGroupPermission(Group, PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Grants a group a particular permission.
addHelpfulAnswer(ForumMessage) - Method in interface com.jivesoftware.forum.Question: Marks the specified message as a helpful answer to this question.
addInterceptor(int, MessageInterceptor) - Method in interface com.jivesoftware.forum.InterceptorManager: Inserts a new interceptor at specified index in the list of currently configured interceptors.
addInterceptorClass(String) - Method in interface com.jivesoftware.forum.InterceptorManager: Installs a new class into the list of available interceptors for the system.
ADDITIVE - Static variable in class com.jivesoftware.base.PermissionType: The additive permission type indicates that the permission should be 'added' to the permissions retrieved from a parent object(s).
addListener(GroupListener) - Method in class com.jivesoftware.base.event.GroupEventDispatcher
addListener(JivePropertyListener) - Method in class com.jivesoftware.base.event.JivePropertyEventDispatcher: Registers a listener with this event dispatcher
addListener(LogListener) - Method in class com.jivesoftware.base.event.LogEventDispatcher
addListener(PollListener) - Method in class com.jivesoftware.base.event.PollEventDispatcher: Adds an event listener to the dispatcher.
addListener(UserListener) - Method in class com.jivesoftware.base.event.UserEventDispatcher
addListener(GroupListener) - Static method in class com.jivesoftware.base.GroupManagerFactory: Method used internally by Jive.
addListener(UserListener) - Static method in class com.jivesoftware.base.UserManagerFactory: Method used internally by Jive.
addListener(AnnouncementListener) - Method in class com.jivesoftware.forum.event.AnnouncementEventDispatcher
addListener(CategoryListener) - Method in class com.jivesoftware.forum.event.CategoryEventDispatcher
addListener(ForumListener) - Method in class com.jivesoftware.forum.event.ForumEventDispatcher
addListener(MessageListener) - Method in class com.jivesoftware.forum.event.MessageEventDispatcher
addListener(PrivateMessageListener) - Method in class com.jivesoftware.forum.event.PrivateMessageEventDispatcher
addListener(QuestionListener) - Method in class com.jivesoftware.forum.event.QuestionEventDispatcher
addListener(SearchIndexListener) - Method in class com.jivesoftware.forum.event.SearchIndexEventDispatcher
addListener(ThreadListener) - Method in class com.jivesoftware.forum.event.ThreadEventDispatcher
addListener(ProfileSearchIndexListener) - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEventDispatcher
addMember(User) - Method in interface com.jivesoftware.base.Group: Adds a member to the group.
addMessage(ForumMessage, ForumMessage) - Method in interface com.jivesoftware.forum.ForumThread: Adds a new message to this thread.
addOption(String) - Method in interface com.jivesoftware.base.Poll: Add a new option to the poll.
addProperty(String, String) - Method in class com.jivesoftware.forum.QuestionFilter: Adds a property to the list of properties that will be filtered on.
addProperty(String, String) - Method in class com.jivesoftware.forum.ResultFilter: Adds a property to the list of properties that will be filtered on.
addRating(User, ForumMessage, Rating) - Method in interface com.jivesoftware.forum.RatingManager: Add a rating to the forum message.
addRating(User, ForumThread, Rating) - Method in interface com.jivesoftware.forum.RatingManager: Add a rating to the forum thread.
addRecipient(EmailMessage.EmailAddress) - Method in class com.jivesoftware.base.EmailMessage: Adds a recipient (to address) for this email message
addRecipient(String, String) - Method in class com.jivesoftware.base.EmailMessage: Adds a recipient (to address) for this email message
addRegisteredUserPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Add a permission of the specified PermissionType for registered users.
addRenderFilter(String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Installs a new class into the list of render filters for the system.
addResolutionState(Question.State) - Method in class com.jivesoftware.forum.QuestionFilter: Adds a resolution state to the set of states that will be included in filtered results.
addResolutionState(Question.State) - Method in class com.jivesoftware.forum.ResultFilter: Adds a resolution state to the set of states that will be included in filtered results.
addTag(ContentTag) - Method in class com.jivesoftware.forum.ResultFilter: Adds a ContentTag to the list of tags to filter on.
addTag(ContentTag, JiveContentObject) - Method in interface com.jivesoftware.forum.TagManager: Associates a tag with this object
addText(String) - Method in class com.jivesoftware.forum.renderer.RenderedTextStore: Add a text snippet to the store receiving a token in return.
addTextExtractor(String) - Method in interface com.jivesoftware.forum.SearchManager: Installs a new class into the list of available text extractors for the system.
addThread(ForumThread) - Method in interface com.jivesoftware.forum.Forum: Adds a new thread to the forum.
addToIndex(ForumMessage) - Method in interface com.jivesoftware.forum.SearchManager: Adds an individual message to the index.
addToIndex(User) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Adds an individual user to the index.
addUser(User) - Method in interface com.jivesoftware.base.Roster: Add a user to the roster.
addUserPermission(User, PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Add a permission of the specified PermissionType for the specified user.
addUserVote(int, User) - Method in interface com.jivesoftware.base.Poll: Add a user vote for an option in the poll.
AdvancedUserManager - Interface in com.jivesoftware.base: An advanced user manager which currently has a single method to retrieve a user from a given email address.
ALLOW_ANONYMOUS_VOTE_MODIFICATION - Static variable in interface com.jivesoftware.base.Poll: Mode to allow guests to change their vote after casting the vote.
ALLOW_USER_VOTE_MODIFICATION - Static variable in interface com.jivesoftware.base.Poll: Mode to allow users to change their vote after casting the vote.
allowedTypes() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns an Iterator for the list of explicitly allowed types.
AND_MODE - Static variable in class com.jivesoftware.forum.ResultFilter: 'AND' mode.
ANNOUNCEMENT - Static variable in class com.jivesoftware.base.JiveConstants
Announcement - Interface in com.jivesoftware.forum: Alerts users to important information.
ANNOUNCEMENT_ADMIN - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create, delete, and schedule announcements.
ANNOUNCEMENT_CREATED - Static variable in class com.jivesoftware.forum.event.AnnouncementEvent: Announcement was added to the system.
ANNOUNCEMENT_DELETED - Static variable in class com.jivesoftware.forum.event.AnnouncementEvent: Announcement was deleted.
ANNOUNCEMENT_MODIFIED - Static variable in class com.jivesoftware.forum.event.AnnouncementEvent: The announcement was modified.
announcementCreated(AnnouncementEvent) - Method in interface com.jivesoftware.forum.event.AnnouncementListener: Fired when an announcement has been added to the system.
announcementDeleted(AnnouncementEvent) - Method in interface com.jivesoftware.forum.event.AnnouncementListener: Fired when an announcement is about to be deleted from the system.
AnnouncementEvent - Class in com.jivesoftware.forum.event: An event for Announcement objects.
AnnouncementEvent(int, Announcement, Map) - Constructor for class com.jivesoftware.forum.event.AnnouncementEvent: Creates a new announcement event.
AnnouncementEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for announcement events.
AnnouncementListener - Interface in com.jivesoftware.forum.event: Listener for announcement events.
AnnouncementManager - Interface in com.jivesoftware.forum: Manages announcements, including viewing, creating, and deleting them.
announcementModified(AnnouncementEvent) - Method in interface com.jivesoftware.forum.event.AnnouncementListener: Fired when portions of an announcement have been modified.
AnnouncementNotFoundException - Exception in com.jivesoftware.forum: Thrown if a nonexistant Announcement was attempting to be loaded.
AnnouncementNotFoundException() - Constructor for exception com.jivesoftware.forum.AnnouncementNotFoundException
AnnouncementNotFoundException(String) - Constructor for exception com.jivesoftware.forum.AnnouncementNotFoundException
ANONYMOUS - Static variable in class com.jivesoftware.base.JiveConstants
ANONYMOUS_VOTE_ADDED - Static variable in class com.jivesoftware.base.event.PollEvent: An anonymous vote was added to the poll.
ANONYMOUS_VOTE_MODIFIED - Static variable in class com.jivesoftware.base.event.PollEvent: An anonymous vote was modified.
ANONYMOUS_VOTE_REMOVED - Static variable in class com.jivesoftware.base.event.PollEvent: An anonymous vote was removed.
anonymousUserHasPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns true if the anonymous users have a particular permission.
anonymousVoteAdded(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when an anonymous vote is added to a poll.
anonymousVoteModified(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when an anonymous poll vote is modified.
anonymousVoteRemoved(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when an anonymous poll vote is removed.
ArchiveManager - Interface in com.jivesoftware.forum: Manages the archive feature of Jive Forums.
ASCENDING - Static variable in interface com.jivesoftware.forum.Query: Ascending sort (ie 3, 4, 5...).
ASCENDING - Static variable in class com.jivesoftware.forum.QuestionFilter: Ascending sort (ie 3, 4, 5...).
ASCENDING - Static variable in class com.jivesoftware.forum.ResultFilter: Ascending sort (ie 3, 4, 5...).
assumed_resolved - Static variable in class com.jivesoftware.forum.Question.State: The question is answered, but the question creator has not indicated that the question is resolved.
ATTACHMENT - Static variable in class com.jivesoftware.base.JiveConstants
Attachment - Interface in com.jivesoftware.forum: An object that encapsulates a message attachment.
AttachmentException - Exception in com.jivesoftware.forum
AttachmentException(String) - Constructor for exception com.jivesoftware.forum.AttachmentException
AttachmentException(int, String) - Constructor for exception com.jivesoftware.forum.AttachmentException
AttachmentException(int, Throwable, String) - Constructor for exception com.jivesoftware.forum.AttachmentException
AttachmentManager - Interface in com.jivesoftware.forum: Manages attachment settings.
AttachmentNotFoundException - Exception in com.jivesoftware.forum: Thrown if a attempting to load an Attachment fails.
AttachmentNotFoundException() - Constructor for exception com.jivesoftware.forum.AttachmentNotFoundException
AttachmentNotFoundException(String) - Constructor for exception com.jivesoftware.forum.AttachmentNotFoundException
AuthFactory - Class in com.jivesoftware.base: An abstract class that defines a framework for providing authentication services in Jive.
AuthFactory() - Constructor for class com.jivesoftware.base.AuthFactory
AuthToken - Interface in com.jivesoftware.base: Proves that a user has successfully logged in.
AVATAR - Static variable in class com.jivesoftware.base.JiveConstants
Avatar - Interface in com.jivesoftware.forum: An object that represents a user's avatar.
AVATAR - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create and delete avatars
AVATAR_ENABLE_PROPERTY - Static variable in class com.jivesoftware.forum.AvatarManagerFactory
avatarCache - Static variable in class com.jivesoftware.forum.AvatarManagerFactory
AvatarException - Exception in com.jivesoftware.forum: Thrown if there are problems with creation of Avatars
AvatarException() - Constructor for exception com.jivesoftware.forum.AvatarException
AvatarException(String) - Constructor for exception com.jivesoftware.forum.AvatarException
AvatarException(String, Throwable) - Constructor for exception com.jivesoftware.forum.AvatarException
AvatarException(Throwable) - Constructor for exception com.jivesoftware.forum.AvatarException
AvatarException(AttachmentException) - Constructor for exception com.jivesoftware.forum.AvatarException
AvatarManager - Interface in com.jivesoftware.forum: Manages the avatar feature.
AvatarManagerFactory - Class in com.jivesoftware.forum: Used to create Managers for Avatar feature.
AvatarNotFoundException - Exception in com.jivesoftware.forum: Thrown when trying to acquire an avatar that does not exist
AvatarNotFoundException() - Constructor for exception com.jivesoftware.forum.AvatarNotFoundException
AvatarNotFoundException(String) - Constructor for exception com.jivesoftware.forum.AvatarNotFoundException

B

BAD_CONTENT_TYPE - Static variable in exception com.jivesoftware.forum.AttachmentException
BAN - Static variable in class com.jivesoftware.base.JiveConstants
BATCH_EMAIL_WATCH - Static variable in interface com.jivesoftware.forum.Watch: Batch email watch type.
BODY - Static variable in class com.jivesoftware.forum.renderer.RenderType: Type representing a message body.

C

CATEGORY_ADDED - Static variable in class com.jivesoftware.forum.event.CategoryEvent: Category was added.
CATEGORY_DELETING - Static variable in class com.jivesoftware.forum.event.CategoryEvent: Category is about to be deleted.
CATEGORY_MODIFIED - Static variable in class com.jivesoftware.forum.event.CategoryEvent: The category was moved to another category.
CATEGORY_MOVED - Static variable in class com.jivesoftware.forum.event.CategoryEvent: The category was moved to another category.
CATEGORY_QUESTION - Static variable in class com.jivesoftware.base.JiveConstants
categoryAdded(CategoryEvent) - Method in interface com.jivesoftware.forum.event.CategoryListener: Fired when a category has been added to the system.
categoryDeleted(CategoryEvent) - Method in interface com.jivesoftware.forum.event.CategoryListener: Fired when a category is about to be deleted from the system.
CategoryEvent - Class in com.jivesoftware.forum.event: An event for ForumCategory objects.
CategoryEvent(int, ForumCategory, Map) - Constructor for class com.jivesoftware.forum.event.CategoryEvent: Creates a new forum event.
CategoryEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for category events.
CategoryListener - Interface in com.jivesoftware.forum.event: Listener for category events.
categoryModified(CategoryEvent) - Method in interface com.jivesoftware.forum.event.CategoryListener: Fired when a category has been modified.
categoryMoved(CategoryEvent) - Method in interface com.jivesoftware.forum.event.CategoryListener: Fired when a category has been moved from one category to another.
changeAnonymousVote(int, int, String) - Method in interface com.jivesoftware.base.Poll: Change a guest vote.
changeUserVote(int, int, User) - Method in interface com.jivesoftware.base.Poll: Change a user vote.
checkAuthorization(AuthToken, HttpServletRequest) - Method in class com.jivesoftware.base.AuthFactory: Checks if the specified AuthToken is authorized.
checkIfBanned(AuthToken, HttpServletRequest) - Static method in class com.jivesoftware.base.AuthFactory: This will check to see if user is banned.
cipher - Static variable in class com.jivesoftware.base.AuthFactory
clearAvatarFromCache(Avatar) - Static method in class com.jivesoftware.forum.AvatarManagerFactory: Clears an avatar from all the caches
clearResolutionStates() - Method in class com.jivesoftware.forum.QuestionFilter: Removes all resolution states from the set of states that will be included in filtered results.
clearResolutionStates() - Method in class com.jivesoftware.forum.ResultFilter: Removes all resolution states from the set of states that will be included in filtered results.
clearSessionUserInfo(HttpServletRequest, HttpServletResponse) - Method in class com.jivesoftware.base.AuthFactory: Concrete subclasses may wish to override this method to destroy session info as appropriate.
clone() - Method in class com.jivesoftware.forum.QuestionFilter: Clones a ResultFilter
clone() - Method in class com.jivesoftware.forum.ResultFilter: Clones a ResultFilter
com.jivesoftware.base - package com.jivesoftware.base: Base APIs and classes for Jive Software products.
com.jivesoftware.base.event - package com.jivesoftware.base.event: Base events common to all Jive Software products.
com.jivesoftware.forum - package com.jivesoftware.forum: Core interfaces and classes for Jive Forums.
com.jivesoftware.forum.event - package com.jivesoftware.forum.event: Provides mechanisms to be notified of actions in the system such as new messages being created.
com.jivesoftware.forum.renderer - package com.jivesoftware.forum.renderer
com.jivesoftware.profiles - package com.jivesoftware.profiles
com.jivesoftware.profiles.formatter - package com.jivesoftware.profiles.formatter
com.jivesoftware.profiles.search - package com.jivesoftware.profiles.search
com.jivesoftware.profiles.validator - package com.jivesoftware.profiles.validator
compareTo(Object) - Method in class com.jivesoftware.forum.Question.State
CONTAINS_MATCH - Static variable in class com.jivesoftware.forum.ResultFilter: Contains match.
ContentTag - Interface in com.jivesoftware.forum: Container for tags associated with a blog.
COOKIE_AUTOLOGIN - Static variable in class com.jivesoftware.base.AuthFactory: Name of the cookie used to store user info for auto-login purposes.
copyGlobalFilters() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Copy all global filters to the current context.
CORRECT_ANSWER_SET - Static variable in class com.jivesoftware.forum.event.QuestionEvent: A correct answer was added to the question.
correctAnswerAdded(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when a correct answer has been added to the question.
CREATE_MESSAGE - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create a new message.
CREATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create attachments.
CREATE_POLL - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create polls.
CREATE_PRIVATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create attachments in a private message.
CREATE_THREAD - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to create a new thread.
createAnnouncement(User) - Method in interface com.jivesoftware.forum.AnnouncementManager: Creates a new system announcement.
createAnnouncement(User, ForumCategory) - Method in interface com.jivesoftware.forum.AnnouncementManager: Creates a new category announcement.
createAnnouncement(User, Forum) - Method in interface com.jivesoftware.forum.AnnouncementManager: Creates a new forum announcement.
createAnonymousAuthToken() - Method in class com.jivesoftware.base.AuthFactory: Creates anonymous AuthToken tokens.
createAttachment(String, String, InputStream) - Method in interface com.jivesoftware.forum.ForumMessage: Creates a new attachment for this message.
createAttachment(String, String, InputStream) - Method in interface com.jivesoftware.forum.PrivateMessage: Creates a new attachment for this private message.
createAuthToken(String, String) - Method in class com.jivesoftware.base.AuthFactory: Creates AuthToken tokens for users.
createAuthToken(HttpServletRequest, HttpServletResponse) - Method in class com.jivesoftware.base.AuthFactory: Creates AuthToken tokens based on information from servlet request and response objects.
createAvatar(User, String, String, InputStream) - Method in interface com.jivesoftware.forum.AvatarManager: Creates a new avatar for a user allowing the user to specify an inputstream for the image.
createCategory(String, String) - Method in interface com.jivesoftware.forum.ForumCategory: Creates a new ForumCategory as a sub-category of this category using the name and description.
createDefaultContentFilter() - Static method in class com.jivesoftware.forum.ResultFilter: Creates a default ResultFilter: no filtering with results sorted on the modification date.
createDefaultFilter() - Static method in class com.jivesoftware.forum.TagResultFilter: Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.
createDefaultForumFilter() - Static method in class com.jivesoftware.forum.ResultFilter: Creates a default forum ResultFilter: no filtering with results sorted on the category index value.
createDefaultMessageFilter() - Static method in class com.jivesoftware.forum.ResultFilter: Creates a default message ResultFilter: no filtering with results sorted on the message creation date in ascending order.
createDefaultThreadFilter() - Static method in class com.jivesoftware.forum.ResultFilter: Creates a default thread ResultFilter: no filtering with results sorted on the thread modification date.
createDefaultUserMessagesFilter() - Static method in class com.jivesoftware.forum.ResultFilter: Creates a default user messages ResultFilter: no filtering with results sorted on the message creation date descending (newest messages appear first).
createFolder(User, String) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Creates a new folder.
createForum(String, String) - Method in class com.jivesoftware.forum.ForumFactory: Creates a new forum.
createForum(String, String, ForumCategory) - Method in class com.jivesoftware.forum.ForumFactory: Creates a new forum in the specified category.
createGroup(String) - Method in interface com.jivesoftware.base.GroupManager: Factory method for creating a new Group.
createMessage() - Method in interface com.jivesoftware.forum.Forum: Factory method to create a message with an anonymous author.
createMessage(User) - Method in interface com.jivesoftware.forum.Forum: Factory method to create a message as the specified user.
createMessage(User) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Creates a new private message.
createPoll(int, long, User, String) - Method in interface com.jivesoftware.base.PollManager: Create a new Poll.
createPresence(User, String, String) - Method in interface com.jivesoftware.base.PresenceManager: Create a presence for a user.
createQuery() - Method in interface com.jivesoftware.forum.Forum: Creates a query object to search the forum.
createQuery() - Method in class com.jivesoftware.forum.ForumFactory: Creates a query object to search through all forums.
createQuery(Forum[]) - Method in class com.jivesoftware.forum.ForumFactory: Creates a query object to search through the specified list of forums.
createQuery() - Method in interface com.jivesoftware.forum.QueryManager: Creates a query object to search through all forums.
createQuery(Forum[]) - Method in interface com.jivesoftware.forum.QueryManager: Creates a query object to search through the specified array of forums.
createQuestion(ForumThread) - Method in interface com.jivesoftware.forum.QuestionManager: Creates a new question.
createRating(int, String) - Method in interface com.jivesoftware.forum.RatingManager: Create a new rating with the specified attributes.
createSessionUserInfo(String, String, boolean, HttpServletRequest, HttpServletResponse) - Method in class com.jivesoftware.base.AuthFactory: Concrete subclasses may wish to override this method to create session info as appropriate.
createStatusLevel(String, String, int, int) - Method in interface com.jivesoftware.forum.StatusLevelManager: Creates a new points based StatusLevel.
createStatusLevel(String, String, Group) - Method in interface com.jivesoftware.forum.StatusLevelManager: Creates a new group based StatusLevel Level
createTag(String) - Method in interface com.jivesoftware.forum.TagManager: Creates a tag in the database.
createThread(ForumMessage) - Method in interface com.jivesoftware.forum.Forum: Factory method to create a new thread.
createUser(String, String, String) - Method in interface com.jivesoftware.base.UserManager: Factory method for creating a new User with all required values: a password, email address, and unique username.
createUser(String, String, String, String, boolean, boolean, Map) - Method in interface com.jivesoftware.base.UserManager: Factory method for creating a new User with all required AND optional values.
createWatch(User, User) - Method in interface com.jivesoftware.forum.WatchManager: Create a watch on a user for the specified user.
createWatch(User, ForumThread) - Method in interface com.jivesoftware.forum.WatchManager: Create a watch on a thread for the specified user.
createWatch(User, Forum) - Method in interface com.jivesoftware.forum.WatchManager: Create a watch on a forum for the specified user.
createWatch(User, ForumCategory) - Method in interface com.jivesoftware.forum.WatchManager: Create a watch on a category for the specified user.
CREATION_DATE - Static variable in class com.jivesoftware.base.JiveConstants
creation_date - Static variable in class com.jivesoftware.forum.QuestionFilter.SortField
CRONTASK - Static variable in class com.jivesoftware.base.JiveConstants

D

DATE - Static variable in interface com.jivesoftware.forum.Query: Sort by date
DAY - Static variable in class com.jivesoftware.base.JiveConstants: One day (in milliseconds).
debug(String) - Static method in class com.jivesoftware.base.Log
debug(Throwable) - Static method in class com.jivesoftware.base.Log
debug(String, Throwable) - Static method in class com.jivesoftware.base.Log
DEBUG_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent: Event type for whenever a debug log event occurs.
decryptAuthInfo(String) - Static method in class com.jivesoftware.base.AuthFactory: Utility method that decrypts a String built by the encryptAuthInfo method containing a username and password.
DEFAULT - Static variable in exception com.jivesoftware.forum.AvatarException
DELETE_THREADS - Static variable in interface com.jivesoftware.forum.ArchiveManager: An archive mode that specifies that threads should be deleted.
deleteAnnouncement(Announcement) - Method in interface com.jivesoftware.forum.AnnouncementManager: Deletes an announcement.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.forum.Announcement: Deletes an attachment that belongs to the announcement.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.forum.ForumMessage: Deletes an attachment that belongs to this message.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.forum.PrivateMessage: Deletes an attachment that belongs to this private message.
deleteAvatar(Avatar) - Method in interface com.jivesoftware.forum.AvatarManager: Deletes an avatar from the system.
deleteCategory(ForumCategory) - Method in interface com.jivesoftware.forum.ForumCategory: Deletes a sub-category.
deleteFolder(PrivateMessageFolder) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Deletes a folder.
deleteForum(Forum) - Method in interface com.jivesoftware.forum.ForumCategory: Deletes a forum and all of its content.
deleteForum(Forum) - Method in class com.jivesoftware.forum.ForumFactory: Deprecated. the ForumCategory.deleteForum(Forum) method should now be used instead of this method.
deleteGroup(Group) - Method in interface com.jivesoftware.base.GroupManager: Deletes a group from the system.
deleteMessage(ForumMessage) - Method in interface com.jivesoftware.forum.ForumThread: Deletes a message in this thread.
deleteMessage(ForumMessage, boolean) - Method in interface com.jivesoftware.forum.ForumThread: Deletes a message in this thread, optionally recusively deleting child messages.
deleteMessage(PrivateMessage) - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Deletes a private message from the folder by moving it to the trash folder.
deleteOption(int) - Method in interface com.jivesoftware.base.Poll: Remove an option from the poll.
deletePoll(Poll) - Method in interface com.jivesoftware.base.PollManager: Deletes a poll.
deleteProperty(String) - Method in interface com.jivesoftware.base.Group: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.base.User: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.Announcement: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.Attachment: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.Avatar: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.Forum: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.ForumCategory: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.ForumMessage: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.ForumThread: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.Question: Deletes an extended property.
deleteProperty(String) - Method in interface com.jivesoftware.forum.StatusLevel: Deletes an extended property.
deleteQuestion(Question) - Method in interface com.jivesoftware.forum.QuestionManager: Deletes an existing question.
deleteStatusLevel(StatusLevel) - Method in interface com.jivesoftware.forum.StatusLevelManager: Deletes a statusLevel level from the system
deleteThread(ForumThread) - Method in interface com.jivesoftware.forum.Forum: Deletes a thread and all of its messages.
deleteUser(User) - Method in interface com.jivesoftware.base.UserManager: Deletes a user.
deleteWatch(Watch) - Method in interface com.jivesoftware.forum.WatchManager: Delete the specified watch.
deleteWatches(User) - Method in interface com.jivesoftware.forum.WatchManager: Deletes all watches that a user has.
DESCENDING - Static variable in interface com.jivesoftware.forum.Query: Descending sort (ie 3, 2, 1...).
DESCENDING - Static variable in class com.jivesoftware.forum.QuestionFilter: Descending sort (ie 3, 2, 1...).
DESCENDING - Static variable in class com.jivesoftware.forum.ResultFilter: Descending sort (ie 3, 2, 1...).
destroy() - Method in class com.jivesoftware.base.EmailManager
destroy() - Method in class com.jivesoftware.base.GroupManagerFactory
destroy() - Method in class com.jivesoftware.base.PollManagerFactory
destroy() - Method in class com.jivesoftware.base.UserManagerFactory
destroy() - Method in class com.jivesoftware.forum.AvatarManagerFactory
destroy() - Method in class com.jivesoftware.forum.StatusLevelManagerFactory
disallowedTypes() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns an Iterator for the list of explicitly disallowed types.
dispatchEvent(GroupEvent) - Method in class com.jivesoftware.base.event.GroupEventDispatcher
dispatchEvent(JivePropertyEvent) - Method in class com.jivesoftware.base.event.JivePropertyEventDispatcher: Dispatches a new JivePropertyEvent to all of the JivePropertyListener listeners that are registered with this event dispatcher.
dispatchEvent(LogEvent) - Method in class com.jivesoftware.base.event.LogEventDispatcher
dispatchEvent(PollEvent) - Method in class com.jivesoftware.base.event.PollEventDispatcher: Dispatches an event to all listeners.
dispatchEvent(UserEvent) - Method in class com.jivesoftware.base.event.UserEventDispatcher
dispatchEvent(JiveEvent) - Static method in class com.jivesoftware.base.GroupManagerFactory: Method used internally by Jive.
dispatchEvent(JiveEvent) - Static method in class com.jivesoftware.base.UserManagerFactory: Method used internally by Jive.
dispatchEvent(AnnouncementEvent) - Method in class com.jivesoftware.forum.event.AnnouncementEventDispatcher
dispatchEvent(CategoryEvent) - Method in class com.jivesoftware.forum.event.CategoryEventDispatcher
dispatchEvent(ForumEvent) - Method in class com.jivesoftware.forum.event.ForumEventDispatcher
dispatchEvent(MessageEvent) - Method in class com.jivesoftware.forum.event.MessageEventDispatcher
dispatchEvent(PrivateMessageEvent) - Method in class com.jivesoftware.forum.event.PrivateMessageEventDispatcher
dispatchEvent(QuestionEvent) - Method in class com.jivesoftware.forum.event.QuestionEventDispatcher
dispatchEvent(SearchIndexEvent) - Method in class com.jivesoftware.forum.event.SearchIndexEventDispatcher
dispatchEvent(JiveEvent) - Method in class com.jivesoftware.forum.event.ThreadEventDispatcher
dispatchEvent(ProfileSearchIndexEvent) - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEventDispatcher
doDestroy() - Static method in class com.jivesoftware.base.UserManagerFactory: Method used internally by Jive.
doInitialize() - Static method in class com.jivesoftware.base.GroupManagerFactory
doInitialize() - Static method in class com.jivesoftware.base.PollManagerFactory
doInitialize() - Static method in class com.jivesoftware.base.UserManagerFactory
doInitialize() - Static method in class com.jivesoftware.forum.AvatarManagerFactory
doInitialize() - Static method in class com.jivesoftware.forum.renderer.RendererFactory
doInitialize() - Static method in class com.jivesoftware.forum.StatusLevelManagerFactory
DRAFT - Static variable in class com.jivesoftware.base.JiveConstants
drainEmailQueue(List) - Method in class com.jivesoftware.base.EmailManager

E

EMAIL_WATCH - Static variable in interface com.jivesoftware.forum.Watch: Email watch type.
EmailManager - Class in com.jivesoftware.base: Provides ability to send email messages.
EmailMessage - Class in com.jivesoftware.base: Represents an Email message that can be sent using EmailManager
EmailMessage() - Constructor for class com.jivesoftware.base.EmailMessage
EmailMessage.EmailAddress - Class in com.jivesoftware.base: Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com>
EmailMessage.EmailAddress(String, String) - Constructor for class com.jivesoftware.base.EmailMessage.EmailAddress
EMPTY_ITERATOR - Static variable in class com.jivesoftware.forum.ForumMessageIterator: The empty message iterator.
EMPTY_ITERATOR - Static variable in class com.jivesoftware.forum.ForumThreadIterator: The empty thread iterator.
encryptAuthInfo(String, String) - Static method in class com.jivesoftware.base.AuthFactory: Utility method that builds an encrypted String containing a username and password, which is useful for storing as a cookie.
equals(Object) - Method in class com.jivesoftware.base.EmailMessage
equals(Object) - Method in class com.jivesoftware.base.PermissionType
equals(Object) - Method in class com.jivesoftware.forum.event.CategoryEvent: Added this for testing.
equals(Object) - Method in class com.jivesoftware.forum.event.ForumEvent: Added this for testing.
equals(Query) - Method in interface com.jivesoftware.forum.Query: Return true if the query is equal to the current query, false otherwise.
equals(Object) - Method in class com.jivesoftware.forum.QueryResult
equals(Object) - Method in class com.jivesoftware.forum.QuestionFilter
equals(Rating) - Method in interface com.jivesoftware.forum.Rating: Test for equality between two rating objects.
equals(Object) - Method in class com.jivesoftware.forum.ResultFilter
error(String) - Static method in class com.jivesoftware.base.Log
error(Throwable) - Static method in class com.jivesoftware.base.Log
error(String, Throwable) - Static method in class com.jivesoftware.base.Log
ERROR_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent: Event type for whenever an error log event occurs.
EXACT_MATCH - Static variable in class com.jivesoftware.forum.ResultFilter: Exact match.
exclude(long) - Method in class com.jivesoftware.forum.renderer.RenderStrategy
execute(String, RenderContext) - Method in interface com.jivesoftware.forum.renderer.RenderFilter: Applies the filter to the passed in string and returns the filtered string.
execute(String, RenderContext) - Method in interface com.jivesoftware.forum.renderer.RenderMacro: Executes the render macro against the provided string and render context.
EXPIRATION_DATE - Static variable in class com.jivesoftware.base.JiveConstants
EXTENDED_PROPERTY - Static variable in class com.jivesoftware.base.JiveConstants
extended_property - Static variable in class com.jivesoftware.forum.QuestionFilter.SortField

F

FATAL_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent: Event type for whenever a fatal log event occurs.
FILE_NOT_ACCEPTED - Static variable in exception com.jivesoftware.forum.AvatarException
filterOnThread(ForumThread) - Method in interface com.jivesoftware.forum.Query: Restricts the querty results to messages posted in a specified thread.
filterOnUser(User) - Method in interface com.jivesoftware.forum.Query: Restricts the query results to messages posted by a specified user.
fine(Throwable) - Static method in class com.jivesoftware.base.Log
fine(String, Throwable) - Static method in class com.jivesoftware.base.Log
flushLogs() - Static method in class com.jivesoftware.base.Log: This method is used to shutdown the Log class.
FOLDER_DRAFTS - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
FOLDER_INBOX - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
FOLDER_SENT - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
FOLDER_TRASH - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
forceReload() - Static method in class com.jivesoftware.base.AuthFactory: Method used internally by Jive.
format(String, User) - Method in interface com.jivesoftware.profiles.formatter.ProfileFieldFormatter: Format a profile field for display to the end user with the given AuthToken.
FORUM - Static variable in class com.jivesoftware.base.JiveConstants
Forum - Interface in com.jivesoftware.forum: A container for a list of threads.
FORUM_ADDED - Static variable in class com.jivesoftware.forum.event.ForumEvent: Forum was added.
FORUM_ADMIN - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to administer a particular forum.
FORUM_CATEGORY - Static variable in class com.jivesoftware.base.JiveConstants
FORUM_CATEGORY_ADMIN - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to administer a category.
FORUM_CATEGORY_INDEX - Static variable in class com.jivesoftware.base.JiveConstants
FORUM_DELETING - Static variable in class com.jivesoftware.forum.event.ForumEvent: Forum is about to be deleted.
FORUM_MERGED - Static variable in class com.jivesoftware.forum.event.ForumEvent: Another forum was merged into the forum.
FORUM_MODERATION_ABUSE_HIDDEN - Static variable in class com.jivesoftware.base.JiveConstants: Moderation value for messages that have been reported as abusive and should be hidden until the message is reviewed.
FORUM_MODERATION_ABUSE_VISIBLE - Static variable in class com.jivesoftware.base.JiveConstants: Moderation value for messages that have been reported as abusive.
FORUM_MODERATION_HIDDEN - Static variable in class com.jivesoftware.base.JiveConstants: Moderation value at which content is automatically hidden (0).
FORUM_MODERATION_VIRUSSCAN_HIDDEN - Static variable in class com.jivesoftware.base.JiveConstants: The moderation value that messages will be set to while waiting to be scanned for viruses.
FORUM_MODERATION_VISIBLE - Static variable in class com.jivesoftware.base.JiveConstants: Moderation value at which content is automatically visible (1).
FORUM_MODIFIED - Static variable in class com.jivesoftware.forum.event.ForumEvent: Another forum was merged into the forum.
FORUM_MOVED - Static variable in class com.jivesoftware.forum.event.ForumEvent: The forum was moved to another category.
FORUM_NAME - Static variable in class com.jivesoftware.base.JiveConstants
FORUM_QUESTION - Static variable in class com.jivesoftware.base.JiveConstants
FORUM_SEARCH_QUERY - Static variable in class com.jivesoftware.base.JiveConstants
forumAdded(ForumEvent) - Method in interface com.jivesoftware.forum.event.ForumListener: Fired when a forum has been added to the system.
ForumCategory - Interface in com.jivesoftware.forum: A container for forums and a hierarchy of other forum categories.
ForumCategoryNotFoundException - Exception in com.jivesoftware.forum
ForumCategoryNotFoundException() - Constructor for exception com.jivesoftware.forum.ForumCategoryNotFoundException
ForumCategoryNotFoundException(String) - Constructor for exception com.jivesoftware.forum.ForumCategoryNotFoundException
ForumCategoryNotFoundException(String, long) - Constructor for exception com.jivesoftware.forum.ForumCategoryNotFoundException: Creates this exception with a messages and the id of the forum category that could not be found
ForumCategoryNotFoundException(long) - Constructor for exception com.jivesoftware.forum.ForumCategoryNotFoundException: Creates this exception with the id of the forum category that could not be found.
forumDeleted(ForumEvent) - Method in interface com.jivesoftware.forum.event.ForumListener: Fired when a forum is about to be deleted from the system.
ForumEvent - Class in com.jivesoftware.forum.event: An event for Forum objects.
ForumEvent(int, Forum, Map) - Constructor for class com.jivesoftware.forum.event.ForumEvent: Creates a new forum event.
ForumEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for forum events.
ForumFactory - Class in com.jivesoftware.forum: A ForumFactory provides access to and management of Forums.
ForumFactory() - Constructor for class com.jivesoftware.forum.ForumFactory
ForumListener - Interface in com.jivesoftware.forum.event: Listener for forum events.
forumMerged(ForumEvent) - Method in interface com.jivesoftware.forum.event.ForumListener: Fired when a forum is merged into another forum.
ForumMessage - Interface in com.jivesoftware.forum: A ForumMessage encapsulates message data.
ForumMessageIterator - Class in com.jivesoftware.forum: An iterator for ForumMessages that allows backwards and forwards iteration, as well as setting an index into the Iteration.
ForumMessageIterator() - Constructor for class com.jivesoftware.forum.ForumMessageIterator
ForumMessageNotFoundException - Exception in com.jivesoftware.forum: Thrown if a nonexistant ForumMessage was attempting to be loaded.
ForumMessageNotFoundException() - Constructor for exception com.jivesoftware.forum.ForumMessageNotFoundException
ForumMessageNotFoundException(String) - Constructor for exception com.jivesoftware.forum.ForumMessageNotFoundException
forumModified(ForumEvent) - Method in interface com.jivesoftware.forum.event.ForumListener: Fired when a forum is modified.
forumMoved(ForumEvent) - Method in interface com.jivesoftware.forum.event.ForumListener: Fired when a forum has been moved from one category to another.
ForumNotFoundException - Exception in com.jivesoftware.forum
ForumNotFoundException() - Constructor for exception com.jivesoftware.forum.ForumNotFoundException
ForumNotFoundException(String) - Constructor for exception com.jivesoftware.forum.ForumNotFoundException
ForumNotFoundException(long) - Constructor for exception com.jivesoftware.forum.ForumNotFoundException
ForumNotFoundException(String, long) - Constructor for exception com.jivesoftware.forum.ForumNotFoundException
ForumPermissions - Class in com.jivesoftware.forum: Defines permissions specific to the Jive Forums product.
ForumThread - Interface in com.jivesoftware.forum: A ForumThread is a container for a hierarchy of ForumMessages.
ForumThreadIterator - Class in com.jivesoftware.forum: An iterator for ForumThreads that allows backwards and forwards iteration, as well as setting an index into the Iteration.
ForumThreadIterator() - Constructor for class com.jivesoftware.forum.ForumThreadIterator
ForumThreadNotFoundException - Exception in com.jivesoftware.forum: Thrown if a nonexistant ForumThread was attempting to be loaded.
ForumThreadNotFoundException() - Constructor for exception com.jivesoftware.forum.ForumThreadNotFoundException
ForumThreadNotFoundException(String) - Constructor for exception com.jivesoftware.forum.ForumThreadNotFoundException

G

GATEWAY - Static variable in class com.jivesoftware.base.JiveConstants
GENERAL_ERROR - Static variable in exception com.jivesoftware.forum.AttachmentException
getAbuseManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an abuse manager that can be used for managing abuse reports
getActiveAvatar(User) - Method in interface com.jivesoftware.forum.AvatarManager: Returns an avatar for a user, else null if no avatar exists for this user
getActivePollCount() - Method in interface com.jivesoftware.base.PollManager: Returns a count of all active polls in the system.
getActivePollCount(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns a count of all active polls of a given type and object ID.
getActivePolls() - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of active polls in the system.
getActivePolls(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of active polls associated with the object specified by the objectType and objectID.
getAdministratorCount() - Method in interface com.jivesoftware.base.Group: Returns the number of group administrators.
getAdministrators() - Method in interface com.jivesoftware.base.Group: An iterator for all the users that are administrators of the group.
getAfterDate() - Method in interface com.jivesoftware.forum.Query: Returns the earliest date for search results.
getAllowAllByDefault() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns true if in the "allow all content types by default" mode.
getAllWatches(User, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns an iterator for all objects of a particular type that a user is watching.
getAnnouncement(long) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns an announcement by announcement ID.
getAnnouncementCount(Object) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns the count of all currently viewable announcements in a container.
getAnnouncementCount(Object, Date, Date) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns the count of all announcements in a container that are viewable within the specified date range.
getAnnouncementManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an announcement manager, which is used to create and retrieve announcements.
getAnnouncements(Object) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns all currently viewable announcements in a container.
getAnnouncements(Object, Date, Date) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns the announcements in a container that are viewable within a specified date range.If container is null then system announcements will be returned.
getAnnouncment() - Method in class com.jivesoftware.forum.event.AnnouncementEvent: Returns the Announcement that the event corresponds to.
getAnonymousAuthToken() - Static method in class com.jivesoftware.base.AuthFactory: Returns an anonymous user AuthToken.
getAnonymousVoteCount() - Method in interface com.jivesoftware.base.Poll: Returns a count of all guests user votes for all options in the poll.
getAnonymousVoteCount(int) - Method in interface com.jivesoftware.base.Poll: Returns a count of all user votes for the specified option in the poll.
getAnonymousVotes() - Method in interface com.jivesoftware.base.Poll: Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
getAnonymousVotes(int) - Method in interface com.jivesoftware.base.Poll: Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
getAnonymousVotes(String) - Method in interface com.jivesoftware.base.Poll: Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.
getArchiveDays(Forum) - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the number of days that threads in forum must be inactive before being archived.
getArchiveForum(Forum) - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the "archive forum" for the specified forum.
getArchiveManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an archive manager that can be used to manage archiving for forums.
getArchiveMode(Forum) - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the archive mode for the forum.
getAttachment() - Method in interface com.jivesoftware.forum.Avatar: Returns the attachment for this avatar
getAttachmentCount() - Method in interface com.jivesoftware.forum.Announcement: Returns the number of attachments the announcement has.
getAttachmentCount() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the number of attachments this message has.
getAttachmentCount() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the number of attachments this private message has.
getAttachmentDirectorySize() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns the size (in bytes) of the attachment directory on the file system.
getAttachmentManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an attachment manager that can be used to manage attachment rules.
getAttachmentName() - Method in exception com.jivesoftware.forum.AttachmentException
getAttachments() - Method in interface com.jivesoftware.forum.Announcement: Returns an Iterator for all the attachments of the message.
getAttachments() - Method in interface com.jivesoftware.forum.ForumMessage: Returns an Iterator for all the attachments of this message.
getAttachments() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns an Iterator for all attachments of this private message.
getAuthToken(String, String) - Static method in class com.jivesoftware.base.AuthFactory: Returns the AuthToken token associated with the specified username and password.
getAuthToken(HttpServletRequest, HttpServletResponse) - Static method in class com.jivesoftware.base.AuthFactory: Returns the AuthToken token associated with the information in a servlet request and response object.
getAutoArchiveInterval() - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the inverval between auto archive executions (in hours).
getAutoIndexInterval() - Method in interface com.jivesoftware.forum.SearchManager: Returns the number of minutes that the indexer waits between each update.
getAutoIndexInterval() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the number of minutes that the indexer waits between each update.
getAvailableInterceptors() - Method in interface com.jivesoftware.forum.InterceptorManager: Returns an array of MessageInterceptor objects that are all of the currently available incerceptors in the system.
getAvailableRatingCount() - Method in interface com.jivesoftware.forum.RatingManager: Returns the count of currently available ratings.
getAvailableRatings() - Method in interface com.jivesoftware.forum.RatingManager: Returns an iterator of Rating objects that list all the available ratings.
getAvatar(long) - Method in interface com.jivesoftware.forum.AvatarManager: Used to acquire an avatar by its id
getAvatarCount(User) - Method in interface com.jivesoftware.forum.AvatarManager: Used to acquire a count of all the avatars for a specific user
getAvatarManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a AvatarManager that can be used to find, create, delete, and make avatars active
getAvatars(User) - Method in interface com.jivesoftware.forum.AvatarManager: Returns a collection of avatars for a user
getBankPoints(User) - Method in interface com.jivesoftware.forum.RewardManager: Returns the current number of reward points a user has.
getBanManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a ban manager that can be used for banning users
getBeforeDate() - Method in interface com.jivesoftware.forum.Query: Returns the latest date for search results.
getBody() - Method in interface com.jivesoftware.forum.Announcement: Returns the announcement body.
getBody() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message body.
getBody() - Method in interface com.jivesoftware.forum.JiveContentObject: Return a summary of the jive object content.
getBody() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the message body.
getCachedSize() - Method in class com.jivesoftware.base.Permissions
getCachedSize() - Method in class com.jivesoftware.forum.QueryResult
getCalculator() - Static method in class com.jivesoftware.forum.StatusLevelManagerFactory: Used to acquire the StatusLevelCalculator, this should only be called by implementations of StatusLevelManager that delegate to a StatusLevelCalculator
getCategories() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for the child categories of this category.
getCategories(int, int) - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for the child categories of this category using a start index and the number of results to return.
getCategory() - Method in class com.jivesoftware.forum.event.CategoryEvent: Returns the ForumCategory that the event corresponds to.
getCategoryCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of sub-categories of this category.
getCategoryDepth() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the depth of a this category relative to the root.
getChild(ForumMessage, int) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the child of parent at index index in the parent's child array.
getChildCount(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the number of children of parent.
getChildren(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns an Iterator for all the child messages of the parent.
getCode() - Method in class com.jivesoftware.forum.Question.State: Returns the integer code associated with the state.
getContainerObjectID() - Method in interface com.jivesoftware.forum.Announcement: Returns the object ID of the announcement container.
getContainerObjectType() - Method in interface com.jivesoftware.forum.Announcement: Returns the object type of the announcement container.
getContentType() - Method in interface com.jivesoftware.forum.Attachment: Returns the content type of the attachment.
getContext() - Method in class com.jivesoftware.base.EmailMessage: Returns a map of replacement tokens to use in the email
getCorrectAnswer() - Method in interface com.jivesoftware.forum.Question: Returns the correct answer, or null if no correct answer has been set.
getCreationDate() - Method in interface com.jivesoftware.base.Group: Returns the date that the group was created.
getCreationDate() - Method in interface com.jivesoftware.base.Poll: Returns the date the poll was created.
getCreationDate() - Method in interface com.jivesoftware.base.User: Returns the date that the user was created.
getCreationDate() - Method in interface com.jivesoftware.forum.Attachment: Returns the date the attachment was created.
getCreationDate() - Method in interface com.jivesoftware.forum.ContentTag: Returns the date that this tag was created.
getCreationDate() - Method in interface com.jivesoftware.forum.Forum: Returns the Date that the forum was created.
getCreationDate() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the Date that the category was created.
getCreationDate() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the date this message was created.
getCreationDate() - Method in interface com.jivesoftware.forum.ForumThread: Returns the date that this thread was created.
getCreationDate() - Method in interface com.jivesoftware.forum.JiveContentObject: Gets the creation date of the jive object
getCreationDate() - Method in class com.jivesoftware.forum.QueryResult: Get the creation date of the message this query result pertains to.
getCreationDate() - Method in interface com.jivesoftware.forum.Question: Returns the date this question was created.
getCreationDateRangeMax() - Method in class com.jivesoftware.forum.QuestionFilter: Returns a date that represents the upper boundry for messages or threads to be selected by the result filter.
getCreationDateRangeMax() - Method in class com.jivesoftware.forum.ResultFilter: Returns a date that represents the upper boundry for messages or threads to be selected by the result filter.
getCreationDateRangeMin() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the creation date that represents the lower boundary for messages or threads to be filtered on.
getCreationDateRangeMin() - Method in class com.jivesoftware.forum.ResultFilter: Returns the creation date that represents the lower boundary for messages or threads to be filtered on.
getCurrentCount() - Method in interface com.jivesoftware.forum.SearchManager: Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getCurrentCount() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getData() - Method in interface com.jivesoftware.forum.Attachment: Returns a InputStream for the binary contents of the attachment.
getDate() - Method in class com.jivesoftware.base.event.GroupEvent
getDate() - Method in class com.jivesoftware.base.event.JivePropertyEvent: Returns the date the event was created
getDate() - Method in class com.jivesoftware.base.event.LogEvent
getDate() - Method in class com.jivesoftware.base.event.PollEvent
getDate() - Method in class com.jivesoftware.base.event.UserEvent
getDate() - Method in interface com.jivesoftware.base.JiveEvent: Returns the date (as a Date object) that the event was created.
getDate() - Method in class com.jivesoftware.forum.event.AnnouncementEvent
getDate() - Method in class com.jivesoftware.forum.event.CategoryEvent
getDate() - Method in class com.jivesoftware.forum.event.ForumEvent
getDate() - Method in class com.jivesoftware.forum.event.MessageEvent
getDate() - Method in class com.jivesoftware.forum.event.PrivateMessageEvent
getDate() - Method in class com.jivesoftware.forum.event.QuestionEvent
getDate() - Method in class com.jivesoftware.forum.event.SearchIndexEvent
getDate() - Method in class com.jivesoftware.forum.event.ThreadEvent
getDate() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the date the message was saved or sent, or null if the message hasn't been sent or saved yet.
getDate() - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent
getDeleteDays() - Method in interface com.jivesoftware.forum.WatchManager: Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
getDescription() - Method in interface com.jivesoftware.base.Group: Returns the description of the group.
getDescription() - Method in interface com.jivesoftware.base.Poll: Returns a brief description of the poll.
getDescription() - Method in interface com.jivesoftware.forum.Forum: Returns the description of the forum.
getDescription() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the description of the forum category.
getDescription() - Method in interface com.jivesoftware.forum.Rating: Retrieve the description for the rating.
getDescription() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the description of this status level
getDraftManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a DraftManager that can be used to manager message drafts.
getEmail() - Method in class com.jivesoftware.base.EmailMessage.EmailAddress
getEmail() - Method in interface com.jivesoftware.base.User: Returns the user's email address.
getEmailManager() - Static method in class com.jivesoftware.base.EmailManager: Used to acquire an instance of EmailManager.
getEmailManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an EmailManager that can be used for sending out emails
getEndDate() - Method in interface com.jivesoftware.base.Poll: Returns the date voting for the poll should end.
getEndDate() - Method in interface com.jivesoftware.forum.Announcement: Returns the date when the announcement should not longer be visible.
getErrorType() - Method in exception com.jivesoftware.forum.AttachmentException
getEventType() - Method in class com.jivesoftware.base.event.GroupEvent
getEventType() - Method in class com.jivesoftware.base.event.JivePropertyEvent: Returns an integer value for the type of event this is
getEventType() - Method in class com.jivesoftware.base.event.LogEvent
getEventType() - Method in class com.jivesoftware.base.event.PollEvent
getEventType() - Method in class com.jivesoftware.base.event.UserEvent
getEventType() - Method in interface com.jivesoftware.base.JiveEvent: Returns the event type corresponding to the event.
getEventType() - Method in class com.jivesoftware.forum.event.AnnouncementEvent
getEventType() - Method in class com.jivesoftware.forum.event.CategoryEvent
getEventType() - Method in class com.jivesoftware.forum.event.ForumEvent
getEventType() - Method in class com.jivesoftware.forum.event.MessageEvent
getEventType() - Method in class com.jivesoftware.forum.event.PrivateMessageEvent
getEventType() - Method in class com.jivesoftware.forum.event.QuestionEvent
getEventType() - Method in class com.jivesoftware.forum.event.SearchIndexEvent
getEventType() - Method in class com.jivesoftware.forum.event.ThreadEvent
getEventType() - Method in class com.jivesoftware.profiles.ProfileEvent
getEventType() - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent
getExpirationDate() - Method in interface com.jivesoftware.base.Poll: Returns the date the poll should expire.
getFailureException() - Method in class com.jivesoftware.base.event.GroupEvent: Returns the exception that indicates why a listener failed to handle an event.
getFailureException() - Method in class com.jivesoftware.base.event.UserEvent: Returns the exception that indicates why a listener failed to handle an event.
getFailureException() - Method in class com.jivesoftware.profiles.ProfileEvent: Returns the exception that indicates why a listener failed to handle an event.
getFilteredThread() - Method in interface com.jivesoftware.forum.Query: Returns the thread that query results are restricted to.
getFilteredUser() - Method in interface com.jivesoftware.forum.Query: Returns the user that query results are restricted to.
getFilterRenderTypes(String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Returns the bitset render types installed for the filter at the given index.
getFinalLocale() - Method in interface com.jivesoftware.forum.Forum: Returns the locale for this forum.
getFinalLocale() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the locale for this category.
getFolder() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the folder the private message or null if the message does not yet belong to a folder.
getFolder(User, int) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the specified folder for a user.
getFolderCount(User) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the total number of folders the user has.
getFolders(User) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns an Iterator of PrivateMessageFolder objects for the folders the user has.
getForum() - Method in class com.jivesoftware.forum.event.ForumEvent: Returns the Forum that the event corresponds to.
getForum(long) - Method in class com.jivesoftware.forum.ForumFactory: Returns the forum with the specified forumID.
getForum(String) - Method in class com.jivesoftware.forum.ForumFactory: Returns the forum with the specified NNTP name.
getForum() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the forum this message belongs to.
getForum() - Method in interface com.jivesoftware.forum.ForumThread: Returns the forum this thread belongs to.
getForumCategory() - Method in interface com.jivesoftware.forum.Forum: Returns the forum category that this forum belongs to.
getForumCategory(long) - Method in class com.jivesoftware.forum.ForumFactory: Returns the forum category with the specified categoryID.
getForumCategoryID() - Method in exception com.jivesoftware.forum.ForumCategoryNotFoundException: The id of the forum category that was not found
getForumCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of forums in the category.
getForumCount(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of forums in the category based on the specified ResultFilter.
getForumCount() - Method in class com.jivesoftware.forum.ForumFactory: Returns the total number of forums in the system.
getForumCount(ResultFilter) - Method in class com.jivesoftware.forum.ForumFactory: Returns the total number of forums in the system matching the ResultFilter.
getForumID() - Method in exception com.jivesoftware.forum.ForumNotFoundException
getForumID() - Method in class com.jivesoftware.forum.QueryResult: Get the ID of the forum the message belongs to
getForumIDs() - Method in interface com.jivesoftware.forum.Query: Returns an array of forumID's denoting the forums that will be searched within.
getForumIndex() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the index of this message in the forum.
getForumMessage() - Method in exception com.jivesoftware.forum.MessageRejectedException: Returns the message that triggered the exception.
getForums() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for all the forums in the category.
getForums(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns a Iterator for all the forums in the category that match the criteria specified by the ResultFilter.
getForums() - Method in class com.jivesoftware.forum.ForumFactory: Returns all forums in the system that the user has read permission for.
getForums(ResultFilter) - Method in class com.jivesoftware.forum.ForumFactory: Returns all forums in the system that the user has read permission for and that matche the specified ResultFilter.
getForumThread(long) - Method in class com.jivesoftware.forum.ForumFactory: Returns the thread with the specified threadID.
getForumThread() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the thread this message belongs to.
getForumThread() - Method in interface com.jivesoftware.forum.Question: Returns the thread that the question is associated with.
getGatewayManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a gateway manager that can be used for managing gateways
getGlobalAvatars() - Method in interface com.jivesoftware.forum.AvatarManager: Returns a collection of all of the global avatars
getGroup() - Method in class com.jivesoftware.base.event.GroupEvent
getGroup(long) - Method in interface com.jivesoftware.base.GroupManager: Gets a Group by ID.
getGroup(String) - Method in interface com.jivesoftware.base.GroupManager: Gets a Group by name.
getGroup() - Method in interface com.jivesoftware.forum.StatusLevel: The group this status level is associated with.
getGroupCount() - Method in interface com.jivesoftware.base.GroupManager: Returns the total number of groups in the system.
getGroupManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a GroupManager that can be used to manage groups.
getGroups() - Method in interface com.jivesoftware.base.GroupManager: Returns an iterator for all groups in the system.
getGroups(int, int) - Method in interface com.jivesoftware.base.GroupManager: Returns an iterator for all groups starting at startIndex with the given number of results.
getGroupStatusLevels() - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an iterator of all group based status levels in the system.
getHelpfulAnswers() - Method in interface com.jivesoftware.forum.Question: Returns a read-only Collection of ForumMessage objects that have been marked as helpful.
getHelpfulAnswersPerThread() - Method in interface com.jivesoftware.forum.QuestionManager: Returns the number of helpful answers allowed per question.
getHtmlBody() - Method in class com.jivesoftware.base.EmailMessage: Returns the html version of the body
getHtmlBodyProperty() - Method in class com.jivesoftware.base.EmailMessage
getID() - Method in interface com.jivesoftware.base.Group: Returns the id of the group.
getID() - Method in interface com.jivesoftware.base.JiveObject: Retrieve the unique identifier for the jive object.
getID() - Method in class com.jivesoftware.base.PermissionType: Returns the id of the PermissionType
getID() - Method in interface com.jivesoftware.base.Poll: Returns the unique ID of the poll.
getID() - Method in interface com.jivesoftware.base.Presence: Returns the unique ID for this status.
getID() - Method in interface com.jivesoftware.base.User: Returns the user's id.
getID() - Method in interface com.jivesoftware.forum.Announcement: Returns the unique ID of the announcement, or -1 if the announcement hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.forum.Attachment: Returns the unique ID of the attachment.
getID() - Method in interface com.jivesoftware.forum.Avatar: Returns the unique ID of the avatar
getID() - Method in interface com.jivesoftware.forum.Forum: Returns the unique id of the forum.
getID() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the ID of the category.
getID() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the id of this message, or -1 if this message hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.forum.ForumThread: Returns the unique ID of this thread, or -1 if the thread hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the id of the message.
getID() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns the ID of the folder.
getID() - Method in interface com.jivesoftware.forum.Query: Retrieve the unique identifier for the query.
getID() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the unique id of this status level
getImagePath() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the relative path to the image.
getImagePreviewMaxSize() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getIndexOfChild(ForumMessage, ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the index of child in parent.
getInheritedRenderFilters() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Retrieve the map of render filters -> renderTypes searching up the tree to the global level if no render filters are defined at the current/parent(s) level.
getInitialBankPoints() - Method in interface com.jivesoftware.forum.RewardManager: Returns the number of bank points a user will start with.
getInstance() - Static method in class com.jivesoftware.base.event.GroupEventDispatcher
getInstance() - Static method in class com.jivesoftware.base.event.JivePropertyEventDispatcher: Returns an instance of JivePropertyEventDispatcher
getInstance() - Static method in class com.jivesoftware.base.event.LogEventDispatcher
getInstance() - Static method in class com.jivesoftware.base.event.PollEventDispatcher: Returns an event dispatcher instance.
getInstance() - Static method in class com.jivesoftware.base.event.UserEventDispatcher
getInstance() - Static method in class com.jivesoftware.base.GroupManagerFactory: Returns a concrete instance of the group manager interface.
getInstance() - Static method in class com.jivesoftware.base.PollManagerFactory: Returns a concrete instance of the poll manager interface.
getInstance() - Static method in class com.jivesoftware.base.UserManagerFactory: Returns a concrete instance of the user manager interface.
getInstance() - Static method in class com.jivesoftware.forum.AvatarManagerFactory: Returns a concrete instance of the Avatar interface.
getInstance() - Static method in class com.jivesoftware.forum.event.AnnouncementEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.CategoryEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.ForumEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.MessageEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.PrivateMessageEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.QuestionEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.SearchIndexEventDispatcher
getInstance() - Static method in class com.jivesoftware.forum.event.ThreadEventDispatcher
getInstance(AuthToken) - Static method in class com.jivesoftware.forum.ForumFactory: Returns a concrete ForumFactory instance.
getInstance(AuthToken) - Static method in class com.jivesoftware.forum.QueryLoggerFactory: Returns a concrete instance of the query logger interface wrapped by a protection proxy.
getInstance(AuthToken) - Static method in class com.jivesoftware.forum.RatingManagerFactory: Returns a concrete instance of the rating manager interface wrapped by a protection proxy.
getInstance() - Static method in class com.jivesoftware.forum.renderer.RendererFactory: Returns an implementation of the Renderer interface.
getInstance() - Static method in class com.jivesoftware.forum.StatusLevelManagerFactory: Returns a concrete instance of the StatusLevel interface.
getInstance() - Static method in class com.jivesoftware.profiles.search.ProfileSearchIndexEventDispatcher
getInterceptor(int) - Method in interface com.jivesoftware.forum.InterceptorManager: Return the interceptor at the specified index in the list of currently configured interceptors.
getInterceptorCount() - Method in interface com.jivesoftware.forum.InterceptorManager: Returns the count of currently active interceptors.
getInterceptorManager() - Method in interface com.jivesoftware.forum.Forum: Returns an interceptor manager that can be used to manage the interceptors for this forum.
getInterceptorManager() - Method in interface com.jivesoftware.forum.ForumCategory: Returns a message interceptor manager that can be used to manage interceptors for this category.
getInterceptorManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a message interceptor manager that can be used to manage global interceptors.
getIPAddress() - Method in interface com.jivesoftware.base.Presence: Returns the IP address of the user.
getKey() - Method in class com.jivesoftware.forum.renderer.RenderTarget: Gets the key of a RenderTarget object
getKey() - Method in class com.jivesoftware.forum.renderer.RenderType: Gets the key of a RenderType object
getLargeImagePath() - Method in interface com.jivesoftware.forum.StatusLevel
getLastArchivedDate() - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the date the archiving process was last run.
getLastIndexedDate() - Method in interface com.jivesoftware.forum.SearchManager: Returns the date that the last update to the index was made.
getLastIndexedDate() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the date that the last update to the index was made.
getLastUpdateTime() - Method in interface com.jivesoftware.base.Presence: Return the time when the presence was last updated (when the user last visited).
getLatestMessage() - Method in interface com.jivesoftware.forum.Forum: Returns the most recently created or edited message in this forum.
getLatestMessage() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the most recently created or edited message in this category (including all sub-categories).
getLatestMessage() - Method in interface com.jivesoftware.forum.ForumThread: Returns the most recently created messages in this thread.
getLeaderIds(int, int) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns a long array of user ids of system leaders given a start index and desired number of results.
getLeaderIds(ForumCategory, int, int) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns a long array of user ids of forum category leaders given a start index and desired number of results.
getLeaderIds(Forum, int, int) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns a long array of user ids of forum leaders
getLeaders() - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of system wide leaders.
getLeaders(int, int) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of system wide leaders.
getLeaders(Forum) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of leaders for a specific forum
getLeaders(Forum, int, int) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of leaders for a specific forum
getLeaders(ForumCategory) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of leaders for a specific forum category
getLeaders(ForumCategory, int, int) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an Iterator of leaders for a specific forum category
getLivePollCount() - Method in interface com.jivesoftware.base.PollManager: Returns a count of all live polls in the system.
getLivePollCount(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns a count of all live polls of a given type and object ID.
getLivePolls() - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of live polls in the system.
getLivePolls(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of live polls associated with the object specified by the objectType and objectID.
getLocale() - Method in class com.jivesoftware.base.EmailMessage: Return the locale for the email message.
getLocale() - Method in interface com.jivesoftware.forum.Forum: Returns the locale for this forum.
getLocale() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the locale for this category.
getLogDirectory() - Static method in class com.jivesoftware.base.Log: Returns the directory that log files exist in.
getLoggedQueryInfo(Query) - Method in interface com.jivesoftware.forum.QueryLogger: Returns the logged information about the query, or null if the query has not been logged yet.
getLoginTime() - Method in interface com.jivesoftware.base.Presence: Return the time when the presence was created.
getMacroTagName() - Method in interface com.jivesoftware.forum.renderer.RenderMacro: Returns the tag name of the macro.
getMaxAllowableHeight() - Method in interface com.jivesoftware.forum.AvatarManager: Returns the maximum allowable height for an avatar image
getMaxAllowableWidth() - Method in interface com.jivesoftware.forum.AvatarManager: Returns the maximum allowable width for an avatar image
getMaxAttachmentSize() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns the maximum size of an individual attachment in kilobytes.
getMaxAttachmentsPerMessage() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns the maximum number of attachments per message.
getMaxBankPoints() - Method in interface com.jivesoftware.forum.RewardManager: Returns the max number of points that can accumulate in a bank account, or -1 if there is no max.
getMaxFilesystemCacheSize() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns the maximum amount of storage (in bytes) that will be used by the file system cache when database attachment mode is enabled.
getMaxForumIndex() - Method in interface com.jivesoftware.forum.Forum: Returns the largest forum index value for a message in the forum.
getMaxMessagePoints() - Method in interface com.jivesoftware.forum.RewardManager: Returns the maximum number of reward points that can be assigned to a message.
getMaxMessagesPerUser() - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the max number of messages each user is allowed to store in their mailbox, or -1 if there is no limit.
getMaxPoints() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the maximum value for a status level point range. -1 means unbounded (unless there is a group specified)
getMaxThreadPoints() - Method in interface com.jivesoftware.forum.RewardManager: Returns the maximum number of reward points that can be assigned to a thread.
getMaxUserAvatars() - Method in interface com.jivesoftware.forum.AvatarManager: Returns the maximum amount of avatars a user is allowed to have, -1 for limitless
getMeanRating(long) - Method in interface com.jivesoftware.forum.RatingManager: A convenience method which returns a geometric mean average of all the ratings given to the forum message.
getMeanRating(ForumMessage) - Method in interface com.jivesoftware.forum.RatingManager: A convenience method which returns a geometric mean average of all the ratings given to the forum message.
getMeanRating(ForumThread) - Method in interface com.jivesoftware.forum.RatingManager: A convenience method which returns a geometric mean average of all the ratings given to the forum thread.
getMemberCount() - Method in interface com.jivesoftware.base.Group: Returns the number of group members.
getMembers() - Method in interface com.jivesoftware.base.Group: An iterator for all the users that are members of the group.
getMessage() - Method in class com.jivesoftware.base.event.LogEvent
getMessage() - Method in class com.jivesoftware.forum.event.MessageEvent: Returns the ForumMessage that the event corresponds to.
getMessage(long) - Method in class com.jivesoftware.forum.ForumFactory: Returns the forum message with the specified messageID.
getMessage(long) - Method in interface com.jivesoftware.forum.ForumThread: Returns a message from this thread based on its id.
getMessage(long) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the specified private message.
getMessage() - Method in class com.jivesoftware.forum.QueryResult: Get the message this query result pertains to.
getMessageCount() - Method in interface com.jivesoftware.forum.Forum: Returns the number of messages in the forum.
getMessageCount(ResultFilter) - Method in interface com.jivesoftware.forum.Forum: Returns the number of messages in the forum based on the specified ResultFilter.
getMessageCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of messages in the category.
getMessageCount(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of messages in the category based on the specified ResultFilter.
getMessageCount() - Method in interface com.jivesoftware.forum.ForumThread: Returns the number of messages in the thread.
getMessageCount(ResultFilter) - Method in interface com.jivesoftware.forum.ForumThread: Returns the number of messages in this thread based on the specified result filter.
getMessageCount() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns the number of messages in the folder.
getMessageCount(User) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the total number of private messages a user has in their mailbox.
getMessageDepth(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the depth of a message in the message tree hierarchy.
getMessageID(long, int) - Method in class com.jivesoftware.forum.ForumFactory: Returns the message ID with the specified forumID and forumIndex, or -1 if the forumIndex does not map to a message.
getMessageID() - Method in class com.jivesoftware.forum.QueryResult: Get the id of the message this query result pertains to.
getMessages() - Method in interface com.jivesoftware.forum.Forum: Returns an Iterator for all the messages in the forum.
getMessages(ResultFilter) - Method in interface com.jivesoftware.forum.Forum: Returns a Iterator for all the messages in the forum that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for all the messages in the category.
getMessages(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns a Iterator for all the messages in the category that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.forum.ForumThread: Return an Iterator for all the messages in this thread.
getMessages(ResultFilter) - Method in interface com.jivesoftware.forum.ForumThread: Returns a Iterator for all the messages in the thread that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns all the messages in the folder sorted by date descending.
getMessages(int, int, int, boolean) - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns messages in the folder based on the params.
getMinForumIndex() - Method in interface com.jivesoftware.forum.Forum: Returns the smallest forum index value for a message in the forum.
getMinimum() - Method in class com.jivesoftware.forum.TagResultFilter: Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
getMinPoints() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the minimum value for a status level point range. -1 means unbounded (unless there is a group specified)
getModerationAvatarCount() - Method in interface com.jivesoftware.forum.AvatarManager: Used to acquire a count of all the avatars that require moderation.
getModerationAvatars() - Method in interface com.jivesoftware.forum.AvatarManager: Returns a collection of all of the avatars that require moderation.
getModerationDefaultMessageValue() - Method in interface com.jivesoftware.forum.Forum: Returns the default number of moderation points for messages created in the forum.
getModerationDefaultThreadValue() - Method in interface com.jivesoftware.forum.Forum: Returns the default number of moderation points for threads created in the forum.
getModerationManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a moderation manager that can be used for moderating messages
getModerationRangeMax() - Method in class com.jivesoftware.forum.ResultFilter: Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter.
getModerationRangeMin() - Method in class com.jivesoftware.forum.ResultFilter: Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter.
getModerationValue() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the number of moderation points this message has.
getModerationValue() - Method in interface com.jivesoftware.forum.ForumThread: Returns the number of moderation points this thread has.
getModificationDate() - Method in interface com.jivesoftware.base.Group: Returns the date that the group was last modified.
getModificationDate() - Method in interface com.jivesoftware.base.Poll: Returns the date the poll was last modified.
getModificationDate() - Method in interface com.jivesoftware.base.User: Returns the date that the user was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.Attachment: Returns the date the attachment was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.Forum: Returns the Date that the forum was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the Date this category was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the date this message was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.ForumThread: Returns the date that this thread was last modified.
getModificationDate() - Method in interface com.jivesoftware.forum.JiveContentObject: Gets the modification date of the jive object
getModificationDate() - Method in class com.jivesoftware.forum.QueryResult: Returns the message modification date.
getModificationDateRangeMax() - Method in class com.jivesoftware.forum.ResultFilter: Returns a date that represents the upper boundry for messages or threads to be selected by the result filter.
getModificationDateRangeMin() - Method in class com.jivesoftware.forum.ResultFilter: Returns a date that represents the lower boundary for messages or threads to be selected by the result filter.
getModValue() - Method in interface com.jivesoftware.forum.Avatar: Returns the moderation value for this Avatar
getName() - Method in class com.jivesoftware.base.EmailMessage.EmailAddress
getName() - Method in class com.jivesoftware.base.event.JivePropertyEvent: Returns the name of the jive property
getName() - Method in interface com.jivesoftware.base.Group: Returns the name of the group.
getName() - Method in interface com.jivesoftware.base.Poll: Returns the name of the poll.
getName() - Method in interface com.jivesoftware.base.User: Returns the user's name.
getName() - Method in interface com.jivesoftware.forum.Attachment: Returns the name of the attachment.
getName() - Method in interface com.jivesoftware.forum.ContentTag: The name of the tag
getName() - Method in interface com.jivesoftware.forum.Forum: Returns the name of the forum.
getName() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the name of the category.
getName() - Method in interface com.jivesoftware.forum.ForumThread: Returns the subject of the root message of this thread.
getName() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns the name of the folder.
getName() - Method in interface com.jivesoftware.forum.renderer.RenderFilter: Returns the unique name of the filter.
getName() - Method in interface com.jivesoftware.forum.StatusLevel: Returns the name of this status level
getNestedThrowable() - Method in exception com.jivesoftware.base.UnauthorizedException
getNNTPName() - Method in interface com.jivesoftware.forum.Forum: Returns the NNTP name for the forum, which is the name of the forum used in the NNTP protocol (newsgroups).
getNumResults() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the max number of results that should be returned.
getNumResults() - Method in class com.jivesoftware.forum.ResultFilter: Returns the max number of results that should be returned.
getObjectID() - Method in interface com.jivesoftware.base.Poll: Returns the object ID of the container that 'contains' the poll.
getObjectID() - Method in interface com.jivesoftware.forum.Watch: Returns the object ID of the object being watched.
getObjectType() - Method in interface com.jivesoftware.base.JiveObject: Return the object type of the jive object.
getObjectType() - Method in interface com.jivesoftware.base.Poll: Returns the object type of the container that 'contains' the poll.
getObjectType() - Method in interface com.jivesoftware.forum.Query: Return the object type of the query.
getObjectType() - Method in interface com.jivesoftware.forum.Watch: Returns the object type of the object being watched.
getOnlineGuestCount() - Method in interface com.jivesoftware.base.PresenceManager: Returns the number of guests who are currently online.
getOnlineUserCount() - Method in interface com.jivesoftware.base.PresenceManager: Returns the number of users who are currently online.
getOnlineUserCount(Group) - Method in interface com.jivesoftware.base.PresenceManager: Returns the number of users in the group who are currently online.
getOnlineUserCount() - Method in interface com.jivesoftware.base.Roster: Returns the number of users in the roster who are currently online.
getOnlineUsers() - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users who are currently online.
getOnlineUsers(Group) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users in the group who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(Group, boolean, int) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(boolean, int, int, int) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(Group, boolean, int, int) - Method in interface com.jivesoftware.base.PresenceManager: Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers() - Method in interface com.jivesoftware.base.Roster: Returns an iterator of users in the roster who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.base.Roster: Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.base.Roster: Returns an iterator of users who are currently online matching the criteria given.
getOption(int) - Method in interface com.jivesoftware.base.Poll: Returns the text of the option at the specified index.
getOptionCount() - Method in interface com.jivesoftware.base.Poll: Returns the number of options available in the poll.
getOwner() - Method in interface com.jivesoftware.forum.Avatar: Returns user who created this avatar, if the user is null then this is a global avatar
getOwner() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns the owner of the private message folder.
getParameters() - Method in interface com.jivesoftware.forum.renderer.RenderMacro: Returns a Map of user provided parameters to the macro.
getParams() - Method in class com.jivesoftware.base.event.GroupEvent
getParams() - Method in class com.jivesoftware.base.event.JivePropertyEvent: Returns any extra parameters associated with event
getParams() - Method in class com.jivesoftware.base.event.LogEvent
getParams() - Method in class com.jivesoftware.base.event.PollEvent
getParams() - Method in class com.jivesoftware.base.event.UserEvent
getParams() - Method in interface com.jivesoftware.base.JiveEvent: Returns a map of parameters which can be used to pass data to a listener.
getParams() - Method in class com.jivesoftware.forum.event.AnnouncementEvent
getParams() - Method in class com.jivesoftware.forum.event.CategoryEvent
getParams() - Method in class com.jivesoftware.forum.event.ForumEvent
getParams() - Method in class com.jivesoftware.forum.event.MessageEvent
getParams() - Method in class com.jivesoftware.forum.event.PrivateMessageEvent
getParams() - Method in class com.jivesoftware.forum.event.QuestionEvent
getParams() - Method in class com.jivesoftware.forum.event.SearchIndexEvent
getParams() - Method in class com.jivesoftware.forum.event.ThreadEvent
getParams() - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent
getParent(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the parent of the child ForumMessage.
getParentCategory() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the parent category of this category.
getParentMessage() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the parent message of this message or null if this message is the root message of a thread.
getPasswordHash() - Method in interface com.jivesoftware.base.User: Returns the user's password in hashed form.
getPendingRewardThreads(User) - Method in interface com.jivesoftware.forum.RewardManager: Returns the threads (ordered by modified date) that the user has assigned points to that haven't been fully rewarded out yet.
getPendingRewardThreadsCount(User) - Method in interface com.jivesoftware.forum.RewardManager: Returns a count of the threads that the user has assigned points to that haven't been fully rewarded out yet.
getPercentComplete() - Method in interface com.jivesoftware.forum.SearchManager: Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getPercentComplete() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getPermissions(AuthToken) - Method in interface com.jivesoftware.base.Group: Returns the permissions for the group that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.base.User: Returns the permissions for the user that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.forum.Forum: Returns the permissions for the forum that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.forum.ForumCategory: Returns the permissions for the category that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in class com.jivesoftware.forum.ForumFactory: Returns the permissions for the factory that correspond to the passed-in Authorization.
getPermissionsManager() - Method in interface com.jivesoftware.forum.Forum: Returns a permissions manager that can be used to set permissions for this forum.
getPermissionsManager() - Method in interface com.jivesoftware.forum.ForumCategory: Returns a permissions manager that can be used to set permissions for this category.
getPermissionsManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a permissions manager that can be used to set system wide permissions.
getPlainBody() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message body with no html markup applied.
getPlainBody() - Method in interface com.jivesoftware.forum.JiveContentObject: Returns the body of the jive object content with no markup applied.
getPlainSubject() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message subject with no html markup applied.
getPlainSubject() - Method in interface com.jivesoftware.forum.JiveContentObject: Returns the title of the jive object content with no markup applied
getPluginManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns an instance of PluginManager that can be used for acquiring plugin instances.
getPointLevel(User) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns the point level for a user system wide.
getPointLevel(User, Forum) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns the status level points for a user in regards to a specific forum
getPointLevel(User, ForumCategory) - Method in interface com.jivesoftware.forum.StatusLevelCalculator: Returns the status level points for a user in regards to a specific category
getPointLevel(User) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns the point level for a user system wide.
getPointLevel(User, Forum) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns the status level points for a user in regards to a specific forum
getPointLevel(User, ForumCategory) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns the status level points for a user in regards to a specific category
getPoints(ForumThread) - Method in interface com.jivesoftware.forum.RewardManager: Returns the number of reward points in a thread that are left to be distributed.
getPoints(ForumMessage) - Method in interface com.jivesoftware.forum.RewardManager: Returns the number of reward points that have been assigned to a message.
getPointsEarned(User) - Method in interface com.jivesoftware.forum.RewardManager: Returns the total number of points that a user has earned across the entire system.
getPointsEarned(User, ForumCategory) - Method in interface com.jivesoftware.forum.RewardManager: Returns the total number of points the user has earned in a particular category.
getPointsEarned(User, Forum) - Method in interface com.jivesoftware.forum.RewardManager: Returns the total number of points the user has earned in a particular forum.
getPointsRewarded(ForumThread) - Method in interface com.jivesoftware.forum.RewardManager: Returns the total number of points rewarded to messages in the thread.
getPointsRewarded(User) - Method in interface com.jivesoftware.forum.RewardManager: Returns the total number of points that a user has ever rewarded.
getPointStatusLevels() - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns an iterator of point based status levels in the system sorted by point range.
getPoll() - Method in class com.jivesoftware.base.event.PollEvent: Returns the Poll that the event corresponds to.
getPoll(long) - Method in interface com.jivesoftware.base.PollManager: Returns the Poll specified by the poll ID.
getPollCount() - Method in interface com.jivesoftware.base.PollManager: Returns a count of all polls, both active and inactive.
getPollCount(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPollManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a poll manager that can be used to retrieve and manager polls.
getPolls() - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of all polls, both active and inactive.
getPolls(int, long) - Method in interface com.jivesoftware.base.PollManager: Returns an iterator of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPopularForums() - Method in class com.jivesoftware.forum.ForumFactory: Returns an Iterator for the most popular forums in the system as Forum objects.
getPopularTags(ForumCategory) - Method in interface com.jivesoftware.forum.TagManager: Get popular tags
getPopularThreads() - Method in interface com.jivesoftware.forum.Forum: Returns an Iterator for the most popular threads in the forum.
getPopularThreads() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for the most popular threads in the category.
getPopularThreads() - Method in class com.jivesoftware.forum.ForumFactory: Returns an Iterator for the most threads in the system as ForumThread objects.
getPresence(User) - Method in interface com.jivesoftware.base.PresenceManager: Returns the presence for the user, or null if the user isn't online.
getPresenceManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a presence manager that can be used to retrieve and manage presences.
getPrivateMessage() - Method in class com.jivesoftware.forum.event.PrivateMessageEvent: Returns the ForumMessage that the event corresponds to.
getPrivateMessageManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a private message manager, which controls private message settings.
getProperties(String) - Method in interface com.jivesoftware.forum.Attachment: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.Forum: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.ForumCategory: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.ForumMessage: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.ForumThread: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperties(String) - Method in interface com.jivesoftware.forum.Question: Return all immediate children property values of a parent property as an unmodifiable Collection of String values.
getProperty(String) - Method in interface com.jivesoftware.base.Group: Returns an extended property of the group.
getProperty(String) - Method in interface com.jivesoftware.base.User: Returns an extended property of the user.
getProperty(String) - Method in interface com.jivesoftware.forum.Announcement: Returns an extended property of the announcement.
getProperty(String) - Method in interface com.jivesoftware.forum.Attachment: Returns an extended property of the attachment.
getProperty(String) - Method in interface com.jivesoftware.forum.Avatar: Returns an extended property of the attachment.
getProperty(String) - Method in interface com.jivesoftware.forum.Forum: Returns an extended property of the forum.
getProperty(String) - Method in interface com.jivesoftware.forum.ForumCategory: Returns an extended property of the category.
getProperty(String) - Method in interface com.jivesoftware.forum.ForumMessage: Returns an extended property of this message.
getProperty(String) - Method in interface com.jivesoftware.forum.ForumThread: Returns an extended property of this thread.
getProperty(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Returns an extended property of this private message.
getProperty(String) - Method in interface com.jivesoftware.forum.Question: Returns an extended property of this object.
getProperty(String) - Method in interface com.jivesoftware.forum.StatusLevel: Returns an extended property of the status level.
getPropertyCount() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the number of properties that results will be filtered on.
getPropertyCount() - Method in class com.jivesoftware.forum.ResultFilter: Returns the number of properties that results will be filtered on.
getPropertyMatchType(int) - Method in class com.jivesoftware.forum.ResultFilter: Returns the value of the property at the specified index in the list of properties.
getPropertyMode() - Method in class com.jivesoftware.forum.ResultFilter: Returns the mode that will be used to select results if multiple properties have been specified.
getPropertyName(int) - Method in class com.jivesoftware.forum.QuestionFilter: Returns the name of the property at the specified index in the list of properties to be filtered on.
getPropertyName(int) - Method in class com.jivesoftware.forum.ResultFilter: Returns the name of the property at the specified index in the list of properties to be filtered on.
getPropertyNames() - Method in interface com.jivesoftware.base.Group: Returns an Iterator for all the names of the extended group properties.
getPropertyNames() - Method in interface com.jivesoftware.base.User: Returns an Iterator for all the names of the extended user properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.Announcement: Returns an Iterator for all the names of the extended properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.Attachment: Returns an Iterator for the names of the extended properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.Avatar: Returns an Iterator for the names of the extended properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.Forum: Returns an Iterator for the names of the forum properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for the names of the forum category properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.ForumMessage: Returns an Iterator of String values for all the names of the message properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.ForumThread: Returns an Iterator for the names of this thread's properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns an Iterator of String values for all the names of the message properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.Question: Returns an Iterator of String values for all the names of the properties.
getPropertyNames() - Method in interface com.jivesoftware.forum.StatusLevel: Returns an Iterator for the names of the status level properties.
getPropertyValue(int) - Method in class com.jivesoftware.forum.QuestionFilter: Returns the value of the property at the specified index in the list of properties to be filtered on.
getPropertyValue(int) - Method in class com.jivesoftware.forum.ResultFilter: Returns the value of the property at the specified index in the list of properties to be filtered on.
getPropertyValueString(int) - Method in class com.jivesoftware.forum.ResultFilter: Returns the value of the property at the specified index in the list of properties to be filtered on.
getQueries() - Method in interface com.jivesoftware.forum.QueryLogger: Returns an iterator of all the queries that have been made.
getQueries(User) - Method in interface com.jivesoftware.forum.QueryLogger: Returns an Iterator consisting of all the Query's that the specified user has made.
getQuery(long) - Method in interface com.jivesoftware.forum.QueryLogger: Returns the query associated with the given queryID.
getQueryCount() - Method in interface com.jivesoftware.forum.QueryLogger: Returns a count of all the queries that have been made in the system.
getQueryCount(User) - Method in interface com.jivesoftware.forum.QueryLogger: Returns a count of all the queries that the user has made.
getQueryManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a query manager that can be used to retrieve and manage search queries.
getQueryString() - Method in interface com.jivesoftware.forum.Query: Returns the query string for the Query object.
getQuestion() - Method in class com.jivesoftware.forum.event.QuestionEvent: Returns the Question that the event corresponds to.
getQuestion(ForumThread) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the question associated with a thread.
getQuestionCount() - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of all questions in the system.
getQuestionCount(QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of all questions in the system that pass the specified question filter.
getQuestionCount(ForumCategory) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of all questions in a category.
getQuestionCount(ForumCategory, QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of questions in a category that pass the specified question filter.
getQuestionCount(Forum) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of all questions in a forum.
getQuestionCount(Forum, QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns the count of questions in a forum that pass the specified question filter.
getQuestionManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a QuestionManager, which can be used to manage Questions.
getQuestions() - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in the system.
getQuestions(QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in the system that pass the specified question filter.
getQuestions(ForumCategory) - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in a category.
getQuestions(ForumCategory, QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in a categetory that pass the specified question filter.
getQuestions(Forum) - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in a forum.
getQuestions(Forum, QuestionFilter) - Method in interface com.jivesoftware.forum.QuestionManager: Returns an iterator for all questions in a forum that pass the specified question filter.
getRating(User, ForumMessage) - Method in interface com.jivesoftware.forum.RatingManager: Returns the rating associated with the user, or null if this user hasn't rated the forum message.
getRating(User, ForumThread) - Method in interface com.jivesoftware.forum.RatingManager: Returns the rating associated with the user, or null if this user hasn't rated the forum thread.
getRatingCount(ForumMessage) - Method in interface com.jivesoftware.forum.RatingManager: Returns the total number of ratings given to the forum message.
getRatingCount(ForumThread) - Method in interface com.jivesoftware.forum.RatingManager: Returns the total number of ratings given to the forum thread.
getRatingFromScore(int) - Method in interface com.jivesoftware.forum.RatingManager: Retrieve the rating with the specified score.
getRatings(ForumMessage) - Method in interface com.jivesoftware.forum.RatingManager: Returns an Iterator of all the ratings given to the forum message.
getRatings(ForumThread) - Method in interface com.jivesoftware.forum.RatingManager: Returns an Iterator of all the ratings given to the forum thread.
getReadStatus(User, ForumThread) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the read status on the specified thread.
getReadStatus(User, ForumMessage) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the read status on the specified message.
getReadTracker() - Method in class com.jivesoftware.forum.ForumFactory: Returns a read tracker that can be used to track which threads and messages a user has read.
getRecipient() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the user the message was sent to.
getRecipients() - Method in class com.jivesoftware.base.EmailMessage: Returns the recipients of the email
getRecursiveAnnouncementCount(ForumCategory) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns the count of all currently viewable announcements in a ForumCategory and its child Forums and SubCategories.
getRecursiveAnnouncements(ForumCategory, int, int) - Method in interface com.jivesoftware.forum.AnnouncementManager: Returns all currently viewable announcements in a ForumCategory and its child Forums and SubCategories.
getRecursiveCategories() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for all sub-categories of this category, including sub-categories of sub-categories, etc.
getRecursiveCategoryCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the total count of all sub-categories of this category, including sub-categories of sub-categories, etc.
getRecursiveChildCount(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns the total number of recursive children of a parent.
getRecursiveChildren(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns an Iterator for all child messages (and sub-children, etc) of the parent.
getRecursiveForumCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of forums in the category and all sub-categories.
getRecursiveForumCount(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of forums in the category and all sub-categories based on the specified ResultFilter.
getRecursiveForums() - Method in interface com.jivesoftware.forum.ForumCategory: Returns an Iterator for all the forums in the category and all sub-categories.
getRecursiveForums(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns a Iterator for all the forums in the category and sub-categories that match the criteria specified by the ResultFilter.
getRecursiveForumWatches(User, ForumCategory, int, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns all the Forum objects the user is watching under the category and its subcategories.
getRecursiveMessages() - Method in interface com.jivesoftware.forum.TreeWalker: Returns an Iterator for all messages in the thread in depth-first order.
getRecursiveThreadWatches(User, ForumCategory, int, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns the ForumThread objects the user is watching under the provided ForumCategory.
getRegistrationManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a validation manager that can be used for validating user accounts
getRejectionType() - Method in exception com.jivesoftware.forum.PrivateMessageRejectedException: Returns the type of the rejection exception.
getRelevance() - Method in class com.jivesoftware.forum.QueryResult: Get the relevance of this query result as determined by the search engine.
getRelevanceAsPercentage(Locale) - Method in class com.jivesoftware.forum.QueryResult: Returns the relevance as a percentage (no decimal places) formatted according to the locale passed in.
getRenderFilter(String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Return the render filter with the specified name
getRenderFilterCount() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Returns the count of currently installed render filters.
getRenderFilters() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Returns an array of RenderFilter objects that list all the currently configured render filters.
getRenderFilters() - Method in class com.jivesoftware.forum.renderer.RenderPipe
getRenderManager() - Method in interface com.jivesoftware.forum.Forum: Returns a render manager that can be used to manage render filters and macros for this forum.
getRenderManager() - Method in interface com.jivesoftware.forum.ForumCategory: Returns a render manager that can be used to manage render filters and macros for this category.
getRenderManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a render manager that can be used to manage system wide render filters and macros.
getRenderManager() - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns a render manager for private messages in the system.
getRenderTarget(int) - Static method in class com.jivesoftware.forum.renderer.RenderTarget: A helper method to get a specific RenderTarget object from its key
getRenderType(int) - Static method in class com.jivesoftware.forum.renderer.RenderType: A helper method to get a specific RenderType object from its key
getResolutionDate() - Method in interface com.jivesoftware.forum.Question: Returns the date that question was resolved, or null if the question has not been resolved.
getResolutionDateRangeMax() - Method in class com.jivesoftware.forum.QuestionFilter: Returns a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMax() - Method in class com.jivesoftware.forum.ResultFilter: Returns a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMin() - Method in class com.jivesoftware.forum.QuestionFilter: Returns a date that represents the lower boundary for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMin() - Method in class com.jivesoftware.forum.ResultFilter: Returns a date that represents the lower boundary for the resolution date of questions to be selected by the result filter.
getResolutionStates() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the set resolution states that will be included in filtered results.
getResolutionStates() - Method in class com.jivesoftware.forum.ResultFilter: Returns the set resolution states that will be included in filtered results.
getResultByThreadCount() - Method in interface com.jivesoftware.forum.Query: Returns the total number of threads that contain query results.
getResultCount() - Method in interface com.jivesoftware.forum.Query: Returns the total number of results of the query.
getResultForumCount(Forum) - Method in interface com.jivesoftware.forum.Query: Returns the number of results in the search that match the given forum.
getResultForumCountByThread(Forum) - Method in interface com.jivesoftware.forum.Query: Returns the number of results in the search that match the given forum where search results are grouped by thread.
getResultForums() - Method in interface com.jivesoftware.forum.Query: Returns an Iterator of the Forums that search results are from.
getResults() - Method in interface com.jivesoftware.forum.Query: Returns the results of the query as an Iterator of QueryResult objects.
getResults(int, int) - Method in interface com.jivesoftware.forum.Query: Returns the results of the Query as an Iterator of QueryResult objects.
getResultsByThread() - Method in interface com.jivesoftware.forum.Query: Returns the results of the Query as an Iterator of QueryResult objects.
getResultsByThread(int, int) - Method in interface com.jivesoftware.forum.Query: Returns the results of the Query as an Iterator of QueryResult objects.
getRewardManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a reward manager that can be used to manage reward points.
getRoot() - Method in interface com.jivesoftware.forum.TreeWalker: Returns the root of the tree.
getRootForumCategory() - Method in class com.jivesoftware.forum.ForumFactory: Returns the "root" forum category, that all other categories are children of.
getRootMessage() - Method in interface com.jivesoftware.forum.ForumThread: Returns the root message this thread.
getRoster(User) - Method in interface com.jivesoftware.base.PresenceManager: Returns the user's roster.
getScore() - Method in interface com.jivesoftware.forum.Rating: Retrieve the score for the rating.
getSearchManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns the search manger which can be used to manage the index used by Jive to perform searches.
getSender() - Method in class com.jivesoftware.base.EmailMessage: Returns the sender of them email
getSender() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the user the message was sent by, or null if the message was sent by the system.
getSize() - Method in interface com.jivesoftware.forum.Attachment: Returns the size of the attachment in bytes.
getSize() - Method in class com.jivesoftware.forum.renderer.RenderedTextStore: Returns the number of items in the store.
getSortField() - Method in interface com.jivesoftware.forum.Query: Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.forum.ResultFilter: Returns the currently selected sort field.
getSortOrder() - Method in interface com.jivesoftware.forum.Query: Returns the sort order, which will be Query.ASCENDING for ascending sorting, or Query.DESCENDING for descending sorting.
getSortOrder() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the sort order, which will be QuestionFilter.ASCENDING for ascending sorting, or QuestionFilter.DESCENDING for descending sorting.
getSortOrder() - Method in class com.jivesoftware.forum.ResultFilter: Returns the sort order, which will be ResultFilter.ASCENDING for ascending sorting, or ResultFilter.DESCENDING for descending sorting.
getSortPropertyName() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the name of the extended property that will be sorted on.
getSortPropertyName() - Method in class com.jivesoftware.forum.ResultFilter: Returns the name of the extended property that will be sorted on.
getStartDate() - Method in interface com.jivesoftware.base.Poll: Returns the date voting for the poll is set to start.
getStartDate() - Method in interface com.jivesoftware.forum.Announcement: Returns the date when the announcement should first be visible.
getStartIndex() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the index of the first result to return.
getStartIndex() - Method in class com.jivesoftware.forum.ResultFilter: Returns the index of the first result to return.
getState() - Method in interface com.jivesoftware.forum.Question: Returns the resolution state of this question.
getStatus() - Method in interface com.jivesoftware.base.Presence: Returns the status of the presence.
getStatusLevel(long) - Method in interface com.jivesoftware.forum.StatusLevelManager: Used to acquire a specific status level object from the system
getStatusLevel(String) - Method in interface com.jivesoftware.forum.StatusLevelManager: Used to acquire a specific status level by its name
getStatusLevel(User) - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns the system wide status level for specific user, will return null if there is no status level for this user.
getStatusLevel(User, Forum) - Method in interface com.jivesoftware.forum.StatusLevelManager: 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.
getStatusLevel(User, ForumCategory) - Method in interface com.jivesoftware.forum.StatusLevelManager: 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.
getStatusLevel(Group) - Method in interface com.jivesoftware.forum.StatusLevelManager: If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.
getStatusLevelByPoints(int) - Method in interface com.jivesoftware.forum.StatusLevelManager: Used to get a status level by a point value.
getStatusLevelManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a StatusLevelManager that can be used to check a user status level, find leaders system wide, or by forum/category.
getSubject() - Method in class com.jivesoftware.base.EmailMessage: Returns the subject of the email.
getSubject() - Method in interface com.jivesoftware.forum.Announcement: Returns the announcement subject.
getSubject() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message subject.
getSubject() - Method in interface com.jivesoftware.forum.JiveContentObject: Return the title of the jive object content
getSubject() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the message subject.
getSubject() - Method in class com.jivesoftware.forum.QueryResult: Returns the message's subject.
getSubjectProperty() - Method in class com.jivesoftware.base.EmailMessage: Returns the property name for subject of the email
getTag(String) - Method in interface com.jivesoftware.forum.TagManager: Returns a tag by tag name.
getTag(long) - Method in interface com.jivesoftware.forum.TagManager: Returns a tag given a tag ID.
getTagDelegator() - Method in interface com.jivesoftware.forum.ForumMessage: Retrieve a tag delegator to manage message tags.
getTagDelegator() - Method in interface com.jivesoftware.forum.ForumThread: Retrieve a tag delegator to manage thread tags.
getTagManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a tag manager that can be used for managing tags
getTags() - Method in interface com.jivesoftware.forum.Forum: Returns all tags for a given forum in a Map where the key is the name of tag and the value is the number of times the tag has been used in this forum.
getTags(TagResultFilter) - Method in interface com.jivesoftware.forum.Forum: Returns all tags for a given forum in a Map where the key is the name of tag and the value is the number of times the tag has been used in this forum filtered by the TagResultFilter.
getTags() - Method in interface com.jivesoftware.forum.ForumCategory: Returns all tags for a given community in a Map where the key is the name of tag and the value is the number of times the tag has been used in this community.
getTags(TagResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns all tags for a given community in a Map where the key is the name of tag and the value is the number of times the tag has been used in this community filtered by the TagResultFilter.
getTags() - Method in class com.jivesoftware.forum.ResultFilter: Returns the the ContentTags to filter on.
getTags(JiveContentObject) - Method in interface com.jivesoftware.forum.TagManager: Return an Iterable for all the tags associated with this manager.
getTarget() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
getText(String) - Method in class com.jivesoftware.forum.renderer.RenderedTextStore: Retrieve a text snippet from the store.
getTextBody() - Method in class com.jivesoftware.base.EmailMessage: Returns the text version of the body.
getTextBodyProperty() - Method in class com.jivesoftware.base.EmailMessage: Return the property name for the html version of the email body
getTextExtractors() - Method in interface com.jivesoftware.forum.SearchManager: Returns the current array of TextExtractor objects.
getThread() - Method in class com.jivesoftware.forum.event.ThreadEvent: Returns the ForumThread that the event corresponds to.
getThread(long) - Method in interface com.jivesoftware.forum.Forum: Returns the thread specified by id.
getThreadCount() - Method in interface com.jivesoftware.forum.Forum: Returns the number of threads in the forum.
getThreadCount(ResultFilter) - Method in interface com.jivesoftware.forum.Forum: Returns the number of threads in the forum based on the specified ResultFilter.
getThreadCount() - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of threads in the category.
getThreadCount(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns the number of threads in the category based on the specified ResultFilter.
getThreadID() - Method in class com.jivesoftware.forum.QueryResult: Get the ID of the thread the message belongs to
getThreads() - Method in interface com.jivesoftware.forum.Forum: Returns a Iterator for all the threads in the forum.
getThreads(ResultFilter) - Method in interface com.jivesoftware.forum.Forum: Returns a Iterator for all the threads in the forum that match the criteria specified by the ResultFilter.
getThreads() - Method in interface com.jivesoftware.forum.ForumCategory: Returns a Iterator for all the threads in the category.
getThreads(ResultFilter) - Method in interface com.jivesoftware.forum.ForumCategory: Returns a Iterator for all the threads in the category that match the criteria specified by the ResultFilter.
getThreadWatches(User, ForumCategory, int, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns the ForumThread objects the user is watching under the provided ForumCategory.
getThrowable() - Method in class com.jivesoftware.base.event.LogEvent
getTokens() - Method in class com.jivesoftware.forum.renderer.RenderedTextStore: Returns a list of all the tokens in the store.
getTopUsers(int, int) - Method in interface com.jivesoftware.forum.RewardManager: Returns an iterator for the top point earners in the entire system.
getTopUsers(int, int, ForumCategory) - Method in interface com.jivesoftware.forum.RewardManager: Returns an iterator for the top point earners in a category.
getTopUsers(int, int, Forum) - Method in interface com.jivesoftware.forum.RewardManager: Returns an iterator for the top point earners in a forum.
getTotalCount() - Method in interface com.jivesoftware.forum.SearchManager: Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getTotalCount() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getTotalUserCount() - Method in interface com.jivesoftware.base.Roster: Returns the total number of users in the roster.
getTotalWatchCount(User, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns a count of all watches that a user has of a particular type.
getTreeWalker() - Method in interface com.jivesoftware.forum.ForumThread: Returns the TreeWalker for this thread.
getType() - Method in exception com.jivesoftware.forum.AvatarException
getType() - Method in interface com.jivesoftware.forum.MessageInterceptor: Returns the type of the interceptor.
getUnfilteredBody() - Method in interface com.jivesoftware.forum.Announcement: Returns the announceement body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.forum.JiveContentObject: Returns the body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the message body, bypassing any active filters.
getUnfilteredName() - Method in interface com.jivesoftware.forum.ContentTag: The unfiltered name of the tag
getUnfilteredProperty(String) - Method in interface com.jivesoftware.forum.Announcement: Returns an extended property of the announcement, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.forum.ForumMessage: Returns an extended property of this message, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Returns an extended property of this private message, bypassing any filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.forum.Announcement: Returns the annoucenment subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the message subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.forum.JiveContentObject: Returns the subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns the message subject, bypassing any active filters.
getUnreadMessageCount() - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Returns the number of unread messages in the folder.
getUnreadMessageCount(User) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns the total number of unread private messages a user has in their mailbox.
getUnreadMessageCount(User, Forum) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the count of unread messages that the user has in the forum.
getUnreadMessageCount(User, ForumCategory) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the count of unread messages that the user has in the category.
getUnreadMessages(User, Forum) - Method in interface com.jivesoftware.forum.ReadTracker: Returns an iterator for the unread messages in the forum.
getUnreadMessages(User, ForumCategory) - Method in interface com.jivesoftware.forum.ReadTracker: Returns an iterator for the unread messages in the category.
getUnreadThreadCount(User, Forum) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the count of unread threads that the user has in the forum.
getUnreadThreadCount(User, ForumCategory) - Method in interface com.jivesoftware.forum.ReadTracker: Returns the count of unread threads that the user has in the category.
getUnreadThreads(User, Forum) - Method in interface com.jivesoftware.forum.ReadTracker: Returns an iterator for the unread threads in the forum.
getUnreadThreads(User, ForumCategory) - Method in interface com.jivesoftware.forum.ReadTracker: Returns an iterator for the unread threads in the category.
getUser() - Method in class com.jivesoftware.base.event.UserEvent
getUser() - Method in interface com.jivesoftware.base.Poll: Returns the user who created the poll or null if the poll was created anonymously.
getUser() - Method in interface com.jivesoftware.base.Presence: Return the user owning the presence.
getUser() - Method in interface com.jivesoftware.base.Roster: Returns the user that this roster belongs to.
getUser(long) - Method in interface com.jivesoftware.base.UserManager: Returns a User specified by their ID.
getUser(String) - Method in interface com.jivesoftware.base.UserManager: Returns the User specified by username.
getUser() - Method in interface com.jivesoftware.forum.Announcement: Returns the User that is the author of the announcemnt.
getUser() - Method in interface com.jivesoftware.forum.ForumMessage: Returns the User that authored this message.
getUser() - Method in interface com.jivesoftware.forum.JiveContentObject: Returns the user who authored of the jive object.
getUser() - Method in interface com.jivesoftware.forum.Query: Returns the user that is executing the search.
getUser() - Method in interface com.jivesoftware.forum.Question: Returns the user that created the question.
getUser() - Method in interface com.jivesoftware.forum.Watch: Returns the user who is associated with this watch.
getUser() - Method in class com.jivesoftware.profiles.ProfileEvent
getUserCount() - Method in interface com.jivesoftware.base.UserManager: Returns the number of users in the system.
getUserDocumentation(String) - Method in interface com.jivesoftware.forum.renderer.RenderFilter: Returns a string array of [section,title, body] of xml formatted documentation that is targetted for end user usage.
getUserFromEmailAddress(String) - Method in interface com.jivesoftware.base.AdvancedUserManager: Returns a user object corresponding to the email address given.
getUserGroups(User) - Method in interface com.jivesoftware.base.GroupManager: Returns an iterator for all groups that a user is a member of.
getUserID() - Method in interface com.jivesoftware.base.AuthToken: Returns the userID associated with this AuthToken.
getUserID(String) - Method in interface com.jivesoftware.base.UserManager: Returns the userID specified by the username.
getUserID() - Method in exception com.jivesoftware.base.UserNotFoundException: Returns id of the user not found if available, else -1.
getUserID() - Method in class com.jivesoftware.forum.QuestionFilter: Returns the ID of the creator of questions that results will be filtered on.
getUserID() - Method in class com.jivesoftware.forum.ResultFilter: Returns the userID that results will be filtered on.
getUserManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a UserManager that can be used to manage users.
getUserMessageCount(User) - Method in class com.jivesoftware.forum.ForumFactory: Returns the total number of messages a user has posted in all forums.
getUserMessageCount(User, ResultFilter) - Method in class com.jivesoftware.forum.ForumFactory: Returns the total number of messages a user has posted in all forums that obey the parameters set by the specificed ResultFilter.
getUserMessages(User) - Method in class com.jivesoftware.forum.ForumFactory: Returns an iterator for all messages posted by a user.
getUserMessages(User, ResultFilter) - Method in class com.jivesoftware.forum.ForumFactory: Returns an iterator for all messages posted by a user that obey the parameters set by the specified ResultFilter.
getUsername() - Method in interface com.jivesoftware.base.Presence: Returns the unique username for this status.
getUsername() - Method in interface com.jivesoftware.base.User: Returns the user's username.
getUsername() - Method in exception com.jivesoftware.base.UserNotFoundException: Returns username of the user not found if available, else null.
getUsers() - Method in interface com.jivesoftware.base.Roster: Returns an iterator of users in this roster.
getUsersFromEmailAddress(String) - Method in interface com.jivesoftware.base.AdvancedUserManager: Returns an iterator of user objects corresponding to the email address given.
getUserVoteCount() - Method in interface com.jivesoftware.base.Poll: Returns a count of all user votes for all options in the poll.
getUserVoteCount(int) - Method in interface com.jivesoftware.base.Poll: Returns a count of all user votes for the specified option in the poll.
getUserVotes() - Method in interface com.jivesoftware.base.Poll: Returns an Iterator of User objects for users who have voted for any options in the poll.
getUserVotes(int) - Method in interface com.jivesoftware.base.Poll: Returns an Iterator of User objects for users who have voted for the option at the given index.
getUserVotes(User) - Method in interface com.jivesoftware.base.Poll: Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
getValue() - Method in class com.jivesoftware.base.event.JivePropertyEvent: Returns the value of the jive property
getValue() - Method in class com.jivesoftware.forum.renderer.RenderTarget: Gets the value of a RenderTarget object
getValue() - Method in class com.jivesoftware.forum.renderer.RenderType: Gets the value of a RenderType object
getVoteCount() - Method in interface com.jivesoftware.base.Poll: Returns a count of all votes (both guest and user votes) for all options in the poll.
getVoteCount(int) - Method in interface com.jivesoftware.base.Poll: Returns a count of all votes (both guest and user votes) for the specified option in the poll.
getWatch(User, User) - Method in interface com.jivesoftware.forum.WatchManager: Returns a watch on a particular thread, or null if there isn't a watch.
getWatch(User, ForumThread) - Method in interface com.jivesoftware.forum.WatchManager: Returns a watch on a particular thread, or null if there isn't a watch.
getWatch(User, Forum) - Method in interface com.jivesoftware.forum.WatchManager: Returns a watch on a particular forum, or null if there isn't a watch.
getWatch(User, ForumCategory) - Method in interface com.jivesoftware.forum.WatchManager: Returns a watch on a particular category, or null if there isn't a watch.
getWatchCount(User, Forum) - Method in interface com.jivesoftware.forum.WatchManager: Return the count of all thread watches in a particular forum for the given user.
getWatchCount(User, ForumCategory) - Method in interface com.jivesoftware.forum.WatchManager: Return the count of all forum watches in a particular category for the given user.
getWatchers(int, long) - Method in interface com.jivesoftware.forum.WatchManager: Returns all the Users watching the specified object.
getWatches(User, Forum) - Method in interface com.jivesoftware.forum.WatchManager: Returns an Iterator for all the thread objects a user is watching in a forum.
getWatches(User, ForumCategory) - Method in interface com.jivesoftware.forum.WatchManager: Returns an Iterator for all the forum objects a user is watching in a category.
getWatches(User, Forum, int, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns all the ForumThreads watched by the User under the given Forum.
getWatches(User, ForumCategory, int, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns the Forums watched by the User under the given Category.
getWatchList(User, int) - Method in interface com.jivesoftware.forum.WatchManager: Returns an array of Watch objects for a particular object type that the given user is watching.
getWatchManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a watch manager that can be used to manage watches.
getWatchSettingsManager() - Method in class com.jivesoftware.forum.ForumFactory: Returns a watch settings manager that can be used to manage watch settings.
getWatchType() - Method in interface com.jivesoftware.forum.Watch: Returns the type of the watch.
Group - Interface in com.jivesoftware.base: Organizes users into a group for easier permissions management.
GROUP - Static variable in class com.jivesoftware.base.JiveConstants
GROUP_ADMIN - Static variable in class com.jivesoftware.base.Permissions: Permission to administer a particular group.
GROUP_ADMINISTRATOR_ADDED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever an administrator is added to a group.
GROUP_ADMINISTRATOR_DELETED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever an administrator is deleted from a group.
GROUP_CREATED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever a group is created.
GROUP_DELETED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever a group is deleted.
GROUP_MODIFIED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever a group is modified (properties added, etc).
GROUP_USER_ADDED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever a user is added to a group.
GROUP_USER_DELETED - Static variable in class com.jivesoftware.base.event.GroupEvent: Event type for whenever a user is deleted from a group.
groupAdministratorAdded(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired whenever an administrator is added to a group.
groupAdministratorDeleted(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired whenever an administrator is deleted from a group.
GroupAlreadyExistsException - Exception in com.jivesoftware.base: Thrown when attempting to create a group that already exists.
GroupAlreadyExistsException() - Constructor for exception com.jivesoftware.base.GroupAlreadyExistsException
GroupAlreadyExistsException(String) - Constructor for exception com.jivesoftware.base.GroupAlreadyExistsException
GroupAlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.base.GroupAlreadyExistsException
GroupAlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.base.GroupAlreadyExistsException
groupCache - Static variable in class com.jivesoftware.base.GroupManagerFactory: A cache for group objects.
groupCreated(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired when a group is created.
groupDeleted(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired when a group is deleted.
GroupEvent - Class in com.jivesoftware.base.event: A class for group events.
GroupEvent(int, Group, Map) - Constructor for class com.jivesoftware.base.event.GroupEvent
GroupEventDispatcher - Class in com.jivesoftware.base.event: Implementation of the JiveEventDispatcher for GroupEvent dispatching.
groupIDCache - Static variable in class com.jivesoftware.base.GroupManagerFactory: A cache that maps group names to ID's.
GroupListener - Interface in com.jivesoftware.base.event: A GroupListener gets notified anytime a group event is fired.
GroupManager - Interface in com.jivesoftware.base: Manages groups.
GroupManagerFactory - Class in com.jivesoftware.base: A factory that returns a concrete instance of a group manager.
groupMemberCache - Static variable in class com.jivesoftware.base.GroupManagerFactory: A cache for the list members of in each group.This cache is not instantiated until after this factory is initialized.
groupModified(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired whenever a group is modified (properties added, etc)
GroupNotFoundException - Exception in com.jivesoftware.base: Thrown when unable to find a group.
GroupNotFoundException() - Constructor for exception com.jivesoftware.base.GroupNotFoundException
GroupNotFoundException(String) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
GroupNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
GroupNotFoundException(Throwable) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
groupsWithPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns an Iterator of groups with a particular permission.
groupsWithPermissionCount(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns a count of the groups that have a particular permission.
groupUserAdded(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired when a user is added to a group.
groupUserDeleted(GroupEvent) - Method in interface com.jivesoftware.base.event.GroupListener: Fired when a user is deleted from a group.

H

handleDebugEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener: Fired when a debug event occurs.
handleErrorEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener: Fired when an error event occurs.
handleFatalEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener: Fired when a fatel event occurs.
handleInfoEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener: Fired when an info event occurs.
handleWarnEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener: Fired when a warn event occurs.
hasAnonymousVoted(String) - Method in interface com.jivesoftware.base.Poll: Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.
hashCode() - Method in class com.jivesoftware.base.EmailMessage
hashCode() - Method in class com.jivesoftware.forum.ResultFilter
hasNext() - Method in class com.jivesoftware.forum.ForumMessageIterator: Returns true if this iterator has more messages when traversing the list in the forward direction.
hasNext() - Method in class com.jivesoftware.forum.ForumThreadIterator: Returns true if this iterator has more threads when traversing the list in the forward direction.
hasParent(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns true if the child message has a parent message.
hasPermission(long) - Method in class com.jivesoftware.base.Permissions: Returns true if one or more of the permission types is set to true.
hasPrevious() - Method in class com.jivesoftware.forum.ForumMessageIterator: Returns true if this list iterator has more messages when traversing the list in the reverse direction.
hasPrevious() - Method in class com.jivesoftware.forum.ForumThreadIterator: Returns true if this list iterator has more threads when traversing the list in the reverse direction.
hasQuestion(ForumThread) - Method in interface com.jivesoftware.forum.QuestionManager: Returns true if the thread has a question associated with it.
hasRated(User, ForumMessage) - Method in interface com.jivesoftware.forum.RatingManager: Returns whether the user has rated the forum message or not.
hasRated(User, ForumThread) - Method in interface com.jivesoftware.forum.RatingManager: Returns whether the user has rated the forum thread or not.
hasUserVoted(User) - Method in interface com.jivesoftware.base.Poll: Returns true if the user specified has previously voted in the poll, false otherwise.
HELPFUL_ANSWER_ADDED - Static variable in class com.jivesoftware.forum.event.QuestionEvent: A helpful answer was added to the question.
helpfulAnswerAdded(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when a correct answer has been added to the question.
highlightResult(QueryResult, String, String) - Method in interface com.jivesoftware.forum.Query: Returns a title and summary with search words highlighted appropriate to the search query string.
HOUR - Static variable in class com.jivesoftware.base.JiveConstants: One hour (in milliseconds).

I

include(long) - Method in class com.jivesoftware.forum.renderer.RenderStrategy
info(String) - Static method in class com.jivesoftware.base.Log
info(Throwable) - Static method in class com.jivesoftware.base.Log
info(String, Throwable) - Static method in class com.jivesoftware.base.Log
INFO_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent: Event type for whenever a info log event occurs.
initialize() - Method in class com.jivesoftware.base.EmailManager
initialize() - Method in class com.jivesoftware.base.GroupManagerFactory
initialize() - Method in class com.jivesoftware.base.PollManagerFactory
initialize() - Method in class com.jivesoftware.base.UserManagerFactory
initialize() - Method in class com.jivesoftware.forum.AvatarManagerFactory
initialize() - Method in class com.jivesoftware.forum.renderer.RendererFactory
initialize() - Method in class com.jivesoftware.forum.StatusLevelManagerFactory
initLog() - Static method in class com.jivesoftware.base.Log: This method is used to initialize the Log class.
InterceptorManager - Interface in com.jivesoftware.forum: Manages interceptors.
IntrospectiveGroup - Interface in com.jivesoftware.base: This Group subinterface adds the ability to query what optional capabilities are supported in this Group implementation.
IntrospectiveGroupManager - Interface in com.jivesoftware.base: Interface that marks which GroupManager features a particular GroupManager implementation supports.
IntrospectiveUser - Interface in com.jivesoftware.base: This User subinterface adds the ability to query what optional capabilities are supported in this User implementation.
IntrospectiveUserManager - Interface in com.jivesoftware.base: This UserManager subinterface adds the ability to query what optional capabilities are supported in this UserManager implementation.
invokeInterceptor(ForumMessage, int) - Method in interface com.jivesoftware.forum.MessageInterceptor: Invokes the interceptor on the specified message.
isAddAdministratorSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether adding an administrator to this group is supported.
isAddMemberSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether adding a member to this group is supported.
isAdministrator(User) - Method in interface com.jivesoftware.base.Group: Returns true if the User has group administrator permissions.
isAdministratorListSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether returning a list of group administrators is supported.
isAllowImageResize() - Method in interface com.jivesoftware.forum.AvatarManager: Returns true if the system should attempt to resize images
isAllTagsRequired() - Method in class com.jivesoftware.forum.ResultFilter: Returns true if the content must be tagged with every tag contained in getTags().
isAnonymous() - Method in interface com.jivesoftware.base.AuthToken: Returns true if this AuthToken is the Anonymous auth token.
isAnonymous() - Method in interface com.jivesoftware.forum.ForumMessage: Returns true if this message was posted anonymously.
isArchivingEnabled(Forum) - Method in interface com.jivesoftware.forum.ArchiveManager: Returns true if archiving is enabled for the specified forum.
isAttachmentSearchEnabled() - Method in interface com.jivesoftware.forum.SearchManager: Returns true if the attachment search feature is turned on.
isAuthorized(long) - Method in interface com.jivesoftware.base.Group: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.base.Poll: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.base.User: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.forum.Forum: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.forum.ForumCategory: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in class com.jivesoftware.forum.ForumFactory: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.forum.ForumMessage: Returns true if the handle on this object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.forum.ForumThread: Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.forum.PrivateMessage: Returns true if the handle on this object has the permission specified.
isAutoArchiveEnabled() - Method in interface com.jivesoftware.forum.ArchiveManager: Returns true if auto-archiving is enabled.
isAutoIndexEnabled() - Method in interface com.jivesoftware.forum.SearchManager: Returns true if auto indexing is turned on.
isAutoIndexEnabled() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns true if auto indexing is turned on.
isAvatarsEnabled() - Method in interface com.jivesoftware.forum.AvatarManager: Returns true if the avatars feature is enabled, else false
isAvatarsEnabled() - Static method in class com.jivesoftware.forum.AvatarManagerFactory
isBankEnabled() - Method in interface com.jivesoftware.forum.RewardManager: Returns true if bank points are enabled.
isBusy() - Method in interface com.jivesoftware.forum.ArchiveManager: Returns true if the archiving process is currently running.
isBusy() - Method in interface com.jivesoftware.forum.SearchManager: Returns true if the search manager is currently busy with an search indexing task.
isBusy() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns true if the search manager is currently busy with an search indexing task.
isCorrectAnswer(ForumMessage) - Method in interface com.jivesoftware.forum.Question: Returns true if the specified message is the correct answer.
isCreateGroupSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager: Indicates whether the GroupManager supports creating groups via the createGroups() method.
isCreateUserSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager: Indicates whether user creation (createUser(String username, String password, String email)) is supported.
isDatabaseModeEnabled() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns true if the binary attachment data is stored in the database.
isDebugEnabled() - Static method in class com.jivesoftware.base.Log
isDeleteGroupSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager: Indicates whether the GroupManager supports deleting groups via the deleteGroups() method.
isDeleteUserSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager: Indicates whether user deletion (deleteUser(User user)) is supported.
isEmailVisible() - Method in interface com.jivesoftware.base.User: Returns true if the user has chosen to make her email visible to other users.
isEmailVisible() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Determines whether or not user email addresses are visible when performing a user search.
isEnabled() - Method in interface com.jivesoftware.forum.renderer.RenderFilter: Returns true if the filter is enabled, false otherwise.
isErrorEnabled() - Static method in class com.jivesoftware.base.Log
isExpirable() - Method in interface com.jivesoftware.forum.Watch: Returns whether this watch is expirable or not.
isFilterHTMLEnabled() - Method in interface com.jivesoftware.forum.SearchManager: Determines whether to filter out HTML when indexing and retrieving messages.
isGetAdministratorCountSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether getting a count of administrators is supported.
isGetMemberCountSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether getting a count of members is supported.
isGetPasswordHashSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether retrieving a password hash is supported for this user.
isGetUserCountSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager: Indicates whether getting a count of all users (getUserCount()) is supported.
isGetUserFromEmailAddressSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager: Indicates whether retrieving a user for an email address (getUserFromEmailAddress(String emailAddr)) is supported.
isGetUserGroupsSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager: Indicates whether the GroupManager supports getting a listing of all groups for a given user via the getUserGroups() method.
isGroupByForum() - Method in class com.jivesoftware.forum.QuestionFilter: Returns true if results will be grouped by forum.
isGroupListSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager: Indicates whether the GroupManager supports getting a listing of all groups via the getGroups() method.
isHelpfulAnswer(ForumMessage) - Method in interface com.jivesoftware.forum.Question: Returns true if the specified message has been marked as a helpful answer to this question.
isHtml() - Method in interface com.jivesoftware.forum.ForumMessage: Returns true if this body of this message contains HTML.
isImagePreviewEnabled() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns true if image preview support is enabled.
isImagePreviewRatioEnabled() - Method in interface com.jivesoftware.forum.AttachmentManager: Returns true if the aspect ratio of thumbnails should be preserved.
isInfoEnabled() - Static method in class com.jivesoftware.base.Log
isInRange(int) - Method in interface com.jivesoftware.forum.StatusLevel: Used to check to see if a point value is in the range for this status level
isLeaf(ForumMessage) - Method in interface com.jivesoftware.forum.TreeWalker: Returns true if node is a leaf.
isMember(User) - Method in interface com.jivesoftware.base.Group: Returns true if if the User is a member of the group.
isMembersSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether returning a list of group members is supported.
isModeEnabled(long) - Method in interface com.jivesoftware.base.Poll: Returns true if the mode specified is enabled for the poll, false otherwise.
isModerateUserAvatars() - Method in interface com.jivesoftware.forum.AvatarManager: Returns whether or not user avatars will be moderated.
isNameVisible() - Method in interface com.jivesoftware.base.User: Returns true if the user has chosen to make her name visible to other users.
isOnline(User) - Method in interface com.jivesoftware.base.PresenceManager: Returns whether the user is currently online or not.
isPresencesEnabled() - Method in interface com.jivesoftware.base.PresenceManager: Returns whether presences are enabled on a global basis or not.
isPrivateMessagesEnabled() - Method in interface com.jivesoftware.forum.PrivateMessageManager: Returns true if the feature is enabled, false otherwise.
isPropertyEditSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether the property methods (get, set, delete, etc.) are supported.
isPropertyEditSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether the property methods (get, set, delete, etc.) are supported.
isRatingsEnabled() - Method in interface com.jivesoftware.forum.RatingManager: Returns true if the rating feature is turned on.
isRead() - Method in interface com.jivesoftware.forum.PrivateMessage: Returns true if this message has been marked as read.
isReadOnly() - Method in interface com.jivesoftware.base.IntrospectiveGroup
isReadOnly() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager
isReadOnly() - Method in interface com.jivesoftware.base.IntrospectiveUser: Convenience method - returns true if the user is in a 'read only' mode - that is, none of the setter methods are implemented.
isReadOnly() - Method in interface com.jivesoftware.base.IntrospectiveUserManager
isReadTrackingEnabled() - Method in interface com.jivesoftware.forum.ReadTracker: Returns true if read tracking is enabled, false otherwise.
isRecursive() - Method in class com.jivesoftware.forum.ResultFilter: If true, the result filter will return content from all sub-communities of specified community, including content from sub-communities of sub-communities, etc.
isRemoveAdministratorSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether removing a group administrator is supported.
isRemoveMemberSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether removing a group member is supported.
isRewardsEnabled() - Method in interface com.jivesoftware.forum.RewardManager: Returns true if rewards are enabled, false otherwise.
isRosterMember(User) - Method in interface com.jivesoftware.base.Roster: Returns true if the specified user is a member of the roster, false otherwise.
isSearchEnabled() - Method in interface com.jivesoftware.forum.SearchManager: Returns true if the search feature is turned on.
isSearchEnabled() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns true if the profile search feature is turned on.
isSetDescriptionSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether modifying the group description is supported.
isSetEmailSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether setting the email address is supported for this user.
isSetEmailVisibleSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether setting the visibility of the email address is supported for this user.
isSetNameSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroup: Indicates whether modifying the group name is supported.
isSetNameSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether setting the full name is supported for this user.
isSetNameVisibleSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether setting the visibility of the name is supported for this user.
isSetPasswordHashSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether modifying the hash of the user's password is supported for this user.
isSetPasswordSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser: Indicates whether modifying the user's password is supported.
isSingleTagMacro() - Method in interface com.jivesoftware.forum.renderer.RenderMacro: Returns true is the macro has only a single tag such as {testMacro}, false if the macro should have both an opening and closing tag ({testMacro}text here{testMacro})
isStatusLevelsEnabled() - Method in interface com.jivesoftware.forum.StatusLevelManager: Returns true if status levels are enabled in the system
isStatusLevelsEnabled() - Static method in class com.jivesoftware.forum.StatusLevelManagerFactory
isUserAvatarsEnabled() - Method in interface com.jivesoftware.forum.AvatarManager: Returns true if users can create their own avatars, false otherwise.
isUserListSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager: Indicates whether getting an Iterator of all users (users()) is supported.
isValidType(String) - Method in interface com.jivesoftware.forum.AttachmentManager: Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.
isWarnEnabled() - Static method in class com.jivesoftware.base.Log
isWatched(User, ForumCategory) - Method in interface com.jivesoftware.forum.WatchManager: Returns true if the user is watching the specified category.
isWatched(User, Forum) - Method in interface com.jivesoftware.forum.WatchManager: Returns true if the user is watching the specified forum.
isWatched(User, ForumThread) - Method in interface com.jivesoftware.forum.WatchManager: Returns true if the user is watching the specified thread.
isWatched(User, User) - Method in interface com.jivesoftware.forum.WatchManager: Returns true if the user is watching the specified user.
isWildcardIgnored() - Method in interface com.jivesoftware.forum.SearchManager: Returns true if wildcarding is disabled.

J

JIVE_PORTLET - Static variable in class com.jivesoftware.base.JiveConstants
JiveConstants - Class in com.jivesoftware.base: Contains constant values representing various objects in Jive.
JiveContentObject - Interface in com.jivesoftware.forum
JiveEvent - Interface in com.jivesoftware.base: JiveEvent is the base interface that all events must implement.
JiveObject - Interface in com.jivesoftware.base: An interface for watchable objects.
jivePropertyAdded(JivePropertyEvent) - Method in interface com.jivesoftware.base.event.JivePropertyListener: Fired when a jive property is added
jivePropertyAdded(JivePropertyEvent) - Method in class com.jivesoftware.forum.StatusLevelManagerFactory.StatusCalculatorPropertyListener
JivePropertyEvent - Class in com.jivesoftware.base.event: An event for JiveProperty changes Certain event types will populate the params Map with additional objects as outlined below: Event Type Extra Params PROPERTY_ADDED none PROPERTY_REMOVED REMOVED_VALUES => list of values (excluding event param value) PROPERTY_MODIFIED PARAM_MODIFIED_OLD_VALUE -> original value value
JivePropertyEvent(int, String, String, Map) - Constructor for class com.jivesoftware.base.event.JivePropertyEvent: Creates a new jive property event.
JivePropertyEventDispatcher - Class in com.jivesoftware.base.event: Dispatcher for jive property events.
JivePropertyListener - Interface in com.jivesoftware.base.event: Listener for jive property events.
jivePropertyModified(JivePropertyEvent) - Method in interface com.jivesoftware.base.event.JivePropertyListener: Fired when a jive property is modified
jivePropertyModified(JivePropertyEvent) - Method in class com.jivesoftware.forum.StatusLevelManagerFactory.StatusCalculatorPropertyListener
jivePropertyRemoved(JivePropertyEvent) - Method in interface com.jivesoftware.base.event.JivePropertyListener: Fired when a jive property is removed
jivePropertyRemoved(JivePropertyEvent) - Method in class com.jivesoftware.forum.StatusLevelManagerFactory.StatusCalculatorPropertyListener

K

KB_CATEGORY - Static variable in class com.jivesoftware.base.JiveConstants
KB_CATEGORY_INDEX - Static variable in class com.jivesoftware.base.JiveConstants
KB_COMMENT - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_BODY - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_FIELD - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_FIELD_OPTION - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_FIELD_TYPE - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_ID - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_PRESENTER - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_STATE - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_TITLE - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_TYPE - Static variable in class com.jivesoftware.base.JiveConstants
KB_DOCUMENT_TYPE_ELEMENT - Static variable in class com.jivesoftware.base.JiveConstants
KB_ENTRY - Static variable in class com.jivesoftware.base.JiveConstants
KB_ENTRY_PART - Static variable in class com.jivesoftware.base.JiveConstants
KB_ENTRY_TITLE - Static variable in class com.jivesoftware.base.JiveConstants
KB_ENTRY_TYPE - Static variable in class com.jivesoftware.base.JiveConstants
KB_IMAGE - Static variable in class com.jivesoftware.base.JiveConstants
KB_RECOMMENDATION - Static variable in class com.jivesoftware.base.JiveConstants
KB_SEARCH_QUERY - Static variable in class com.jivesoftware.base.JiveConstants
KB_TEMPORARY_DOCUMENT_ID - Static variable in class com.jivesoftware.base.JiveConstants
KB_VERSION - Static variable in class com.jivesoftware.base.JiveConstants
KB_VERSION_COMMENT - Static variable in class com.jivesoftware.base.JiveConstants

L

Log - Class in com.jivesoftware.base: Simple wrapper to the JDK logger.
LogEvent - Class in com.jivesoftware.base.event: A class for log events.
LogEvent(int, Map) - Constructor for class com.jivesoftware.base.event.LogEvent
LogEvent(int, Map, Throwable, String) - Constructor for class com.jivesoftware.base.event.LogEvent
LogEventDispatcher - Class in com.jivesoftware.base.event: Implementation of the JiveEventDispatcher for LogEvent dispatching.
loginUser(String, String, boolean, HttpServletRequest, HttpServletResponse) - Static method in class com.jivesoftware.base.AuthFactory: This method is a method for logging a user in and creating the appropriate session variables and/or cookies to keep state.
LogListener - Interface in com.jivesoftware.base.event: A LogListener gets notified anytime a log event is fired.
logoutUser(HttpServletRequest, HttpServletResponse) - Static method in class com.jivesoftware.base.AuthFactory: This method is a method for logging a user out and destroying or resetting the appropriate session variables and/or cookies to keep state.
logQuery(User) - Method in interface com.jivesoftware.forum.Query: Logs the query for later statistical analysis.
logSearchClick(long, long) - Method in interface com.jivesoftware.forum.Query: Logs a search result clickthrough.

M

MARK_THREADS - Static variable in interface com.jivesoftware.forum.ArchiveManager: An archive mode that specifies that threads are marked as archived and left in their original forum.
markDebugLogFile(User) - Static method in class com.jivesoftware.base.Log
markErrorLogFile(User) - Static method in class com.jivesoftware.base.Log
markInfoLogFile(User) - Static method in class com.jivesoftware.base.Log
markRead(User, ForumMessage) - Method in interface com.jivesoftware.forum.ReadTracker: Marks an individual message as read.
markRead(User, Forum) - Method in interface com.jivesoftware.forum.ReadTracker: Marks an entire forum as read up until the current instant in time.
markRead(User, ForumCategory) - Method in interface com.jivesoftware.forum.ReadTracker: Marks an entire category as read up until the current instant in time.
markWarnLogFile(User) - Static method in class com.jivesoftware.base.Log
mergeForums(Forum, Forum) - Method in class com.jivesoftware.forum.ForumFactory: Merges the content of two forums by copying the threads from forum2 to forum1.
MESSAGE - Static variable in class com.jivesoftware.base.JiveConstants
MESSAGE_ADDED - Static variable in class com.jivesoftware.forum.event.MessageEvent: Message was added to the system.
MESSAGE_ADDED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever a message is added to the search index.
MESSAGE_BODY - Static variable in class com.jivesoftware.base.JiveConstants
MESSAGE_DELETED - Static variable in class com.jivesoftware.forum.event.MessageEvent: Message was deleted.
MESSAGE_DELETED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever a message is removed from the search index.
MESSAGE_MODERATION_MODIFIED - Static variable in class com.jivesoftware.forum.event.MessageEvent: The moderation value of the message was changed.
MESSAGE_MODIFIED - Static variable in class com.jivesoftware.forum.event.MessageEvent: The message was modified.
MESSAGE_MOVED - Static variable in class com.jivesoftware.forum.event.MessageEvent: The message was moved by becoming the root message of a new thread.
MESSAGE_RATED - Static variable in class com.jivesoftware.forum.event.MessageEvent: The message was rated.
MESSAGE_SUBJECT - Static variable in class com.jivesoftware.base.JiveConstants
messageAdded(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when a message has been added to the system.
messageAdded(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when a message is added to the index.
messageDeleted(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when a message is about to be deleted from the system.
messageDeleted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when a message is deleted from the search index.
MessageEvent - Class in com.jivesoftware.forum.event: An event for ForumMessage objects.
MessageEvent(int, ForumMessage, Map) - Constructor for class com.jivesoftware.forum.event.MessageEvent: Creates a new message event.
MessageEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for message events.
MessageInterceptor - Interface in com.jivesoftware.forum: 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.
MessageListener - Interface in com.jivesoftware.forum.event: Listener for message events.
messageModerationModified(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when the moderation value of a message has been changed.
messageModified(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when portions of a message have been modified.
messageMoved(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when a message is moved to another thread.
messageRated(MessageEvent) - Method in interface com.jivesoftware.forum.event.MessageListener: Fired when a message has been rated.
MessageRejectedException - Exception in com.jivesoftware.forum: Thrown by a MessageInterceptor when a message is prevented from being posted.
MessageRejectedException(String) - Constructor for exception com.jivesoftware.forum.MessageRejectedException
MessageRejectedException(String, ForumMessage) - Constructor for exception com.jivesoftware.forum.MessageRejectedException
MessageRejectedException(Throwable, ForumMessage) - Constructor for exception com.jivesoftware.forum.MessageRejectedException
messages - Static variable in exception com.jivesoftware.forum.AttachmentException
MINUTE - Static variable in class com.jivesoftware.base.JiveConstants: One minute (in milliseconds).
MODERATOR - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to moderate threads.
MODIFICATION_DATE - Static variable in class com.jivesoftware.base.JiveConstants
MOVE_THREADS - Static variable in interface com.jivesoftware.forum.ArchiveManager: An archive mode that specifies that threads should be moved to another forum.
moveCategory(ForumCategory, ForumCategory) - Method in interface com.jivesoftware.forum.ForumCategory: Moves a sub-category to another category.
moveForum(Forum, ForumCategory) - Method in interface com.jivesoftware.forum.ForumCategory: Moves a forum from this category to another.
moveMessage(PrivateMessage, PrivateMessageFolder) - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Moves a private message to another folder.
moveThread(ForumThread, Forum) - Method in interface com.jivesoftware.forum.Forum: Moves a thread from one forum to another.
MULTIPLE_SELECTIONS_ALLOWED - Static variable in interface com.jivesoftware.base.Poll: Mode to allow users to select multiple options in a poll.

N

NameAlreadyExistsException - Exception in com.jivesoftware.forum
NameAlreadyExistsException() - Constructor for exception com.jivesoftware.forum.NameAlreadyExistsException
NameAlreadyExistsException(String) - Constructor for exception com.jivesoftware.forum.NameAlreadyExistsException
NEGATIVE - Static variable in class com.jivesoftware.base.PermissionType: The negative permission type indicates that the permission should be 'revoked' or 'removed' from permissions retrieved from parent object(s).
next() - Method in class com.jivesoftware.forum.ForumMessageIterator: Returns the next message in the list.
next() - Method in class com.jivesoftware.forum.ForumThreadIterator: Returns the next thread in the list.
NO_MARKUP_STRATEGY - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: A render stragegy used to render text without any markup
NONE - Static variable in class com.jivesoftware.base.Permissions: No permissions.
NORMAL_WATCH - Static variable in interface com.jivesoftware.forum.Watch: Normal watch type.
NOT_ALLOWED - Static variable in exception com.jivesoftware.forum.PrivateMessageRejectedException
NotFoundException - Exception in com.jivesoftware.base: Thrown when trying to load an object that does not exist, or the object could not be loaded.
NotFoundException() - Constructor for exception com.jivesoftware.base.NotFoundException
NotFoundException(String) - Constructor for exception com.jivesoftware.base.NotFoundException
NotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.base.NotFoundException
NotFoundException(Throwable) - Constructor for exception com.jivesoftware.base.NotFoundException
NULL_INT - Static variable in class com.jivesoftware.forum.QuestionFilter: An integer value that represents NULL.
NULL_INT - Static variable in class com.jivesoftware.forum.ResultFilter: An integer value that represents NULL.

O

OFFLINE - Static variable in class com.jivesoftware.base.JiveConstants
open - Static variable in class com.jivesoftware.forum.Question.State: The question is not resolved.
optimize() - Method in interface com.jivesoftware.forum.SearchManager: Optimizes the underlying search index for maximum speed.
optimize() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Optimizes the underlying search index for maximum speed.
OPTIMIZE_COMPLETED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index optimize is completed.
OPTIMIZE_COMPLETED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index optimize is completed.
OPTIMIZE_STARTED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index optimize is started.
OPTIMIZE_STARTED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index optimize is started.
optimizeCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index optimization is completed.
optimizeCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index optimization is completed.
optimizeStarted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index optimization is started.
optimizeStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index optimization is started.
OR_MODE - Static variable in class com.jivesoftware.forum.ResultFilter: 'OR' mode;

P

PARAM_MODIFIED_OLD_VALUE - Static variable in class com.jivesoftware.base.event.JivePropertyEvent: Param map value for modified values on a PROPERTY_MODIFIED event
PARAM_REMOVED_VALUES - Static variable in class com.jivesoftware.base.event.JivePropertyEvent: Param map value for removed values on a PROPERTY_REMOVED event
PERM_HIDDEN_MESSAGE - Static variable in class com.jivesoftware.base.JiveConstants: Used as an alternative to removing messages from the database.
permissionModificationDetected() - Method in interface com.jivesoftware.base.PermissionsManager: Is called when a permission is modified.
Permissions - Class in com.jivesoftware.base: Represents a set of permissions that an entity has for an object in the system.
Permissions(long) - Constructor for class com.jivesoftware.base.Permissions: Create a new permissions object with the specified permissions.
Permissions(Permissions, Permissions) - Constructor for class com.jivesoftware.base.Permissions: Creates a new Permission object by combining two permissions objects.
PERMISSIONS - Static variable in class com.jivesoftware.base.Permissions: The enumeration of permissions
PERMISSIONS - Static variable in class com.jivesoftware.forum.ForumPermissions: The enumeration of permissions.
PermissionsManager - Interface in com.jivesoftware.base: Manages permissions for users and groups on a particular resource.
PermissionType - Class in com.jivesoftware.base: A class to represent the two modes of permissions - additive and negative.
PLAIN_STRATEGY - Static variable in interface com.jivesoftware.forum.JiveContentObject
POLL - Static variable in class com.jivesoftware.base.JiveConstants
Poll - Interface in com.jivesoftware.base: A poll can be attached to any object in the system or can exist at the global level.
POLL_CREATED - Static variable in class com.jivesoftware.base.event.PollEvent: A poll was created.
POLL_DELETED - Static variable in class com.jivesoftware.base.event.PollEvent: A poll is about to be deleted.
pollCache - Static variable in class com.jivesoftware.base.PollManagerFactory
pollCreated(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when a poll is created.
pollDeleted(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when a poll is deleted.
PollEvent - Class in com.jivesoftware.base.event: An event for Poll objects.
PollEvent(int, Poll, Map) - Constructor for class com.jivesoftware.base.event.PollEvent: Creates a new message event.
PollEventDispatcher - Class in com.jivesoftware.base.event: Poll event dispatcher.
PollException - Exception in com.jivesoftware.base: A poll exception is thrown by methods in the Poll class.
PollException() - Constructor for exception com.jivesoftware.base.PollException
PollException(String) - Constructor for exception com.jivesoftware.base.PollException
PollException(Throwable) - Constructor for exception com.jivesoftware.base.PollException
PollException(String, Throwable) - Constructor for exception com.jivesoftware.base.PollException
PollListener - Interface in com.jivesoftware.base.event: A PollListener gets notified anytime a poll event is fired.
PollManager - Interface in com.jivesoftware.base: Provides a manager to create, retrieve and delete polls.
PollManagerFactory - Class in com.jivesoftware.base: A factory that returns a concrete instance of a poll manager.
pollQueryCache - Static variable in class com.jivesoftware.base.PollManagerFactory
PORTLET - Static variable in class com.jivesoftware.base.JiveConstants
possibly_resolved - Static variable in class com.jivesoftware.forum.Question.State: There are one or more possible answers to the question.
Presence - Interface in com.jivesoftware.base: A Presence encapsulates information relating to the owning user such as login time, status and last update time.
PresenceManager - Interface in com.jivesoftware.base: The presence manager creates presences and keeps track on a global basis who's online.
previous() - Method in class com.jivesoftware.forum.ForumMessageIterator: Returns the previous element in the list.
previous() - Method in class com.jivesoftware.forum.ForumThreadIterator: Returns the previous element in the list.
printStackTrace() - Method in exception com.jivesoftware.base.UnauthorizedException
printStackTrace(PrintStream) - Method in exception com.jivesoftware.base.UnauthorizedException
printStackTrace(PrintWriter) - Method in exception com.jivesoftware.base.UnauthorizedException
printStackTrace() - Method in exception com.jivesoftware.forum.AttachmentException
printStackTrace(PrintStream) - Method in exception com.jivesoftware.forum.AttachmentException
printStackTrace(PrintWriter) - Method in exception com.jivesoftware.forum.AttachmentException
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.base.JiveConstants
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to get and send private messages.
PRIVATE_MESSAGE_FOLDER - Static variable in class com.jivesoftware.base.JiveConstants
PRIVATE_MESSAGE_SENT - Static variable in class com.jivesoftware.forum.event.PrivateMessageEvent: A private message was sent.
PrivateMessage - Interface in com.jivesoftware.forum: Private messages are used for user to user communication.
PrivateMessageEvent - Class in com.jivesoftware.forum.event: An event for PrivateMessage objects.
PrivateMessageEvent(int, PrivateMessage, Map) - Constructor for class com.jivesoftware.forum.event.PrivateMessageEvent: Creates a new private message event.
PrivateMessageEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for private message events.
PrivateMessageFolder - Interface in com.jivesoftware.forum: Holds private messages.
PrivateMessageFolderNotFoundException - Exception in com.jivesoftware.forum
PrivateMessageFolderNotFoundException() - Constructor for exception com.jivesoftware.forum.PrivateMessageFolderNotFoundException
PrivateMessageFolderNotFoundException(String) - Constructor for exception com.jivesoftware.forum.PrivateMessageFolderNotFoundException
PrivateMessageListener - Interface in com.jivesoftware.forum.event: Listener for private message events.
PrivateMessageManager - Interface in com.jivesoftware.forum: Manages the private message feature.
PrivateMessageNotFoundException - Exception in com.jivesoftware.forum: Thrown when a private message could not be loaded.
PrivateMessageNotFoundException() - Constructor for exception com.jivesoftware.forum.PrivateMessageNotFoundException
PrivateMessageNotFoundException(String) - Constructor for exception com.jivesoftware.forum.PrivateMessageNotFoundException
PrivateMessageRejectedException - Exception in com.jivesoftware.forum: Thrown when a private is prevented from being posted.
PrivateMessageRejectedException(int) - Constructor for exception com.jivesoftware.forum.PrivateMessageRejectedException: Creates a new PrivateMessageRejectedException.
privateMessageSent(PrivateMessageEvent) - Method in interface com.jivesoftware.forum.event.PrivateMessageListener: Fired when a private message is sent.
PROFILE_FIELD - Static variable in class com.jivesoftware.base.JiveConstants
PROFILE_MODIFIED - Static variable in class com.jivesoftware.profiles.ProfileEvent: Event type for whenever a user profile is modified.
ProfileEvent - Class in com.jivesoftware.profiles: A class for profile events.
ProfileEvent(int, User) - Constructor for class com.jivesoftware.profiles.ProfileEvent
ProfileFieldFormatter - Interface in com.jivesoftware.profiles.formatter: Profile field formatter format a profile field for display to the end user.
ProfileFieldValidator - Interface in com.jivesoftware.profiles.validator: Profile field validator validate a profile field value as entered or selected by the end user.
ProfileSearchIndexEvent - Class in com.jivesoftware.profiles.search: A class for search index events.
ProfileSearchIndexEvent(int, Map) - Constructor for class com.jivesoftware.profiles.search.ProfileSearchIndexEvent
ProfileSearchIndexEventDispatcher - Class in com.jivesoftware.profiles.search: Implementation of the JiveEventDispatcher for ProfileSearchIndexEvent dispatching.
ProfileSearchIndexListener - Interface in com.jivesoftware.profiles.search: A ProfileSearchIndexListener gets notified anytime an search index event is fired.
ProfileSearchManager - Interface in com.jivesoftware.profiles.search: Manages the search feature of Jive Expert User Search by defining properties of the search indexer.
PROPERTY - Static variable in class com.jivesoftware.forum.renderer.RenderType: Type representing a message property.
PROPERTY_ADDED - Static variable in class com.jivesoftware.base.event.JivePropertyEvent: A new property was added
PROPERTY_MODIFIED - Static variable in class com.jivesoftware.base.event.JivePropertyEvent: A property was modified.
PROPERTY_MODIFIED - Static variable in class com.jivesoftware.forum.event.QuestionEvent: An extended property of the question was added, deleted, or updated.
PROPERTY_REMOVED - Static variable in class com.jivesoftware.base.event.JivePropertyEvent: A property was removed.
propertyModified(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when an extended property of a question is added, modified, or deleted.

Q

Query - Interface in com.jivesoftware.forum: Encapsulates a search for content in a forum.
QueryLogger - Interface in com.jivesoftware.forum: This manager provides methods to retrieve query objects previously used for searching either the whole system or just in particular forums.
QueryLoggerFactory - Class in com.jivesoftware.forum: A factory that returns a concrete instance of a query logger.
QueryManager - Interface in com.jivesoftware.forum: This manager provides methods to create query objects to be used for searching either the whole system or just in particular forums.
QueryResult - Class in com.jivesoftware.forum: Encapsulates a search result resulting from a search using the Query class.
QueryResult(ForumMessage, float) - Constructor for class com.jivesoftware.forum.QueryResult: Creates a new QueryResult object.
QueryResult(long, long, long, String, Date, Date, float) - Constructor for class com.jivesoftware.forum.QueryResult: Creates a new QueryResult object.
QUESTION - Static variable in class com.jivesoftware.base.JiveConstants
Question - Interface in com.jivesoftware.forum: Questions provide additional workflow around a thread; the thread creator asks a question and the question moves from unresolved to resolved as one or more answers are posted to the question.
Question.State - Class in com.jivesoftware.forum: Type-safe enumeration for the state a question is in.
QUESTION_ADDED - Static variable in class com.jivesoftware.forum.event.QuestionEvent: Question was added to the system.
QUESTION_DELETED - Static variable in class com.jivesoftware.forum.event.QuestionEvent: Question was deleted.
QUESTION_STATE_MODIFIED - Static variable in class com.jivesoftware.forum.event.QuestionEvent: The question resolution state was modified.
questionAdded(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when a question has been added to the system.
questionDeleted(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when a question is about to be deleted from the system.
QuestionEvent - Class in com.jivesoftware.forum.event: An event for Question objects.
QuestionEvent(int, Question, Map) - Constructor for class com.jivesoftware.forum.event.QuestionEvent: Creates a new question event.
QuestionEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for question events.
QuestionFilter - Class in com.jivesoftware.forum: Filters and sorts lists of questions from QuestionManager.
QuestionFilter() - Constructor for class com.jivesoftware.forum.QuestionFilter: Constructs a new QuestionFilter.
QuestionFilter.SortField - Class in com.jivesoftware.forum: Type-safe enumeration for field that be sorted on.
QuestionListener - Interface in com.jivesoftware.forum.event: Listener for message events.
QuestionManager - Interface in com.jivesoftware.forum: Manages questions.
questionStateModified(QuestionEvent) - Method in interface com.jivesoftware.forum.event.QuestionListener: Fired when the resolution state of a question changes.

R

RATE_MESSAGE - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to rate messages.
RATING - Static variable in class com.jivesoftware.base.JiveConstants
RATING - Static variable in interface com.jivesoftware.forum.Query: Sort by rating
Rating - Interface in com.jivesoftware.forum: A container object for Ratings.
RatingManager - Interface in com.jivesoftware.forum: Provides optional rating of forum messages.
RatingManagerFactory - Class in com.jivesoftware.forum: A factory that returns a concrete instance of a rating manager.
ratingsCache - Static variable in class com.jivesoftware.forum.RatingManagerFactory
READ - Static variable in interface com.jivesoftware.forum.ReadTracker: Status to indicate that the object has been read.
READ_FORUM - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to read object.
READ_STAT - Static variable in class com.jivesoftware.base.JiveConstants
READ_STAT_SESSION - Static variable in class com.jivesoftware.base.JiveConstants
readExternal(DataInput) - Method in class com.jivesoftware.forum.QueryResult
ReadTracker - Interface in com.jivesoftware.forum: Provides optional tracking of the messages and threads that each user has read.
REBUILD_COMPLETED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index rebuild is completed.
REBUILD_COMPLETED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index rebuild is completed.
REBUILD_STARTED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index rebuild is started.
REBUILD_STARTED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index rebuild is started.
rebuildCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index rebuild is completed.
rebuildCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index rebuild is completed.
rebuildIndex() - Method in interface com.jivesoftware.forum.SearchManager: Manually rebuild the entire index.
rebuildIndex() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Manually rebuild the entire index.
rebuildStarted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index rebuild is started.
rebuildStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index rebuild is started.
RECIPIENT_MAILBOX_FULL - Static variable in exception com.jivesoftware.forum.PrivateMessageRejectedException
REGISTERED_USERS - Static variable in class com.jivesoftware.base.JiveConstants
registeredUserHasPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns true if registered users have a particular permission.
REJECTED_MESSAGE - Static variable in class com.jivesoftware.base.JiveConstants: Messages rejected by a moderator will be marked with this value.
RELEVANCE - Static variable in interface com.jivesoftware.forum.Query: Sort by relevance
remove() - Method in class com.jivesoftware.forum.ForumMessageIterator: This method of the Iterator interface is not supported due to security considerations.
remove() - Method in class com.jivesoftware.forum.ForumThreadIterator: This method of the Iterator interface is not supported due to security considerations.
removeAdministrator(User) - Method in interface com.jivesoftware.base.Group: Revokes administrator privileges of the group to a user.
removeAllFilters() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Removes all filters from the current context.
removeAllGroupPermissions(PermissionType) - Method in interface com.jivesoftware.base.PermissionsManager: Revokes all group permissions.
removeAllListeners() - Method in class com.jivesoftware.base.event.JivePropertyEventDispatcher: Unregisters all listeners
removeAllowedType(String) - Method in interface com.jivesoftware.forum.AttachmentManager: Removes a content type fromt he list of explicitly allowed types.
removeAllTags(JiveContentObject) - Method in interface com.jivesoftware.forum.TagManager: Disassociates this object with all tags.
removeAllUserPermissions(PermissionType) - Method in interface com.jivesoftware.base.PermissionsManager: Removes all user permissions.
removeAnonymousUserPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Removes a permission of the specified PermissionType for anonymous users.
removeAnonymousVote(int, String) - Method in interface com.jivesoftware.base.Poll: Remove a guest vote.
removeDisallowedType(String) - Method in interface com.jivesoftware.forum.AttachmentManager: Removes a content type from the list of explicitly disallowed types.
removeFilterRenderTypes(String, List) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Removes a set of render types from the given filter.
removeFromIndex(ForumMessage) - Method in interface com.jivesoftware.forum.SearchManager: Removes an individual message from the index.
removeFromIndex(ForumThread) - Method in interface com.jivesoftware.forum.SearchManager: Removes a thread from the index.
removeFromIndex(Forum) - Method in interface com.jivesoftware.forum.SearchManager: Removes a forum from the index.
removeFromIndex(User) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Removes an individual user from the index.
removeGroupPermission(Group, PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Removes a permission of the specified PermissionType for a group.
removeInterceptor(int) - Method in interface com.jivesoftware.forum.InterceptorManager: Removes the specified interceptor from the list of interceptors.
removeListener(GroupListener) - Method in class com.jivesoftware.base.event.GroupEventDispatcher
removeListener(JivePropertyListener) - Method in class com.jivesoftware.base.event.JivePropertyEventDispatcher: Unregisters a listener from this event dispatcher.
removeListener(LogListener) - Method in class com.jivesoftware.base.event.LogEventDispatcher
removeListener(PollListener) - Method in class com.jivesoftware.base.event.PollEventDispatcher: Removes an event listener from the dispatcher.
removeListener(UserListener) - Method in class com.jivesoftware.base.event.UserEventDispatcher
removeListener(GroupListener) - Static method in class com.jivesoftware.base.GroupManagerFactory: Method used internally by Jive.
removeListener(UserListener) - Static method in class com.jivesoftware.base.UserManagerFactory: Method used internally by Jive.
removeListener(AnnouncementListener) - Method in class com.jivesoftware.forum.event.AnnouncementEventDispatcher
removeListener(CategoryListener) - Method in class com.jivesoftware.forum.event.CategoryEventDispatcher
removeListener(ForumListener) - Method in class com.jivesoftware.forum.event.ForumEventDispatcher
removeListener(MessageListener) - Method in class com.jivesoftware.forum.event.MessageEventDispatcher
removeListener(PrivateMessageListener) - Method in class com.jivesoftware.forum.event.PrivateMessageEventDispatcher
removeListener(QuestionListener) - Method in class com.jivesoftware.forum.event.QuestionEventDispatcher
removeListener(SearchIndexListener) - Method in class com.jivesoftware.forum.event.SearchIndexEventDispatcher
removeListener(ThreadListener) - Method in class com.jivesoftware.forum.event.ThreadEventDispatcher
removeListener(ProfileSearchIndexListener) - Method in class com.jivesoftware.profiles.search.ProfileSearchIndexEventDispatcher
removeMember(User) - Method in interface com.jivesoftware.base.Group: Removes a member from the group.
removeRating(Rating) - Method in interface com.jivesoftware.forum.RatingManager: Remove the specified rating from the list of currently available ratings.
removeRegisteredUserPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Removes a permission of the specified PermissionType for registered users.
removeRenderFilter(String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Removes the specified filter from the list of currently configured filters.
removeResolutionState(Question.State) - Method in class com.jivesoftware.forum.QuestionFilter: Removes a resolution state from the set of states that will be included in filtered results.
removeResolutionState(Question.State) - Method in class com.jivesoftware.forum.ResultFilter: Removes a resolution state from the set of states that will be included in filtered results.
removeTag(ContentTag, JiveContentObject) - Method in interface com.jivesoftware.forum.TagManager: Disassociates this object with the given tag.
removeTextExtractor(String) - Method in interface com.jivesoftware.forum.SearchManager: Removes an existing text extractor from the list of current text extractors.
removeUser(User) - Method in interface com.jivesoftware.base.Roster: Remove a user from the roster.
removeUserPermission(User, PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Removes a permission of the specified PermissionType for the specified user.
removeUserVote(int, User) - Method in interface com.jivesoftware.base.Poll: Remove a user vote.
render(String, RenderContext) - Method in interface com.jivesoftware.forum.renderer.Renderer: Render the input string according to the RenderStrategy and RenderTarget specified by the given render context.
render(Object, RenderType, String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Applies filters to the specified string.
render(Object, RenderType, RenderStrategy, String) - Method in interface com.jivesoftware.forum.renderer.RenderManager: Applies filters to the specified string.
RENDER_ALL - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to enable the rendering of all links, tables, images, lists, macros and text decorations.
RENDER_IMAGES - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render images.
RENDER_LINKS - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render links.
RENDER_LISTS - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render lists.
RENDER_MACROS - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render macros.
RENDER_TABLES - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render tables.
RENDER_TARGETS - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: An array containing all possible types of targets
RENDER_TEXT_DECORATION - Static variable in class com.jivesoftware.forum.renderer.RenderStrategy: Use this render flag to render text decorations.
RenderedTextStore - Class in com.jivesoftware.forum.renderer: A store for text snippets.
RenderedTextStore() - Constructor for class com.jivesoftware.forum.renderer.RenderedTextStore
Renderer - Interface in com.jivesoftware.forum.renderer: A Renderer is an object that allows for converting text markup to html and back again.
RendererFactory - Class in com.jivesoftware.forum.renderer: A factory for creating Renderer's.
RenderFilter - Interface in com.jivesoftware.forum.renderer: A filter is an object that performs filtering on Strings.
renderImages() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
renderLinks() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
renderLists() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
RenderMacro - Interface in com.jivesoftware.forum.renderer: The RenderMacro interface is an extension to the RenderFilter interface, the main difference being that it will not execute over the whole page, rather it will be provided with just the text between the macro tags, if it exists.
renderMacros() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
RenderManager - Interface in com.jivesoftware.forum.renderer: A manager to manage filters to be used for render operations.
RenderPipe - Class in com.jivesoftware.forum.renderer: A container to hold the filters that are to be used for rendering text.
RenderPipe(RenderFilter[]) - Constructor for class com.jivesoftware.forum.renderer.RenderPipe
RenderStrategy - Class in com.jivesoftware.forum.renderer: A RenderStrategy allows for the coarse grained ability to determine what will be rendered by a particular render call irregardless of what filters are included.
RenderStrategy() - Constructor for class com.jivesoftware.forum.renderer.RenderStrategy
RenderStrategy(RenderTarget, long) - Constructor for class com.jivesoftware.forum.renderer.RenderStrategy
renderTables() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
RenderTarget - Class in com.jivesoftware.forum.renderer: The target of a particular render operation.
renderTextDecoration() - Method in class com.jivesoftware.forum.renderer.RenderStrategy
RenderType - Class in com.jivesoftware.forum.renderer: Defines render types used for jive objects.
replaceTokens(String) - Method in class com.jivesoftware.forum.renderer.RenderedTextStore: This method will replace all tokens in the provided string with their original text snippets.
resolution_date - Static variable in class com.jivesoftware.forum.QuestionFilter.SortField
resolution_state - Static variable in class com.jivesoftware.forum.QuestionFilter.SortField
resolved - Static variable in class com.jivesoftware.forum.Question.State: The question is answered.
ResultFilter - Class in com.jivesoftware.forum: Filters and sorts lists of threads and messages.
ResultFilter() - Constructor for class com.jivesoftware.forum.ResultFilter
reverseActiveAvatarCache - Static variable in class com.jivesoftware.forum.AvatarManagerFactory
RewardException - Exception in com.jivesoftware.forum: Thrown when an error occurs during a failed operation in the RewardManager.
RewardException() - Constructor for exception com.jivesoftware.forum.RewardException
RewardException(String) - Constructor for exception com.jivesoftware.forum.RewardException
RewardException(Throwable) - Constructor for exception com.jivesoftware.forum.RewardException
RewardException(String, Throwable) - Constructor for exception com.jivesoftware.forum.RewardException
RewardManager - Interface in com.jivesoftware.forum: Manages the reward points that users can trade back and forth when answerings questions.
rewardPoints(ForumMessage, int) - Method in interface com.jivesoftware.forum.RewardManager: Rewards a message with points from the thread that the message belongs to.
ROSTER - Static variable in class com.jivesoftware.base.JiveConstants
Roster - Interface in com.jivesoftware.base: A roster is a list of users that the user wishes to know if they are online.
rotateDebugLogFile() - Static method in class com.jivesoftware.base.Log
rotateErrorLogFile() - Static method in class com.jivesoftware.base.Log
rotateInfoLogFile() - Static method in class com.jivesoftware.base.Log
rotateWarnLogFile() - Static method in class com.jivesoftware.base.Log
roundDate(Date, int) - Static method in class com.jivesoftware.forum.ResultFilter
roundDate(long, int) - Static method in class com.jivesoftware.forum.ResultFilter
runArchiver() - Method in interface com.jivesoftware.forum.ArchiveManager: Manually runs the archiving process.

S

save() - Method in interface com.jivesoftware.forum.renderer.RenderManager: Saves all filters to the persistent store.
saveInterceptors() - Method in interface com.jivesoftware.forum.InterceptorManager: Saves all interceptors to the persistent store.
saveMessageAsDraft(PrivateMessage) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Saves a message as a draft by storing it in the sender's Drafts folder.
SEARCH - Static variable in class com.jivesoftware.base.JiveConstants
search(ProfileSearchQuery) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Returns the hits that correspond to the search query.
SearchIndexEvent - Class in com.jivesoftware.forum.event: A class for search index events.
SearchIndexEvent(int, Map) - Constructor for class com.jivesoftware.forum.event.SearchIndexEvent
SearchIndexEventDispatcher - Class in com.jivesoftware.forum.event: Implementation of the JiveEventDispatcher for SearchIndexEvent dispatching.
SearchIndexListener - Interface in com.jivesoftware.forum.event: A SearchIndexListener gets notified anytime an search index event is fired.
SearchManager - Interface in com.jivesoftware.forum: Manages the search feature of Jive Forums by defining properties of the search indexer.
SECOND - Static variable in class com.jivesoftware.base.JiveConstants: One second (in milliseconds).
send(EmailMessage) - Method in class com.jivesoftware.base.EmailManager: Used to send an email message.
SENDER_MAILBOX_FULL - Static variable in exception com.jivesoftware.forum.PrivateMessageRejectedException
sendMessage(PrivateMessage, User, boolean) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Sends a private message to another user.
SESSION_AUTHORIZATION - Static variable in class com.jivesoftware.base.AuthFactory: Name of the key in a user's session that AuthToken tokens are customarily stored at.
set(long, boolean) - Method in class com.jivesoftware.base.Permissions: Sets the permissions given by a bit mask to true or false.
setActiveAvatar(User, Avatar) - Method in interface com.jivesoftware.forum.AvatarManager: Used to make a user use a global avatar, to set no active avatar pass null for the avatar value.
setAfterDate(Date) - Method in interface com.jivesoftware.forum.Query: Sets the earliest date for search results.
setAllowAllByDefault(boolean) - Method in interface com.jivesoftware.forum.AttachmentManager: Sets the default allowed content types mode.
setAllowImageResize(boolean) - Method in interface com.jivesoftware.forum.AvatarManager: Used to set whether the system should attempt to resize images
setAllTagsRequired(boolean) - Method in class com.jivesoftware.forum.ResultFilter: Sets whether or not the content must be tagged with every tag contained in getTags().
setArchiveDays(Forum, int) - Method in interface com.jivesoftware.forum.ArchiveManager: Sets the number of days that threads in forum must be inactive before being archived.
setArchiveForum(Forum, Forum) - Method in interface com.jivesoftware.forum.ArchiveManager: Sets the "archive forum" for the specified forum.
setArchiveMode(Forum, int) - Method in interface com.jivesoftware.forum.ArchiveManager: Returns the archive mode for the forum.
setArchivingEnabled(Forum, boolean) - Method in interface com.jivesoftware.forum.ArchiveManager: Enables or disables archiving for the specified forum.
setAttachmentSearchEnabled(boolean) - Method in interface com.jivesoftware.forum.SearchManager: Enables or disables the attachment search feature.
setAutoArchiveEnabled(boolean) - Method in interface com.jivesoftware.forum.ArchiveManager: Enables or disables auto-archiving.
setAutoArchiveInterval(int) - Method in interface com.jivesoftware.forum.ArchiveManager: Sets the inverval between auto archive executions (in hours).
setAutoIndexEnabled(boolean) - Method in interface com.jivesoftware.forum.SearchManager: Enables or disables auto indexing.
setAutoIndexEnabled(boolean) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Enables or disables auto indexing.
setAutoIndexInterval(int) - Method in interface com.jivesoftware.forum.SearchManager: Sets the amount of time that indexer should wait between updating the index.
setAutoIndexInterval(int) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Sets the number of minutes that indexer should wait between updating the index.
setAvatarsEnabled(boolean) - Method in interface com.jivesoftware.forum.AvatarManager: Used to disable or enable the avatars feature
setAvatarsEnabled(boolean) - Static method in class com.jivesoftware.forum.AvatarManagerFactory
setBankEnabled(boolean) - Method in interface com.jivesoftware.forum.RewardManager: Toggles bank points to enabled or disabled.
setBeforeDate(Date) - Method in interface com.jivesoftware.forum.Query: Sets the latest date for search results.
setBody(String) - Method in interface com.jivesoftware.forum.Announcement: Sets the body of this announcement.
setBody(String) - Method in interface com.jivesoftware.forum.ForumMessage: Sets the body of this message.
setBody(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Sets the body of the message.
setCategoryIndex(ForumCategory, int) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the display order of a sub-category.
setCorrectAnswer(ForumMessage) - Method in interface com.jivesoftware.forum.Question: Sets the specified message as the correct answer.
setCreationDate(Date) - Method in interface com.jivesoftware.base.Group: Sets the creation date of the group.
setCreationDate(Date) - Method in interface com.jivesoftware.base.User: Sets the creation date of the user.
setCreationDate(Date) - Method in interface com.jivesoftware.forum.ContentTag: Sets the creation date of this tag.
setCreationDate(Date) - Method in interface com.jivesoftware.forum.Forum: Sets the creation date of the forum.
setCreationDate(Date) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the creation date of the category.
setCreationDate(Date) - Method in interface com.jivesoftware.forum.ForumMessage: Sets the creation date of this message.
setCreationDate(Date) - Method in interface com.jivesoftware.forum.ForumThread: Sets the creation date of this thread.
setCreationDateRangeMax(Date) - Method in class com.jivesoftware.forum.QuestionFilter: Sets a date that represents the upper boundry for messages or threads to be selected by the result filter.
setCreationDateRangeMax(Date) - Method in class com.jivesoftware.forum.ResultFilter: Sets a date that represents the upper boundry for messages or threads to be selected by the result filter.
setCreationDateRangeMin(Date) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the date that represents the lower boundary for messages or threads to be selected by the result filter.
setCreationDateRangeMin(Date) - Method in class com.jivesoftware.forum.ResultFilter: Sets the date that represents the lower boundary for messages or threads to be selected by the result filter.
setDatabaseModeEnabled(boolean) - Method in interface com.jivesoftware.forum.AttachmentManager: Enables or disables storage of binary attachment data in the database.
setDebugEnabled(boolean) - Static method in class com.jivesoftware.base.Log
setDeleteDays(int) - Method in interface com.jivesoftware.forum.WatchManager: Sets the number of days that a watched object can remain inactive before watches on that object are deleted.
setDescription(String) - Method in interface com.jivesoftware.base.Group: Sets the description of the group.
setDescription(String) - Method in interface com.jivesoftware.base.Poll: Sets the description of the poll.
setDescription(String) - Method in interface com.jivesoftware.forum.Forum: Sets the description of the forum.
setDescription(String) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the description of the forum category.
setDescription(String) - Method in interface com.jivesoftware.forum.StatusLevel: Sets the description of this status level
setEmail(String) - Method in interface com.jivesoftware.base.User: Sets the user's email address.
setEmailVisible(boolean) - Method in interface com.jivesoftware.base.User: Sets whether a user's email is visible to other users.
setEmailVisible(boolean) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Determines whether or not user email addresses are visible when performing a user search.
setEnabled(boolean) - Method in interface com.jivesoftware.forum.renderer.RenderFilter: Sets whether the filter is enabled or disabled.
setEndDate(Date) - Method in interface com.jivesoftware.base.Poll: Sets the date the poll should end.
setEndDate(Date) - Method in interface com.jivesoftware.forum.Announcement: Sets the date when the announcement should not longer be visible.
setExpirable(boolean) - Method in interface com.jivesoftware.forum.Watch: Sets whether this watch is expirable or not.
setExpirationDate(Date) - Method in interface com.jivesoftware.base.Poll: Sets the date the poll should expire.
setFailureException(Exception) - Method in class com.jivesoftware.base.event.GroupEvent: Sets the exception that indicates why a listener failed to handle an event.
setFailureException(Exception) - Method in class com.jivesoftware.base.event.UserEvent: Sets the exception that indicates why a listener failed to handle an event.
setFailureException(Exception) - Method in class com.jivesoftware.profiles.ProfileEvent: Sets the exception that indicates why a listener failed to handle an event.
setFilterHTMLEnabled(boolean) - Method in interface com.jivesoftware.forum.SearchManager: Set whether or not to index and display HTML within messages.
setForumCategoryID(long) - Method in exception com.jivesoftware.forum.ForumCategoryNotFoundException: Sets the id of the forum category that was not found
setForumID(long) - Method in exception com.jivesoftware.forum.ForumNotFoundException
setForumIndex(Forum, int) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the index of the forum in the category.
setGroup(Group) - Method in interface com.jivesoftware.forum.StatusLevel: The group this status level is associated with.
setGroupByForum(boolean) - Method in class com.jivesoftware.forum.QuestionFilter: Sets whether to group results by forum.
setHelpfulAnswersPerThread(int) - Method in interface com.jivesoftware.forum.QuestionManager: Sets the number of helpful answers allowed per question.
setHtmlBody(String) - Method in class com.jivesoftware.base.EmailMessage: Sets the text version of the body.
setHtmlBodyProperty(String) - Method in class com.jivesoftware.base.EmailMessage
setImagePath(String) - Method in interface com.jivesoftware.forum.StatusLevel: Sets the path of the image used for this status level.
setImagePreviewEnabled(boolean) - Method in interface com.jivesoftware.forum.AttachmentManager: Toggles whether image preview support is enabled.
setImagePreviewMaxSize(int) - Method in interface com.jivesoftware.forum.AttachmentManager: Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
setImagePreviewRatioEnabled(boolean) - Method in interface com.jivesoftware.forum.AttachmentManager: Toggles whether the aspect ratio of thumbnails should be preserved.
setIndex(long) - Method in class com.jivesoftware.forum.ForumMessageIterator: Sets the index for the iteration to the specified message ID.
setIndex(ForumThread) - Method in class com.jivesoftware.forum.ForumThreadIterator: Sets the index for the iteration to the specified ForumThread.
setInitialBankPoints(int) - Method in interface com.jivesoftware.forum.RewardManager: Sets the number of bank points a user will start with.
setLargeImagePath(String) - Method in interface com.jivesoftware.forum.StatusLevel
setLastUpdateTime(Date) - Method in interface com.jivesoftware.base.Presence: Set the time when the presence was last updated (when the user last visited).
setLastUpdateTime(long) - Method in interface com.jivesoftware.base.Presence: Sets the time when the presence was last updated (when the user last visited).
setLocale(Locale) - Method in class com.jivesoftware.base.EmailMessage: Set the locale for the email message.
setLocale(Locale) - Method in interface com.jivesoftware.forum.Forum: Sets the locale for this forum.
setLocale(Locale) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the locale for this category.
setMaxAllowableHeight(int) - Method in interface com.jivesoftware.forum.AvatarManager: Sets the maximum allowable height for an avatar image
setMaxAllowableWidth(int) - Method in interface com.jivesoftware.forum.AvatarManager: Sets the maximum allowable width for an avatar image
setMaxAttachmentSize(int) - Method in interface com.jivesoftware.forum.AttachmentManager: Sets the maximum size of an individual attachment in kilobytes.
setMaxAttachmentsPerMessage(int) - Method in interface com.jivesoftware.forum.AttachmentManager: Sets the maximum number of attachments per message.
setMaxBankPoints(int) - Method in interface com.jivesoftware.forum.RewardManager: Sets the max number of points that can accumulate in a bank account.
setMaxFilesystemCacheSize(long) - Method in interface com.jivesoftware.forum.AttachmentManager: Sets the maximum amount of storage (in bytes) that will be used by the file system cache when database attachment mode is enabled.
setMaxMessagePoints(int) - Method in interface com.jivesoftware.forum.RewardManager: Sets the maximum number of reward points that can be assigned to a message.
setMaxMessagesPerUser(int) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Sets the max number of message is allowed to store in their mailbox.
setMaxThreadPoints(int) - Method in interface com.jivesoftware.forum.RewardManager: Sets the maximum number of reward points that can be assigned to a thread.
setMaxUserAvatars(int) - Method in interface com.jivesoftware.forum.AvatarManager: Sets the maximum number of avatars a user can have
setMessage(ForumMessage) - Method in class com.jivesoftware.forum.QueryResult: Set the entry this query result pertains to.
setMinimum(int) - Method in class com.jivesoftware.forum.TagResultFilter: Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
setMode(long, boolean) - Method in interface com.jivesoftware.base.Poll: Sets a mode to be enabled or disabled for the poll.
setModerateUserAvatars(boolean) - Method in interface com.jivesoftware.forum.AvatarManager: Sets whether or not user avatars will be moderated.
setModerationDefaultMessageValue(int) - Method in interface com.jivesoftware.forum.Forum: Sets the default number of moderation points for threads created in the forum.
setModerationDefaultThreadValue(int) - Method in interface com.jivesoftware.forum.Forum: Sets the default number of moderation points for threads created in the forum.
setModerationRangeMax(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the upper bound for the moderation value that will pass the result filter.
setModerationRangeMin(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter.
setModerationValue(int, AuthToken) - Method in interface com.jivesoftware.forum.ForumMessage: Sets the number of moderation points this message has.
setModerationValue(int, AuthToken) - Method in interface com.jivesoftware.forum.ForumThread: Sets the number of moderation points this thread has.
setModificationDate(Date) - Method in interface com.jivesoftware.base.Group: Sets the date the group was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.base.User: Sets the date the user was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.forum.Forum: Sets the date the forum was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the date the category was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.forum.ForumMessage: Sets the date this message was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.forum.ForumThread: Sets the date this thread was last modified.
setModificationDateRangeMax(Date) - Method in class com.jivesoftware.forum.ResultFilter: Sets a date that represents the upper boundry for messages or threads to be selected by the result filter.
setModificationDateRangeMin(Date) - Method in class com.jivesoftware.forum.ResultFilter: Sets a date that represents the lower boundary for messages or threads to be selected by the result filter.
setModValue(int) - Method in interface com.jivesoftware.forum.Avatar: Modifies the moderation value of this specific avatar
setName(String) - Method in interface com.jivesoftware.base.Group: Sets the name of the group.
setName(String) - Method in interface com.jivesoftware.base.Poll: Sets the name of the poll.
setName(String) - Method in interface com.jivesoftware.base.User: Sets the user's name.
setName(String) - Method in interface com.jivesoftware.forum.Attachment: Sets the name of the attachment.
setName(String) - Method in interface com.jivesoftware.forum.Forum: Sets the name of a the forum.
setName(String) - Method in interface com.jivesoftware.forum.ForumCategory: Sets the name of the forum category.
setName(String) - Method in interface com.jivesoftware.forum.PrivateMessageFolder: Sets the name of the folder.
setName(String) - Method in interface com.jivesoftware.forum.StatusLevel: Sets the name of this status level
setNameVisible(boolean) - Method in interface com.jivesoftware.base.User: Sets whether a user's name is visible to other users.
setNNTPName(String) - Method in interface com.jivesoftware.forum.Forum: Sets the NNTP name for the forum, which is the name of the forum used in the NNTP protocol (newsgroups).
setNumResults(int) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the limit on the number of results to be returned.
setNumResults(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the limit on the number of results to be returned.
setOffline(Presence) - Method in interface com.jivesoftware.base.PresenceManager: Sets a presence to be offline which causes the presence to be removed from the system.
setOption(int, String) - Method in interface com.jivesoftware.base.Poll: Sets the text of the option at the specified index.
setOptionIndex(int, int) - Method in interface com.jivesoftware.base.Poll: Moves the option's index.
setParameters(Map) - Method in interface com.jivesoftware.forum.renderer.RenderMacro: Sets a map of user provided parameters for the macro to use.
setPassword(String) - Method in interface com.jivesoftware.base.User: Sets the users's password.
setPasswordHash(String) - Method in interface com.jivesoftware.base.User: Sets the user's password in hashed form.
setPointRange(int, int) - Method in interface com.jivesoftware.forum.StatusLevel: Sets a point range for this status level, if this status level was group based before it will now be point based.
setPresencesEnabled(boolean) - Method in interface com.jivesoftware.base.PresenceManager: Sets whether presences are enabled on a global basis or not.
setPrivateMessagesEnabled(boolean) - Method in interface com.jivesoftware.forum.PrivateMessageManager: Enables or disables the private message feature.
setProperty(String, String) - Method in interface com.jivesoftware.base.Group: Sets an extended property of the group.
setProperty(String, String) - Method in interface com.jivesoftware.base.User: Sets an extended property of the user.
setProperty(String, String) - Method in interface com.jivesoftware.forum.Announcement: Sets an extended property of this annoucement.
setProperty(String, String) - Method in interface com.jivesoftware.forum.Attachment: Sets an extended property of the attachment.
setProperty(String, String) - Method in interface com.jivesoftware.forum.Avatar: Sets an extended property of the attachment.
setProperty(String, String) - Method in interface com.jivesoftware.forum.Forum: Sets an extended property of the forum.
setProperty(String, String) - Method in interface com.jivesoftware.forum.ForumCategory: Sets an extended property of the category.
setProperty(String, String) - Method in interface com.jivesoftware.forum.ForumMessage: Sets an extended property of this message.
setProperty(String, String) - Method in interface com.jivesoftware.forum.ForumThread: Sets an extended property of this thread.
setProperty(String, String) - Method in interface com.jivesoftware.forum.PrivateMessage: Sets an extended property of this private message.
setProperty(String, String) - Method in interface com.jivesoftware.forum.Question: Sets an extended property of object.
setProperty(String, String) - Method in interface com.jivesoftware.forum.StatusLevel: Sets an extended property of the status level.
setPropertyMode(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the mode that will be used to select results if multiple properties have been specified.
setQueryString(String) - Method in interface com.jivesoftware.forum.Query: Sets the query string for the Query object.
setRatingsEnabled(boolean) - Method in interface com.jivesoftware.forum.RatingManager: Enables or disables the ratings feature.
setRead(boolean) - Method in interface com.jivesoftware.forum.PrivateMessage: Marks this message as read or unread.
setReadTrackingEnabled(boolean) - Method in interface com.jivesoftware.forum.ReadTracker: Enables or disables the read tracking feature.
setRecursive(boolean) - Method in class com.jivesoftware.forum.ResultFilter: Sets the recursive value of queries.
setRelevance(float) - Method in class com.jivesoftware.forum.QueryResult: Get the relevance of this query result as determined by the search engine.
setResolutionDateRangeMax(Date) - Method in class com.jivesoftware.forum.QuestionFilter: Sets a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
setResolutionDateRangeMax(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
setResolutionDateRangeMin(Date) - Method in class com.jivesoftware.forum.QuestionFilter: Sets a date that represents the lower boundary for messages or threads to be selected by the result filter.
setResolutionDateRangeMin(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets a date that represents the lower boundary for messages or threads to be selected by the result filter.
setRewardsEnabled(boolean) - Method in interface com.jivesoftware.forum.RewardManager: Enables or disables the rewards feature.
setSearchEnabled(boolean) - Method in interface com.jivesoftware.forum.SearchManager: Enables or disables the search feature.
setSearchEnabled(boolean) - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Enables or disables the profile search feature.
setSender(String, String) - Method in class com.jivesoftware.base.EmailMessage: Sets the address the email is sent from.
setSender(EmailMessage.EmailAddress) - Method in class com.jivesoftware.base.EmailMessage: Sets the address the email is sent from.
setSortField(int) - Method in interface com.jivesoftware.forum.Query: Sets the sort field to use.
setSortField(QuestionFilter.SortField) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the sort field to use.
setSortField(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the sort field to use.
setSortOrder(int) - Method in interface com.jivesoftware.forum.Query: Sets the sort type.
setSortOrder(int) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the sort type.
setSortOrder(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the sort type.
setSortPropertyName(String) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the property name to sort on.
setSortPropertyName(String) - Method in class com.jivesoftware.forum.ResultFilter: Sets the property name to sort on.
setStartDate(Date) - Method in interface com.jivesoftware.base.Poll: Sets the date voting for the poll should start.
setStartDate(Date) - Method in interface com.jivesoftware.forum.Announcement: Sets the start date for when the announcement should first be visible.
setStartIndex(int) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the index of the first result to return.
setStartIndex(int) - Method in class com.jivesoftware.forum.ResultFilter: Sets the index of the first result to return.
setState(Question.State) - Method in interface com.jivesoftware.forum.Question: Sets the resolution state of this question.
setStatus(int) - Method in interface com.jivesoftware.base.Presence: Sets the status of the user.
setStatusLevelsEnabled(boolean) - Method in interface com.jivesoftware.forum.StatusLevelManager: Sets whether status levels should be enabled in the system.
setStatusLevelsEnabled(boolean) - Static method in class com.jivesoftware.forum.StatusLevelManagerFactory
setSubject(String) - Method in class com.jivesoftware.base.EmailMessage: Sets the subject of the email.
setSubject(String) - Method in interface com.jivesoftware.forum.Announcement: Sets the announcement subject.
setSubject(String) - Method in interface com.jivesoftware.forum.ForumMessage: Sets the subject of this message.
setSubject(String) - Method in interface com.jivesoftware.forum.PrivateMessage: Sets the subject of the message.
setSubjectProperty(String) - Method in class com.jivesoftware.base.EmailMessage: Sets the email's subject property name
setTags(Collection) - Method in class com.jivesoftware.forum.ResultFilter: Sets the ContentTags to filter on.
setTarget(RenderTarget) - Method in class com.jivesoftware.forum.renderer.RenderStrategy
setTextBody(String) - Method in class com.jivesoftware.base.EmailMessage: Sets the text version of the body.
setTextBodyProperty(String) - Method in class com.jivesoftware.base.EmailMessage: Set the property name for the html version of the email body
setUserAvatarsEnabled(boolean) - Method in interface com.jivesoftware.forum.AvatarManager: Sets whether or not users can create their own custom avatars.
setUserID(long) - Method in exception com.jivesoftware.base.UserNotFoundException
setUserID(long) - Method in class com.jivesoftware.forum.QuestionFilter: Sets the creator of questions that results will be filtered on.
setUserID(long) - Method in class com.jivesoftware.forum.ResultFilter: Sets the userID that results will be filtered on.
setUsername(String) - Method in exception com.jivesoftware.base.UserNotFoundException
setWatchType(int) - Method in interface com.jivesoftware.forum.Watch: Sets the watch type.
setWildcardIgnored(boolean) - Method in interface com.jivesoftware.forum.SearchManager: Turns on or off wildcarding.
SKILL - Static variable in class com.jivesoftware.base.JiveConstants
SKILL_VALUE - Static variable in class com.jivesoftware.base.JiveConstants
SKILLS_MODIFIED - Static variable in class com.jivesoftware.profiles.ProfileEvent: Event type for whenever user skills are modified.
SORT_DATE - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
SORT_ONLINE_TIME - Static variable in interface com.jivesoftware.base.PresenceManager: Sort by online time.
SORT_SENDER - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
SORT_SUBJECT - Static variable in interface com.jivesoftware.forum.PrivateMessageFolder
SORT_TAGCOUNT - Static variable in interface com.jivesoftware.forum.ContentTag: Sort field: sort by tag count.
SORT_TAGNAME - Static variable in interface com.jivesoftware.forum.ContentTag: Sort field: sort by tag name.
SORT_USERNAME - Static variable in interface com.jivesoftware.base.PresenceManager: Sort by username.
STATUS_AWAY - Static variable in interface com.jivesoftware.base.Presence
STATUS_IDLE - Static variable in interface com.jivesoftware.base.Presence
STATUS_INVISIBLE - Static variable in interface com.jivesoftware.base.Presence
STATUS_LEVEL - Static variable in class com.jivesoftware.base.JiveConstants
STATUS_LEVEL_BLOCK_GROUP_LEADERS - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
STATUS_LEVEL_CALCULATOR_PROPERTY - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
STATUS_LEVEL_ENABLE_PROPERTY - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
STATUS_LEVEL_MANAGER_PROPERTY - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
STATUS_LEVEL_PRELOAD - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
STATUS_ONLINE - Static variable in interface com.jivesoftware.base.Presence
StatusLevel - Interface in com.jivesoftware.forum: Represents a status Level in the system.
StatusLevelAlreadyExistsException - Exception in com.jivesoftware.forum: Thrown when attempting to create a status level that already exists in the system
StatusLevelAlreadyExistsException() - Constructor for exception com.jivesoftware.forum.StatusLevelAlreadyExistsException
StatusLevelAlreadyExistsException(String) - Constructor for exception com.jivesoftware.forum.StatusLevelAlreadyExistsException
statusLevelCache - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
StatusLevelCalculator - Interface in com.jivesoftware.forum: Defines methods need to calculate status levels and leaders.
StatusLevelException - Exception in com.jivesoftware.forum: The StatusLevelException is thrown by the StatusLevel class.
StatusLevelException(String) - Constructor for exception com.jivesoftware.forum.StatusLevelException
StatusLevelException() - Constructor for exception com.jivesoftware.forum.StatusLevelException
statusLevelIDCache - Static variable in class com.jivesoftware.forum.StatusLevelManagerFactory
StatusLevelManager - Interface in com.jivesoftware.forum: Manages status level feature.
StatusLevelManagerFactory - Class in com.jivesoftware.forum: A factory that returns a concrete instance of StatusLevelManager
StatusLevelManagerFactory.StatusCalculatorPropertyListener - Class in com.jivesoftware.forum: Checks to see if the calculator implementation has changes and reinitializes it if it has been
StatusLevelManagerFactory.StatusCalculatorPropertyListener() - Constructor for class com.jivesoftware.forum.StatusLevelManagerFactory.StatusCalculatorPropertyListener
StatusLevelNotFoundException - Exception in com.jivesoftware.forum: Thrown by StatusLevelManager when attempting to acquire or perform an operation on a status level that does not exist.
StatusLevelNotFoundException() - Constructor for exception com.jivesoftware.forum.StatusLevelNotFoundException
StatusLevelNotFoundException(String) - Constructor for exception com.jivesoftware.forum.StatusLevelNotFoundException
SUBJECT - Static variable in interface com.jivesoftware.forum.Query: Sort by message subject
SUBJECT - Static variable in class com.jivesoftware.forum.renderer.RenderType: Type representing a message subject.
SYSTEM - Static variable in class com.jivesoftware.base.JiveConstants
SYSTEM_ADMIN - Static variable in class com.jivesoftware.base.Permissions: Permission to administer the entire sytem.
SYSTEM_QUESTION - Static variable in class com.jivesoftware.base.JiveConstants

T

TAG - Static variable in class com.jivesoftware.base.JiveConstants
TAG - Static variable in class com.jivesoftware.forum.renderer.RenderType: Type representing a message tags.
TAG_SET - Static variable in class com.jivesoftware.base.JiveConstants
TagManager - Interface in com.jivesoftware.forum
TagResultFilter - Class in com.jivesoftware.forum
TagResultFilter() - Constructor for class com.jivesoftware.forum.TagResultFilter
TARGET_HTML - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: This target's output will have all wiki markup converted into html for display.
TARGET_NO_MARKUP - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: Use this render target for when no rendering is to be performed.
TARGET_PLAIN_EMAIL - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: This target's rendered output will be suitable for sending in plain text emails.
TARGET_PLAIN_TEXT - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: This target's output will contain wiki markup suitable for the plain text editor.
TARGET_WYSIWYG_EDITOR - Static variable in class com.jivesoftware.forum.renderer.RenderTarget: This target's output will be appropriate for display in the wysiwyg editor.
THREAD - Static variable in class com.jivesoftware.base.JiveConstants
THREAD_ADDED - Static variable in class com.jivesoftware.forum.event.ThreadEvent: Thread was added to the system.
THREAD_DELETING - Static variable in class com.jivesoftware.forum.event.ThreadEvent: Thread is about to be deleted.
THREAD_MODERATION_MODIFIED - Static variable in class com.jivesoftware.forum.event.ThreadEvent: The moderation value of the thread was changed.
THREAD_MOVED - Static variable in class com.jivesoftware.forum.event.ThreadEvent: Thread was moved to another forum.
THREAD_NAME - Static variable in class com.jivesoftware.base.JiveConstants
THREAD_RATED - Static variable in class com.jivesoftware.forum.event.ThreadEvent: The thread was rated.
threadAdded(ThreadEvent) - Method in interface com.jivesoftware.forum.event.ThreadListener: Fired when a thread has been added to the system.
threadDeleted(ThreadEvent) - Method in interface com.jivesoftware.forum.event.ThreadListener: Fired when a thread is about to be deleted from the system.
ThreadEvent - Class in com.jivesoftware.forum.event: An event for ForumThread objects.
ThreadEvent(int, ForumThread, Map) - Constructor for class com.jivesoftware.forum.event.ThreadEvent: Creates a new thread event.
ThreadEventDispatcher - Class in com.jivesoftware.forum.event: Dispatcher for thread events.
ThreadListener - Interface in com.jivesoftware.forum.event: Listener for thread events.
threadModerationModified(ThreadEvent) - Method in interface com.jivesoftware.forum.event.ThreadListener: Fired when the moderation value of a thread has been changed.
threadMoved(ThreadEvent) - Method in interface com.jivesoftware.forum.event.ThreadListener: Fired when a thread is moved from one foru to another.
threadRated(ThreadEvent) - Method in interface com.jivesoftware.forum.event.ThreadListener: Fired when the thread has been rated.
TOO_LARGE - Static variable in exception com.jivesoftware.forum.AttachmentException
TOO_MANY_ATTACHMENTS - Static variable in exception com.jivesoftware.forum.AttachmentException
toString() - Method in class com.jivesoftware.base.EmailMessage.EmailAddress
toString() - Method in class com.jivesoftware.base.EmailMessage
toString() - Method in class com.jivesoftware.base.Permissions
toString() - Method in class com.jivesoftware.base.PermissionType
toString() - Method in class com.jivesoftware.forum.Question.State
toString() - Method in class com.jivesoftware.forum.QuestionFilter.SortField
toString() - Method in class com.jivesoftware.forum.renderer.RenderTarget
transferPoints(ForumThread, int) - Method in interface com.jivesoftware.forum.RewardManager: Transfers the specified number of points to the thread.
TreeWalker - Interface in com.jivesoftware.forum: Allows hierarchical navigation of a Thread.
TYPE_ALL - Static variable in interface com.jivesoftware.forum.MessageInterceptor: Interceptor that is run before and after a message has been accepted into the system and also during message edits.
TYPE_BOTH - Static variable in interface com.jivesoftware.forum.MessageInterceptor: Interceptor that is run before and after the message has been accepted into the system.
TYPE_EDIT - Static variable in interface com.jivesoftware.forum.MessageInterceptor: Interceptor that is run when messages are edited by calling setSubject(String) or setBody(String).
TYPE_POST - Static variable in interface com.jivesoftware.forum.MessageInterceptor: Interceptor that is run after the message has been accepted into the system.
TYPE_PRE - Static variable in interface com.jivesoftware.forum.MessageInterceptor: Interceptor that is run before the message has been accepted into the system.

U

UnauthorizedException - Exception in com.jivesoftware.base: Thrown if a User does not have permission to access a particular method.
UnauthorizedException() - Constructor for exception com.jivesoftware.base.UnauthorizedException
UnauthorizedException(String) - Constructor for exception com.jivesoftware.base.UnauthorizedException
UnauthorizedException(Throwable) - Constructor for exception com.jivesoftware.base.UnauthorizedException
UnauthorizedException(String, Throwable) - Constructor for exception com.jivesoftware.base.UnauthorizedException
UNREAD - Static variable in interface com.jivesoftware.forum.ReadTracker: Status to indicate that the object has never been read.
UPDATE_COMPLETED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index update is completed.
UPDATE_COMPLETED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index update is completed.
UPDATE_STARTED - Static variable in class com.jivesoftware.forum.event.SearchIndexEvent: Event type for whenever an index update is started.
UPDATE_STARTED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an index update is started.
updateCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index update is completed.
updateCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index update is completed.
UPDATED - Static variable in interface com.jivesoftware.forum.ReadTracker: Status to indicate the object has been updated since the last time a read was done.
updateIndex() - Method in interface com.jivesoftware.forum.SearchManager: Manually update the index to include all new messages since the last update.
updateIndex() - Method in interface com.jivesoftware.profiles.search.ProfileSearchManager: Manually update the index to include all new objects since the last update.
updateStarted(SearchIndexEvent) - Method in interface com.jivesoftware.forum.event.SearchIndexListener: Fired when an index update is started.
updateStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when an index update is started.
USER - Static variable in class com.jivesoftware.base.JiveConstants
User - Interface in com.jivesoftware.base: The User interface provides information about and services for users of the system.
USER_ADDED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an user is added to the search index.
USER_ADMIN - Static variable in class com.jivesoftware.base.Permissions: Permission to administer a particular user.
USER_CREATED - Static variable in class com.jivesoftware.base.event.UserEvent: Event type for whenever a user is created.
USER_DELETED - Static variable in class com.jivesoftware.base.event.UserEvent: Event type for whenever a user is deleted.
USER_DELETED - Static variable in class com.jivesoftware.profiles.search.ProfileSearchIndexEvent: Event type for whenever an user is removed from the search index.
USER_LOCALE_PROP_NAME - Static variable in class com.jivesoftware.base.JiveConstants: The name of the extended user property used to store the user's locale code.
USER_MODIFIED - Static variable in class com.jivesoftware.base.event.UserEvent: Event type for whenever a user is modified.
USER_TIMEZONE_PROP_NAME - Static variable in class com.jivesoftware.base.JiveConstants: The name of the extended user property used to store the user's time zone code.
userAdded(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when a user is added to the index.
UserAlreadyExistsException - Exception in com.jivesoftware.base: Thrown when attempting to create a user that already exists.
UserAlreadyExistsException() - Constructor for exception com.jivesoftware.base.UserAlreadyExistsException
UserAlreadyExistsException(String) - Constructor for exception com.jivesoftware.base.UserAlreadyExistsException
UserAlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.base.UserAlreadyExistsException
UserAlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.base.UserAlreadyExistsException
userCache - Static variable in class com.jivesoftware.base.UserManagerFactory: A cache for user objects.
userCreated(UserEvent) - Method in interface com.jivesoftware.base.event.UserListener: Fired when a user is created.
userDeleted(UserEvent) - Method in interface com.jivesoftware.base.event.UserListener: Fired when a user is deleted.
userDeleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.profiles.search.ProfileSearchIndexListener: Fired when a user is deleted from the search index.
UserEvent - Class in com.jivesoftware.base.event: A class for user events.
UserEvent(int, User, Map) - Constructor for class com.jivesoftware.base.event.UserEvent
UserEventDispatcher - Class in com.jivesoftware.base.event: User event dispatcher.
userIDCache - Static variable in class com.jivesoftware.base.UserManagerFactory: A cache that maps user names to ID's.
UserListener - Interface in com.jivesoftware.base.event: A UserListener gets notified anytime a user event is fired.
UserManager - Interface in com.jivesoftware.base: Centralized management of users in the Jive system including creating, retrieving, and deleting User objects.
UserManagerFactory - Class in com.jivesoftware.base: A factory that returns a concrete instance of a UserManager.
userModified(UserEvent) - Method in interface com.jivesoftware.base.event.UserListener: Fired when a user is modified.
UserNotFoundException - Exception in com.jivesoftware.base: Thrown when User cannot be found.
UserNotFoundException() - Constructor for exception com.jivesoftware.base.UserNotFoundException
UserNotFoundException(long) - Constructor for exception com.jivesoftware.base.UserNotFoundException: Allows you to create an exception specifying the id of the user that was not found
UserNotFoundException(String) - Constructor for exception com.jivesoftware.base.UserNotFoundException
UserNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.base.UserNotFoundException
UserNotFoundException(Throwable) - Constructor for exception com.jivesoftware.base.UserNotFoundException
users() - Method in interface com.jivesoftware.base.UserManager: Returns an iterator for all users in the system.
users(int, int) - Method in interface com.jivesoftware.base.UserManager: Returns an iterator for all users starting at startIndex with the given number of results.
usersWithPermission(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns all the userID's of users with a particular permission.
usersWithPermissionCount(PermissionType, long) - Method in interface com.jivesoftware.base.PermissionsManager: Returns a count of the users that have a particular permission.

V

validate(String, User) - Method in interface com.jivesoftware.profiles.validator.ProfileFieldValidator: Performs field validation on user supplied input.
value() - Method in class com.jivesoftware.base.Permissions: Returns the long value (bitmask) of the permissions that are set.
valueOf(String) - Static method in class com.jivesoftware.forum.Question.State: Returns the State associated with the specified String value.
valueOf(int) - Static method in class com.jivesoftware.forum.Question.State: Returns the State associated with the specified integer code.
VIEW_ONLINE_STATUS - Static variable in class com.jivesoftware.base.Permissions: Permission to see the online status of a particular user.
VOTE_ADDED - Static variable in class com.jivesoftware.base.event.PollEvent: A vote was added to the poll.
VOTE_IN_POLL - Static variable in class com.jivesoftware.forum.ForumPermissions: Permission to vote in polls.
VOTE_MODIFIED - Static variable in class com.jivesoftware.base.event.PollEvent: A vote was modified.
VOTE_REMOVED - Static variable in class com.jivesoftware.base.event.PollEvent: A vote was removed.
voteAdded(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when a vote is added to a poll.
voteCache - Static variable in class com.jivesoftware.base.PollManagerFactory
voteModified(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when a poll vote is modified.
voteRemoved(PollEvent) - Method in interface com.jivesoftware.base.event.PollListener: Fired when a poll vote is removed.

W

warn(String) - Static method in class com.jivesoftware.base.Log
warn(Throwable) - Static method in class com.jivesoftware.base.Log
warn(String, Throwable) - Static method in class com.jivesoftware.base.Log
WARN_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent: Event type for whenever a warn log event occurs.
Watch - Interface in com.jivesoftware.forum: A watch is a way for a user to track updates to an object.
WATCH_SETTINGS - Static variable in class com.jivesoftware.base.JiveConstants
Watchable - Interface in com.jivesoftware.base: A marker interface for objects that can be watched for changes by users.
WatchManager - Interface in com.jivesoftware.forum: Manages watches on categories, forums, and threads.
WEEK - Static variable in class com.jivesoftware.base.JiveConstants: One week (in milliseconds).
WORKGROUP_AGENT - Static variable in class com.jivesoftware.base.JiveConstants
WORKGROUP_GROUP - Static variable in class com.jivesoftware.base.JiveConstants
WORKGROUP_QUEUE - Static variable in class com.jivesoftware.base.JiveConstants
writeExternal(DataOutput) - Method in class com.jivesoftware.forum.QueryResult

A B C D E F G H I J K L M N O P Q R S T U V W

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Jive Forums Project Page

PREV NEXT

FRAMES NO FRAMES