Clearspace API (1.10.18) Core Javadocs
A B C D E F G H I J K L M N O P Q R S T U V W X

A

AbstractRenderFilter - Class in com.jivesoftware.community.renderer
An abstract implementation of the RenderFilter interface this class provides subclasses with built in support for documentation and splits apart the execute method into seperate methods depending on the render target specified in the render context.
AbstractRenderFilter() - Constructor for class com.jivesoftware.community.renderer.AbstractRenderFilter
 
ABUSE - Static variable in class com.jivesoftware.community.JiveConstants
 
ABUSE_TYPES - Static variable in class com.jivesoftware.community.AbuseType
An array containing all possible types of abuse
AbuseManager - Interface in com.jivesoftware.community
Manages all aspects of reporting abuse and managing abuse reports.
AbuseReport - Class in com.jivesoftware.community
This class contains all the necessary information to file an abuse report.
AbuseReport() - Constructor for class com.jivesoftware.community.AbuseReport
 
AbuseReport(long) - Constructor for class com.jivesoftware.community.AbuseReport
 
AbuseType - Class in com.jivesoftware.community
A typesafe enum class that contains various abuse types used for reporting abuse
activeAvatarCache - Static variable in class com.jivesoftware.community.AvatarManagerFactory
 
Activity - Interface in com.jivesoftware.community
Represents activity within a community.
ACTIVITY - Static variable in class com.jivesoftware.community.JiveConstants
 
Activity.Type - Enum in com.jivesoftware.community
Defines a specific type of activity with regard to a piece of content.
addActiveAvatarToCache(Avatar, User) - Static method in class com.jivesoftware.community.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.community.AttachmentManager
Adds a content type to the list of explicitly allowed types.
addAllowedType(String) - Method in interface com.jivesoftware.community.BinaryBodyManager
Adds a content type to the list of explicitly allowed types.
addAllowedType(String) - Method in interface com.jivesoftware.community.ImageManager
Adds a content type to the list of explicitly allowed types.
addAnnouncement(Announcement) - Method in interface com.jivesoftware.community.AnnouncementManager
Adds an an announcement to the database.
addAnonymousUserPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Add a permission of the specified PermissionType for anonymous users.
addAnonymousVote(int, String) - Method in interface com.jivesoftware.community.Poll
Add a guest vote for an option in the poll.
addApprover(User) - Method in interface com.jivesoftware.community.Document
Adds a user as a document approver for this document.
addAttachment(InputStreamDataSource) - Method in class com.jivesoftware.community.EmailMessage
Adds an attachment for this email message
addAuthor(User) - Method in interface com.jivesoftware.community.Document
Adds the supplied User as an author of this document.
addBinaryBodyContentType(String) - Method in class com.jivesoftware.community.DocumentResultFilter
Adds a content type to the list of content types that binary body documents will be filtered upon.
addBlog(Blog) - Method in interface com.jivesoftware.community.BlogManager
Adds a blog to the database.
addBlog(Blog) - Method in interface com.jivesoftware.community.Community
Associates the specified Blog with this community.
addBlogPost(BlogPost) - Method in interface com.jivesoftware.community.Blog
Adds a blogpost to the database.
addBuiltInElement(DocumentTypeElement.Type) - Method in interface com.jivesoftware.community.DocumentType
Used to create and add a new built-in type element to this DocumentTypeSectionElement.
addBuiltInElement(DocumentTypeElement.Type) - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Used to create and add a new built-in type element to this DocumentTypeSectionElement.
addComment(JiveObject, Comment) - Method in interface com.jivesoftware.community.CommentManager
Adds a new comment (no parent) to the object.
addComment(JiveObject, Comment, Comment) - Method in interface com.jivesoftware.community.CommentManager
Adds a new comment having a parent comment to the object.
addDisallowedType(String) - Method in interface com.jivesoftware.community.AttachmentManager
Adds a content type to the list of explicitly disallowed types.
addDisallowedType(String) - Method in interface com.jivesoftware.community.BinaryBodyManager
Adds a content type to the list of explicitly disallowed types.
addDisallowedType(String) - Method in interface com.jivesoftware.community.ImageManager
Adds a content type to the list of explicitly disallowed types.
addDocument(Document) - Method in interface com.jivesoftware.community.Community
Add a document as a child of the community.
addDocument(Document, PermissionsBundle) - Method in interface com.jivesoftware.community.Community
Add a document as a child of the community with permissions defined by the provided permission bundle.
addDocumentApprover(User) - Method in interface com.jivesoftware.community.Community
Add the user as a document approver for this entire community.
addDocumentField(DocumentField, long) - Method in class com.jivesoftware.community.DocumentResultFilter
Adds a document field option to the list of options that will be filtered upon
addDocumentFieldElement(DocumentField) - Method in interface com.jivesoftware.community.DocumentType
Adds a DocumentField to this DocumentTypeSectionElement as an element.
addDocumentFieldElement(DocumentField) - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Adds a DocumentField to this DocumentTypeSectionElement as an element.
addDocumentState(DocumentState) - Method in class com.jivesoftware.community.DocumentResultFilter
Add a document state to the list of document states that will be filtered upon.
addDocumentType(DocumentType) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets the document type to filter results selected by the result filter.
addDocumentTypeSectionElement() - Method in interface com.jivesoftware.community.DocumentType
Creates and adds a DocumentTypeSectionElement.
addFilterRenderTypes(String, List<RenderType>) - Method in interface com.jivesoftware.community.renderer.RenderManager
Adds a set of render types for the given filter.
addGroupPermission(Group, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Grants a group a particular permission.
addHelpfulAnswer(ForumMessage) - Method in interface com.jivesoftware.community.Question
Marks the specified message as a helpful answer to this question.
addImage(Image) - Method in interface com.jivesoftware.community.ImageContentResource
Adds an already existing (temporary) image to the object.
addImporter(Importer) - Method in class com.jivesoftware.community.importer.ImporterFactory
Add an importer to the list of available importers.
addInterceptor(int, JiveInterceptor) - Method in interface com.jivesoftware.community.InterceptorManager
Inserts a new interceptor at specified index in the list of currently configured interceptors.
addInterceptorClass(String) - Method in interface com.jivesoftware.community.InterceptorManager
Installs a new class into the list of available interceptors for the system.
ADDITIVE - Static variable in class com.jivesoftware.community.PermissionType
The additive permission type indicates that the permission should be 'added' to the permissions retrieved from a parent object(s).
addLabelElement(String) - Method in interface com.jivesoftware.community.DocumentType
Used to create and add a new Label Element to this DocumentTypeSectionElement
addLabelElement(String) - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Used to create and add a new Label Element to this DocumentTypeSectionElement
addLanguage(String) - Method in class com.jivesoftware.community.DocumentResultFilter
Add a language to the list of languages that will be filtered upon.
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(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.community.event.AnnouncementEventDispatcher
 
addListener(AttachmentListener) - Method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
addListener(BlogListener) - Method in class com.jivesoftware.community.event.BlogEventDispatcher
 
addListener(BlogPostListener) - Method in class com.jivesoftware.community.event.BlogPostEventDispatcher
 
addListener(CommentListener) - Method in class com.jivesoftware.community.event.CommentEventDispatcher
 
addListener(CommunityListener) - Method in class com.jivesoftware.community.event.CommunityEventDispatcher
 
addListener(DocumentListener) - Method in class com.jivesoftware.community.event.DocumentEventDispatcher
 
addListener(EmailListener) - Method in class com.jivesoftware.community.event.EmailEventDispatcher
 
addListener(ImageListener) - Method in class com.jivesoftware.community.event.ImageEventDispatcher
 
addListener(MessageListener) - Method in class com.jivesoftware.community.event.MessageEventDispatcher
 
addListener(PollListener) - Method in class com.jivesoftware.community.event.PollEventDispatcher
Adds an event listener to the dispatcher.
addListener(PrivateMessageListener) - Method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
 
addListener(ProfileListener) - Method in class com.jivesoftware.community.event.ProfileEventDispatcher
 
addListener(ProfileSearchIndexListener) - Method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
 
addListener(QuestionListener) - Method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
addListener(SearchIndexListener) - Method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
 
addListener(StorageManagerListener) - Method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
 
addListener(TagListener) - Method in class com.jivesoftware.community.event.TagEventDispatcher
 
addListener(TagSetListener) - Method in class com.jivesoftware.community.event.TagSetEventDispatcher
 
addListener(ThreadListener) - Method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
addListener(TrackbackListener) - Method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
addListener(ApplicationLifeCycle.Listener) - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle
Add an application life cycle listener.
addListener(ServiceEventListener<T, O>) - Method in class com.jivesoftware.spi.ServiceEventDispatcher
Register a listener
addListener(ServiceEventListener<T, O>) - Method in interface com.jivesoftware.spi.ServiceEventSource
Used to register listeners
addLoginCookie(AuthToken, HttpServletRequest, HttpServletResponse) - Method in class com.jivesoftware.base.AuthFactory
 
addMapListener(MapListener) - Method in class com.jivesoftware.community.cache.DefaultCache
Add a map listener.
addMapListener(MapListener, Object, boolean) - Method in class com.jivesoftware.community.cache.DefaultCache
 
addMapListener(MapListener, Filter, boolean) - Method in class com.jivesoftware.community.cache.DefaultCache
 
addMember(User) - Method in interface com.jivesoftware.base.Group
Adds a member to the group.
addMessage(ForumMessage, ForumMessage) - Method in interface com.jivesoftware.community.ForumThread
Adds a new message to this thread.
addOption(String) - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Adds an option to this document field.
addOption(String) - Method in interface com.jivesoftware.community.Poll
Add a new option to the poll.
addPluginCSSSourceURLs(String, Collection<String>) - Method in class com.jivesoftware.base.plugin.PluginManager
Add a collection of CSS urls for a plugin.
addPluginJavascriptSourceURLs(String, Collection<String>) - Method in class com.jivesoftware.base.plugin.PluginManager
Add a collection of javascript urls for a plugin.
addPluginListener(PluginListener) - Method in class com.jivesoftware.base.plugin.PluginManager
Registers a plugin applicationLifeCycleListener.
addPoints(User, Community, JiveObject, long, String) - Method in interface com.jivesoftware.community.StatusLevelManager
Rewards points to a user.
addProperty(String, String) - Method in class com.jivesoftware.community.QuestionFilter
Adds a property to the list of properties that will be filtered on.
addProperty(String, String) - Method in class com.jivesoftware.community.ResultFilter
Adds a property to the list of properties that will be filtered on.
addProperty(String, String, int) - Method in class com.jivesoftware.community.ResultFilter
Adds a property to the list of properties that will be filtered on.
addRating(User, JiveObject, Rating) - Method in interface com.jivesoftware.community.RatingManager
Add a rating to the JiveContentObject.
addRecipient(EmailMessage.EmailAddress) - Method in class com.jivesoftware.community.EmailMessage
Adds a recipient (to address) for this email message
addRecipient(String, String) - Method in class com.jivesoftware.community.EmailMessage
Adds a recipient (to address) for this email message
addRegisteredUserPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Add a permission of the specified PermissionType for registered users.
addRenderFilter(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Installs a new class into the list of render filters for the system.
addRenderFilter(RenderFilter) - Method in interface com.jivesoftware.community.renderer.RenderManager
Adds a new filter to the filter stack.
addResolutionState(Question.State) - Method in class com.jivesoftware.community.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.community.ThreadResultFilter
Adds a resolution state to the set of states that will be included in filtered results.
addReviewer(User) - Method in interface com.jivesoftware.community.Document
Adds the supplied User as a reviewer of this document.
addSearchEngine(SearchEngine) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Add a search engine to be managed.
addSearchEngineFromDescriptorURL(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Add a search engine to be managed.
addServerInfoCookie(HttpServletRequest, HttpServletResponse) - Method in class com.jivesoftware.base.AuthFactory
 
addTag(ContentTag) - Method in class com.jivesoftware.community.ResultFilter
Adds a ContentTag to the list of tags to filter on.
addTag(ContentTag, JiveObject) - Method in interface com.jivesoftware.community.TagManager
Associates a tag with this object
addTag(ContentTag) - Method in interface com.jivesoftware.community.TagSet
Adds the supplied ContentTag to this TagSet.
addText(String) - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Add a text snippet to the store receiving a token in return.
addTextExtractor(String) - Method in interface com.jivesoftware.community.SearchManager
Installs a new class into the list of available text extractors for the system.
addThread(ForumThread) - Method in interface com.jivesoftware.community.Community
Adds a new thread to the community.
addToIndex(User) - Method in interface com.jivesoftware.community.ProfileSearchManager
Adds an individual user to the index.
addToIndex(Blog) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual blog to the index.
addToIndex(BlogPost) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual blog posts to the index.
addToIndex(ForumMessage) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual message to the index.
addToIndex(Document) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual document to the index.
addToIndex(Comment) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual comment to the index.
addToIndex(Attachment) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual attachment to the index.
addToIndex(Community) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual community to the index.
addTrackback(Trackback) - Method in interface com.jivesoftware.community.TrackbackManager
Adds a new trackback to this object When a trackback is being added, it is first run through all trackback interceptors that are installed.
addUser(User) - Method in interface com.jivesoftware.community.Blog
Gives a user permission to post to this blog.
addUser(User) - Method in interface com.jivesoftware.community.Roster
Add a user to the roster.
addUserPermission(User, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Add a permission of the specified PermissionType for the specified user.
addUserVote(int, User) - Method in interface com.jivesoftware.community.Poll
Add a user vote for an option in the poll.
addWidget(String) - Method in interface com.jivesoftware.community.widget.WidgetManager
Installs a new class into the list of Widgets for the system.
addWidgetFrame(WidgetFrameBean) - Method in interface com.jivesoftware.community.widget.WidgetManager
Creates a new WidgetFrame based on the specified WidgetFrameBean.
addXMPPListener(XMPPListener) - Method in class com.jivesoftware.community.xmpp.IMManager
Adds an XMPP listener, which listens for connects and disconnects as well as presence updates.
ADMINEMAIL - Static variable in interface com.jivesoftware.community.EmailManager
 
ADMINNAME - Static variable in interface com.jivesoftware.community.EmailManager
 
ageList - Variable in class com.jivesoftware.community.cache.DefaultCache
Linked list to maintain time that cache objects were initially added to the cache, most recently added to oldest added.
ALL_TYPES - Static variable in interface com.jivesoftware.community.ContentRetrieval
An array of all ContentRetrieval.ContentTypes
ALL_TYPES - Static variable in interface com.jivesoftware.community.SearchQueryResult
An array of all SearchQueryResult.ResultTypes
ALLOW_ANONYMOUS_VOTE_MODIFICATION - Static variable in interface com.jivesoftware.community.Poll
Mode to allow guests to change their vote after casting the vote.
ALLOW_USER_VOTE_MODIFICATION - Static variable in interface com.jivesoftware.community.Poll
Mode to allow users to change their vote after casting the vote.
allowedLanguageDeleted(String) - Method in interface com.jivesoftware.community.event.LanguageConfigurationEventListener
Notification message sent when an allowed language was deleted.
AlreadyExistsException - Exception in com.jivesoftware.spi.user
Thrown trying to create an existing resource.
AlreadyExistsException() - Constructor for exception com.jivesoftware.spi.user.AlreadyExistsException
 
AlreadyExistsException(String) - Constructor for exception com.jivesoftware.spi.user.AlreadyExistsException
 
AlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.spi.user.AlreadyExistsException
 
AlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.spi.user.AlreadyExistsException
 
AlwaysAllowAnonymous - Annotation Type in com.jivesoftware.community.action.util
Should be placed on classes that should not be redirected from when the jive property jive.auth.disallowGuest is set to true.
AND_MODE - Static variable in class com.jivesoftware.community.ResultFilter
'AND' mode.
Announcement - Interface in com.jivesoftware.community
Alerts users to important information.
ANNOUNCEMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
ANNOUNCEMENT_CREATED - Static variable in class com.jivesoftware.community.event.AnnouncementEvent
Announcement was added to the system.
ANNOUNCEMENT_DELETED - Static variable in class com.jivesoftware.community.event.AnnouncementEvent
Announcement was deleted.
ANNOUNCEMENT_MODIFIED - Static variable in class com.jivesoftware.community.event.AnnouncementEvent
The announcement was modified.
announcementCreated(AnnouncementEvent) - Method in interface com.jivesoftware.community.event.AnnouncementListener
Fired when an announcement has been added to the system.
announcementDeleted(AnnouncementEvent) - Method in interface com.jivesoftware.community.event.AnnouncementListener
Fired when an announcement is about to be deleted from the system.
AnnouncementEvent - Class in com.jivesoftware.community.event
A class for Announcement events.
AnnouncementEvent(int, Announcement, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.AnnouncementEvent
Creates a new announcement event.
AnnouncementEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for AnnouncementEvents.
AnnouncementListener - Interface in com.jivesoftware.community.event
An AnnouncementListener gets notified anytime an announcement event is fired.
AnnouncementManager - Interface in com.jivesoftware.community
Manages announcements, including viewing, creating, and deleting them.
announcementModified(AnnouncementEvent) - Method in interface com.jivesoftware.community.event.AnnouncementListener
Fired when portions of an announcement have been modified.
AnnouncementNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Announcement was not found.
AnnouncementNotFoundException() - Constructor for exception com.jivesoftware.community.AnnouncementNotFoundException
 
AnnouncementNotFoundException(String) - Constructor for exception com.jivesoftware.community.AnnouncementNotFoundException
 
ANONYMOUS - Static variable in class com.jivesoftware.community.JiveConstants
 
ANONYMOUS_USER_ID - Static variable in class com.jivesoftware.base.AuthFactory
Defines the id used for anonymous users.
ANONYMOUS_VOTE_ADDED - Static variable in class com.jivesoftware.community.event.PollEvent
An anonymous vote was added to the poll.
ANONYMOUS_VOTE_MODIFIED - Static variable in class com.jivesoftware.community.event.PollEvent
An anonymous vote was modified.
ANONYMOUS_VOTE_REMOVED - Static variable in class com.jivesoftware.community.event.PollEvent
An anonymous vote was removed.
anonymousUserHasPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Returns true if the anonymous users have a particular permission.
anonymousVoteAdded(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when an anonymous vote is added to a poll.
anonymousVoteModified(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when an anonymous poll vote is modified.
anonymousVoteRemoved(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when an anonymous poll vote is removed.
appendExtension(String) - Method in enum com.jivesoftware.community.renderer.RenderTarget
 
ApplicationLifeCycle - Interface in com.jivesoftware.community.lifecycle
An interface to manage lifecycle events for the application.
ApplicationLifeCycle.Listener - Interface in com.jivesoftware.community.lifecycle
An interface for an application life cycle listener.
applicationLifeCycleListener - Variable in class com.jivesoftware.base.plugin.PluginManager
 
applyFreemarkerTemplate(Configuration, Map<String, Object>, String) - Static method in class com.jivesoftware.community.renderer.BaseFilter
Processes the specified template file and returns a String containing the content of the template file.
applyFreemarkerTemplate(WidgetContext, Widget.ContainerSize, String) - Method in class com.jivesoftware.community.widget.BaseWidget
Processes the specified template file and returns a String containing the content of the template file.
ApprovalStatus - Class in com.jivesoftware.community
Contains information on whether a user has approved a document edit and when.
ApprovalStatus(User, boolean, boolean, Date) - Constructor for class com.jivesoftware.community.ApprovalStatus
Creates a new approval status object.
approve(User) - Method in interface com.jivesoftware.community.Document
Marks this document as being approved by the specified user.
approve(AuthToken, ForumMessage) - Method in interface com.jivesoftware.community.ModerationManager
Approve a moderated message
ArchiveManager - Interface in com.jivesoftware.community
Manages the archive feature of Jive.
ASCENDING - Static variable in class com.jivesoftware.community.BanFilter
Ascending sort (ie 3, 4, 5...).
ASCENDING - Static variable in class com.jivesoftware.community.QuestionFilter
Ascending sort (ie 3, 4, 5...).
ASCENDING - Static variable in class com.jivesoftware.community.ResultFilter
Ascending sort (ie 3, 4, 5...).
asPDF() - Method in interface com.jivesoftware.community.Document
Returns the contents of this document as a pdf.
assumed_resolved - Static variable in class com.jivesoftware.community.Question.State
The question is answered, but the question creator has not indicated that the question is resolved.
Attachment - Interface in com.jivesoftware.community
An object that encapsulates an attachment.
ATTACHMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
ATTACHMENT_ADDED - Static variable in class com.jivesoftware.community.event.AttachmentEvent
Event type for whenever an attachment is added to a document.
ATTACHMENT_DELETING - Static variable in class com.jivesoftware.community.event.AttachmentEvent
Event type for whenever an attachment is about to be deleted.
ATTACHMENT_DOWNLOADED - Static variable in class com.jivesoftware.community.event.AttachmentEvent
Event type for whenever an attachment was download.
ATTACHMENT_MODIFIED - Static variable in class com.jivesoftware.community.event.AttachmentEvent
Event type for whenever an attachment was modified.
attachmentAdded(AttachmentEvent) - Method in interface com.jivesoftware.community.event.AttachmentListener
Fired when an attachment is added to a document.
AttachmentContentResource - Interface in com.jivesoftware.community
A base interface defining attachments methods.
attachmentDeleted(AttachmentEvent) - Method in interface com.jivesoftware.community.event.AttachmentListener
Fired when an attachment is deleted from a document.
attachmentDownloaded(AttachmentEvent) - Method in interface com.jivesoftware.community.event.AttachmentListener
Fired when an attachment was downloaded.
AttachmentEvent - Class in com.jivesoftware.community.event
A class for Attachment events.
AttachmentEvent(int, JiveObject, Attachment, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.AttachmentEvent
 
AttachmentEvent(int, JiveObject, Attachment, Map<String, ? extends Object>, File) - Constructor for class com.jivesoftware.community.event.AttachmentEvent
 
AttachmentEvent(int, JiveObject, Attachment, Map<String, ? extends Object>, File, AttachmentManager) - Constructor for class com.jivesoftware.community.event.AttachmentEvent
 
AttachmentEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for AttachmentEvents.
AttachmentException - Exception in com.jivesoftware.community
Thrown if an error occurs uploading or updating an Attachment.
AttachmentException(String, Throwable) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, Throwable) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, Throwable, String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(String, int) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentListener - Interface in com.jivesoftware.community.event
An AttachmentListener gets notified anytime an attachment event is fired.
AttachmentManager - Interface in com.jivesoftware.community
Manages attachment settings.
attachmentModified(AttachmentEvent) - Method in interface com.jivesoftware.community.event.AttachmentListener
Fired when an attachment was modified.
AttachmentNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Attachment was not found.
AttachmentNotFoundException() - Constructor for exception com.jivesoftware.community.AttachmentNotFoundException
 
AttachmentNotFoundException(String) - Constructor for exception com.jivesoftware.community.AttachmentNotFoundException
 
AUTH_FACTORY_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
AUTH_PROVIDER_KEY - Static variable in class com.jivesoftware.base.AuthFactory
 
authenticate(String, String) - Method in interface com.jivesoftware.base.UserManager
 
authenticate(char[]) - Method in interface com.jivesoftware.spi.user.User
Authenticate the user with the given password
authenticate(char[]) - Method in class com.jivesoftware.spi.user.UserTemplate
 
AuthenticationProvider - Interface in com.jivesoftware.spi.user
Service for authenticating and identifying users.
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
 
AuthFactory.SystemAuthToken - Class in com.jivesoftware.base
 
author - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
AUTHORSHIP_MULTIPLE - Static variable in interface com.jivesoftware.community.Document
Constant defining authorship policy for this document.
AUTHORSHIP_OPEN - Static variable in interface com.jivesoftware.community.Document
Constant defining authorship policy for this document.
AUTHORSHIP_SINGLE - Static variable in interface com.jivesoftware.community.Document
Constant defining authorship policy for this document.
AuthToken - Interface in com.jivesoftware.base
Proves that a user has successfully logged in.
Avatar - Interface in com.jivesoftware.community
An object that represents a user's avatar.
AVATAR - Static variable in class com.jivesoftware.community.JiveConstants
 
AVATAR_ENABLE_PROPERTY - Static variable in class com.jivesoftware.community.AvatarManagerFactory
 
avatarCache - Static variable in class com.jivesoftware.community.AvatarManagerFactory
 
AvatarException - Exception in com.jivesoftware.community
Thrown if there are problems with creation of an Avatar
AvatarException() - Constructor for exception com.jivesoftware.community.AvatarException
 
AvatarException(String) - Constructor for exception com.jivesoftware.community.AvatarException
 
AvatarException(String, Throwable) - Constructor for exception com.jivesoftware.community.AvatarException
 
AvatarException(Throwable) - Constructor for exception com.jivesoftware.community.AvatarException
 
AvatarException(AttachmentException) - Constructor for exception com.jivesoftware.community.AvatarException
 
AvatarManager - Interface in com.jivesoftware.community
Manages the avatar feature.
AvatarManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of an AvatarManager.
AvatarNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Avatar was not found.
AvatarNotFoundException() - Constructor for exception com.jivesoftware.community.AvatarNotFoundException
 
AvatarNotFoundException(String) - Constructor for exception com.jivesoftware.community.AvatarNotFoundException
 

B

BAD_CONTENT_TYPE - Static variable in exception com.jivesoftware.community.AttachmentException
 
BAD_CONTENT_TYPE - Static variable in exception com.jivesoftware.community.BinaryBodyException
 
BAD_CONTENT_TYPE - Static variable in exception com.jivesoftware.community.ImageException
 
Ban - Class in com.jivesoftware.community
Represents a ban object.
Ban(long, int) - Constructor for class com.jivesoftware.community.Ban
Creates a new Ban object with the specified ban ID and ban type
Ban(long, long, int, Date, String) - Constructor for class com.jivesoftware.community.Ban
Creates a new Ban object for a user.
Ban(String, long, int, Date, String) - Constructor for class com.jivesoftware.community.Ban
Creates a new Ban object for an IP address.
BAN - Static variable in class com.jivesoftware.community.JiveConstants
 
BAN_LEVELS - Static variable in class com.jivesoftware.community.BanLevel
An array containing all possible types of ban levels
BAN_LOGIN - Static variable in class com.jivesoftware.community.BanLevel
Users will not be allowed to login to the system
BAN_POST - Static variable in class com.jivesoftware.community.BanLevel
Users will not be able to post messages or private messages to the system
banCache - Static variable in class com.jivesoftware.community.BanManagerFactory
A cache for user and ip address bans.
BanException - Exception in com.jivesoftware.community
Thrown when a user performs an action that they have been banned from performing.
BanException() - Constructor for exception com.jivesoftware.community.BanException
 
BanException(String) - Constructor for exception com.jivesoftware.community.BanException
 
BanException(Throwable) - Constructor for exception com.jivesoftware.community.BanException
 
BanException(Ban) - Constructor for exception com.jivesoftware.community.BanException
 
BanFilter - Class in com.jivesoftware.community
Filters and sorts lists of Ban objects.
BanFilter() - Constructor for class com.jivesoftware.community.BanFilter
 
BanLevel - Class in com.jivesoftware.community
A typesafe-enum class containing key/value pairs representing BanLevel objects.
BanManager - Interface in com.jivesoftware.community
Manages the banning of User Accounts and IP Addresses.
BanManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of a BanManager
BanManagerFactory.BanCacheKey - Class in com.jivesoftware.community
 
BanManagerFactory.BanCacheKey(long, String, int) - Constructor for class com.jivesoftware.community.BanManagerFactory.BanCacheKey
 
BanManagerFactory.BanCacheKey(Ban) - Constructor for class com.jivesoftware.community.BanManagerFactory.BanCacheKey
 
banMissCache - Static variable in class com.jivesoftware.community.BanManagerFactory
A cache for missed ban objects.
banObjectCache - Static variable in class com.jivesoftware.community.BanManagerFactory
A cache for ban objects.
BaseFilter - Class in com.jivesoftware.community.renderer
A Base class to be used to create a filter.
BaseFilter() - Constructor for class com.jivesoftware.community.renderer.BaseFilter
 
BaseMacro - Class in com.jivesoftware.community.renderer
A Base class to be used to create macros.
BaseMacro() - Constructor for class com.jivesoftware.community.renderer.BaseMacro
 
BaseWidget - Class in com.jivesoftware.community.widget
An abstract implementation of the Widget interface this class provides subclasses with built in support for processing a freemarker template and internationalization.
BaseWidget() - Constructor for class com.jivesoftware.community.widget.BaseWidget
 
BATCH_EMAIL_WATCH - Static variable in interface com.jivesoftware.community.Watch
Batch email watch type.
beforeDestroy() - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle.Listener
This method is called when the application is about to shutdown.
beforeInitialize() - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle.Listener
Called by the initialization code prior to any initialization.
BINARY_BODY_DOWNLOADED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for when a binary body is downloaded
BinaryBody - Interface in com.jivesoftware.community
An object that encapsulates a binary document body.
binaryBodyDownloaded(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fied when a document's binary body is downloaded
binaryBodyDownloaded(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
BinaryBodyException - Exception in com.jivesoftware.community
Thrown if there are problems with creation or loading of a BinaryBody.
BinaryBodyException(int) - Constructor for exception com.jivesoftware.community.BinaryBodyException
 
BinaryBodyException(int, Throwable) - Constructor for exception com.jivesoftware.community.BinaryBodyException
 
BinaryBodyException(int, String) - Constructor for exception com.jivesoftware.community.BinaryBodyException
 
BinaryBodyException(String) - Constructor for exception com.jivesoftware.community.BinaryBodyException
 
BinaryBodyManager - Interface in com.jivesoftware.community
Manages binary body settings.
Blog - Interface in com.jivesoftware.community
A container for a list of blog postings by a user or group of users.
BLOG - Static variable in class com.jivesoftware.community.JiveConstants
 
BLOG_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a blog is added to the search index.
BLOG_CREATED - Static variable in class com.jivesoftware.community.event.BlogEvent
Blog was added to the system.
BLOG_DELETING - Static variable in class com.jivesoftware.community.event.BlogEvent
Blog is about to be deleted.
BLOG_MODIFIED - Static variable in class com.jivesoftware.community.event.BlogEvent
Blog was modified.
BLOG_POST_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a blog post is added to the search index.
BLOG_POST_DELETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a blog post is removed from the search index.
blogAdded(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a blog is added to the index.
blogCreated(BlogEvent) - Method in interface com.jivesoftware.community.event.BlogListener
Fired when a blog has been added to the system.
blogDeleting(BlogEvent) - Method in interface com.jivesoftware.community.event.BlogListener
Fired when a blog is about to be deleted from the system.
BlogEvent - Class in com.jivesoftware.community.event
A class for Blog events.
BlogEvent(int, Blog, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.BlogEvent
Creates a new blog event.
BlogEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for BlogEvents.
BlogListener - Interface in com.jivesoftware.community.event
A BlogListener gets notified anytime a blog event is fired.
BlogManager - Interface in com.jivesoftware.community
Manages blogs, including viewing, creating, and deleting them.
blogModified(BlogEvent) - Method in interface com.jivesoftware.community.event.BlogListener
Fired when a blog has been modified in the system.
BlogNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Blog was not found.
BlogNotFoundException() - Constructor for exception com.jivesoftware.community.BlogNotFoundException
 
BlogNotFoundException(String) - Constructor for exception com.jivesoftware.community.BlogNotFoundException
 
BlogPost - Interface in com.jivesoftware.community
A container for blog post data and for a hierarchy of blog comments.
BLOGPOST - Static variable in class com.jivesoftware.community.JiveConstants
 
blogPostAdded(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a blog post is added to the index.
blogPostDeleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a blog post is deleted from the search index.
BlogPostEvent - Class in com.jivesoftware.community.event
A class for BlogPost events.
BlogPostEvent(int, BlogPost, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.BlogPostEvent
Creates a new post event.
BlogPostEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for BlogPostEvents.
BlogPostListener - Interface in com.jivesoftware.community.event
A BlogPostListener gets notified anytime a blog post event is fired.
BlogPostNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified BlogPost was not found.
BlogPostNotFoundException() - Constructor for exception com.jivesoftware.community.BlogPostNotFoundException
 
BlogPostNotFoundException(String) - Constructor for exception com.jivesoftware.community.BlogPostNotFoundException
 
BlogPostNotFoundException(long) - Constructor for exception com.jivesoftware.community.BlogPostNotFoundException
 
BlogPostResultFilter - Class in com.jivesoftware.community
Filters and sorts BlogPosts.
BlogPostResultFilter() - Constructor for class com.jivesoftware.community.BlogPostResultFilter
 
BlogPostSearchQueryCriteria - Interface in com.jivesoftware.community
Search criteria specific to searching blog posts may be specified using this criteria class.
BlogPostSearchQueryCriteria.BlogPostSortType - Enum in com.jivesoftware.community
Represents how message blog post queries will be sorted
BlogTagResultFilter - Class in com.jivesoftware.community
Filters and sorts tags with specific fields for Blogs.
BlogTagResultFilter() - Constructor for class com.jivesoftware.community.BlogTagResultFilter
 
BlogUtils - Class in com.jivesoftware.community.util
Collection of utility methods used across blogs Includes replaceNonAlphanumeric() from Roller Weblogger server (Apache license).
BODY_FIELD - Static variable in interface com.jivesoftware.community.JiveContentObject
Constant used to indicate a body field.
bundleCache - Variable in class com.jivesoftware.base.plugin.PluginManager
 

C

cacheHits - Variable in class com.jivesoftware.community.cache.DefaultCache
Maintain the number of cache hits and misses.
cacheMisses - Variable in class com.jivesoftware.community.cache.DefaultCache
Maintain the number of cache hits and misses.
cacheSize - Variable in class com.jivesoftware.community.cache.DefaultCache
Maintains the current size of the cache in bytes.
calculateSize(Object) - Method in class com.jivesoftware.community.cache.DefaultCache
Returns the size of an object in bytes.
CANCEL - Static variable in class com.jivesoftware.community.action.JiveActionSupport
An action return type that indicates the user wants to cancel the current process.
canRate(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns whether the user can rate the JiveContentObject or not.
changeAnonymousVote(int, int, String) - Method in interface com.jivesoftware.community.Poll
Change a guest vote.
changelogExists - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
changeUserVote(int, int, User) - Method in interface com.jivesoftware.community.Poll
Change a user vote.
checkAuthorization(AuthToken, HttpServletRequest) - Static method in class com.jivesoftware.base.AuthFactory
Checks if the specified AuthToken is authorized.
childPluginMap - Variable in class com.jivesoftware.base.plugin.PluginManager
 
children(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns an Iterable for all the child comments of the parent.
cipher - Static variable in class com.jivesoftware.base.AuthFactory
 
classloaders - Variable in class com.jivesoftware.base.plugin.PluginManager
 
clear() - Method in class com.jivesoftware.community.cache.DefaultCache
 
clear() - Method in class com.jivesoftware.community.lifecycle.JiveApplication.ManagerHandler
Clear all of the manager mappings, This is done if the application is reinitialized.
clearAvatarFromCache(Avatar) - Static method in class com.jivesoftware.community.AvatarManagerFactory
Clears an avatar from all the caches
clearResolutionStates() - Method in class com.jivesoftware.community.QuestionFilter
Removes all resolution states from the set of states that will be included in filtered results.
clearResolutionStates() - Method in class com.jivesoftware.community.ThreadResultFilter
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.
clearTestContext() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
z For testing purposes only.
clone() - Method in class com.jivesoftware.community.QuestionFilter
Clones a ResultFilter
cloneDocumentVersion(int) - Method in interface com.jivesoftware.community.VersionManager
Creates a new document version based on an existing document version.
clusteringStarted() - Method in class com.jivesoftware.community.xmpp.IMManager
 
clusteringStopped() - Method in class com.jivesoftware.community.xmpp.IMManager
 
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.base.plugin - package com.jivesoftware.base.plugin
Plugin API for extending the core API with custom functionality.
com.jivesoftware.community - package com.jivesoftware.community
Core interfaces and classes for Clearspace.
com.jivesoftware.community.action - package com.jivesoftware.community.action
Clearspace WebWork actions.
com.jivesoftware.community.action.util - package com.jivesoftware.community.action.util
Utility classes for action authors or skin developers.
com.jivesoftware.community.annotations - package com.jivesoftware.community.annotations
 
com.jivesoftware.community.cache - package com.jivesoftware.community.cache
Cache interfaces and implementations for Clearspace.
com.jivesoftware.community.event - package com.jivesoftware.community.event
Provides mechanisms to be notified of actions in the system such as new messages being created.
com.jivesoftware.community.field.formatter - package com.jivesoftware.community.field.formatter
Formatters for profile and document fields.
com.jivesoftware.community.importer - package com.jivesoftware.community.importer
 
com.jivesoftware.community.license.annotations - package com.jivesoftware.community.license.annotations
License support annotations.
com.jivesoftware.community.lifecycle - package com.jivesoftware.community.lifecycle
Provides application lifecycle management for Clearspace.
com.jivesoftware.community.mail - package com.jivesoftware.community.mail
Provides tools to send and receive email messages.
com.jivesoftware.community.renderer - package com.jivesoftware.community.renderer
The renderer package provides a way for converting text in one format into another, typically from markup to html and vice versa.
com.jivesoftware.community.renderer.annotations - package com.jivesoftware.community.renderer.annotations
 
com.jivesoftware.community.search.opensearch - package com.jivesoftware.community.search.opensearch
 
com.jivesoftware.community.util - package com.jivesoftware.community.util
Clearspace utility classes.
com.jivesoftware.community.web.webwork - package com.jivesoftware.community.web.webwork
WebWork support classes.
com.jivesoftware.community.widget - package com.jivesoftware.community.widget
 
com.jivesoftware.community.xmpp - package com.jivesoftware.community.xmpp
XMPP integration classes to integrate XMPP with Clearspace.
com.jivesoftware.spi - package com.jivesoftware.spi
 
com.jivesoftware.spi.user - package com.jivesoftware.spi.user
 
Comment - Interface in com.jivesoftware.community
A comment provides a way for users to annotate or give feedback on a JiveContentObject.
COMMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMENT_ADDED - Static variable in class com.jivesoftware.community.event.CommentEvent
Event type for whenever a comment is added to a document.
COMMENT_AUTH_DEFAULT - Static variable in interface com.jivesoftware.community.Blog
The default comment authentication value.
COMMENT_AUTH_OPTIONAL - Static variable in interface com.jivesoftware.community.Blog
Value for comment authentication which indicates that users need not register with the system nor do they have to provide an email address as part of a comment.
COMMENT_AUTH_OPTIONAL_WITH_EMAIL - Static variable in interface com.jivesoftware.community.Blog
Value for comment authentication which indicates that users must either register and authenticate with the system or provide an email address as part of an anonymous comment before submitting a comment.
COMMENT_AUTH_REQUIRED - Static variable in interface com.jivesoftware.community.Blog
Value for comment authentication which indicates that users must register and authenticate with the system before adding a comment.
COMMENT_DELETED - Static variable in class com.jivesoftware.community.event.CommentEvent
Event type for whenever a comment is deleted from a document.
COMMENT_MODERATION_MODIFIED - Static variable in class com.jivesoftware.community.event.CommentEvent
Event type for whenever a comment's moderation value changes.
COMMENT_MODIFIED - Static variable in class com.jivesoftware.community.event.CommentEvent
Event type for whenever a comment is modified.
commentAdded(CommentEvent) - Method in interface com.jivesoftware.community.event.CommentListener
Fired when a comment is added.
commentDeleted(CommentEvent) - Method in interface com.jivesoftware.community.event.CommentListener
Fired when a comment is deleted.
CommentEvent - Class in com.jivesoftware.community.event
A class for Comment events.
CommentEvent(int, Comment, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.CommentEvent
 
CommentEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for CommentEvents.
CommentListener - Interface in com.jivesoftware.community.event
A CommentListener gets notified anytime a comment event is fired.
CommentManager - Interface in com.jivesoftware.community
Handles comments for a JiveObject.
commentModerated(CommentEvent) - Method in interface com.jivesoftware.community.event.CommentListener
Fired when a comment is moderated.
commentModified(CommentEvent) - Method in interface com.jivesoftware.community.event.CommentListener
Fired when a comment is modified.
CommentNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Comment was not found
CommentNotFoundException() - Constructor for exception com.jivesoftware.community.CommentNotFoundException
 
CommentNotFoundException(String) - Constructor for exception com.jivesoftware.community.CommentNotFoundException
 
CommentNotFoundException(long) - Constructor for exception com.jivesoftware.community.CommentNotFoundException
 
CommentNotFoundException(long, String) - Constructor for exception com.jivesoftware.community.CommentNotFoundException
 
CommentNotFoundException(long, Exception) - Constructor for exception com.jivesoftware.community.CommentNotFoundException
 
CommentResultFilter - Class in com.jivesoftware.community
Filters and sorts lists of Comments.
CommentResultFilter() - Constructor for class com.jivesoftware.community.CommentResultFilter
 
COMMENTS_CLOSED - Static variable in interface com.jivesoftware.community.CommentManager
Comment status for documents that may have allowed comments in the past but presently do not accept comments.
COMMENTS_DEFAULT - Static variable in interface com.jivesoftware.community.CommentManager
The default comment status for a document.
COMMENTS_NONE - Static variable in interface com.jivesoftware.community.CommentManager
Comment status for documents that do not accept comments.
COMMENTS_OPEN - Static variable in interface com.jivesoftware.community.CommentManager
Comment status for documents that do accept comments.
CommentTreeWalker - Interface in com.jivesoftware.community
Allows hierarchical navigation of comments.
Community - Interface in com.jivesoftware.community
A container for threads, documents and a hierarchy of other communities.
COMMUNITY - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMUNITY_ADDED - Static variable in class com.jivesoftware.community.event.CommunityEvent
Event type for whenever a community is added to another community.
COMMUNITY_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a community is added to the search index.
COMMUNITY_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer a community.
COMMUNITY_DELETING - Static variable in class com.jivesoftware.community.event.CommunityEvent
Event type for whenever a community is about to be deleted.
COMMUNITY_MERGING - Static variable in class com.jivesoftware.community.event.CommunityEvent
When two communities are merged
COMMUNITY_MODIFIED - Static variable in class com.jivesoftware.community.event.CommunityEvent
Event type for whenever a community is modified.
COMMUNITY_MOVED - Static variable in class com.jivesoftware.community.event.CommunityEvent
Event type for whenever a community is moved.
COMMUNITY_NAME - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMUNITY_QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMUNITY_SEARCH_QUERY - Static variable in class com.jivesoftware.community.JiveConstants
 
communityAdded(CommunityEvent) - Method in interface com.jivesoftware.community.event.CommunityListener
Fired when a Community is added.
communityAdded(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a community is added to the search index.
communityDeleting(CommunityEvent) - Method in interface com.jivesoftware.community.event.CommunityListener
Fired when a Community is about to be deleted.
CommunityEvent - Class in com.jivesoftware.community.event
A class for Community events.
CommunityEvent(int, Community, Map<String, ?>) - Constructor for class com.jivesoftware.community.event.CommunityEvent
 
CommunityEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for CommunityEvents.
CommunityListener - Interface in com.jivesoftware.community.event
A CommunityListener gets notified anytime a community event is fired.
CommunityManager - Interface in com.jivesoftware.community
This manager provides methods to load communities by ID and to retrieve the root community.
communityMerging(CommunityEvent) - Method in interface com.jivesoftware.community.event.CommunityListener
Fired when a Community is about to be merged into another community.
communityModified(CommunityEvent) - Method in interface com.jivesoftware.community.event.CommunityListener
Fired when a Community is modified.
communityMoved(CommunityEvent) - Method in interface com.jivesoftware.community.event.CommunityListener
Fired when a Community is moved.
CommunityNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Community was not found
CommunityNotFoundException() - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String, long) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
Creates this exception with a messages and the id of the community that could not be found.
CommunityNotFoundException(long) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
Creates this exception with the id of the community that could not be found.
compareTo(Question.State) - Method in class com.jivesoftware.community.Question.State
 
componentStarted() - Method in interface com.jivesoftware.community.event.XMPPListener
The XMPP component started, which means there is an active connection to an XMPP server.
componentStopped() - Method in interface com.jivesoftware.community.event.XMPPListener
The XMPP component stopped, which means there is no connection to an XMPP server.
config - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
configureCaches(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
Checks to see if the plugin has a cache-config.xml.
configureDWR(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
Checks to see if the plugin has a dwr-plugin.xml.
configureUIComponents(Document, Element, String) - Method in class com.jivesoftware.base.plugin.PluginManager
 
configureWebwork(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
contains(ContentTag) - Method in interface com.jivesoftware.community.TagSet
Returns true if this TagSet contains the specified ContentTag.
CONTAINS_MATCH - Static variable in class com.jivesoftware.community.ResultFilter
Contains match.
containsElement(DocumentTypeElement) - Method in interface com.jivesoftware.community.DocumentType
A convenience method for checking whether the document type contains the specified field
containsKey(Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
containsValue(Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
CONTENT_OBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
contentObject - Variable in class com.jivesoftware.base.plugin.MacroContext
 
ContentRetrieval - Interface in com.jivesoftware.community
Interface for accessing threads, messages, documents, and blog posts - all the fundamental content elements in the system.
ContentRetrieval.ContentType - Enum in com.jivesoftware.community
Enumeration of the primary three types of content elements in the system.
ContentTag - Interface in com.jivesoftware.community
Container for tags associated with a taggable object.
COOKIE_AUTOLOGIN - Static variable in class com.jivesoftware.base.AuthFactory
Name of the cookie used to store user info for auto-login purposes.
COOKIE_JIVE_SERVER_INFO - Static variable in class com.jivesoftware.base.AuthFactory
Cookie used for things like akamai to tell information about a specific server.
COOKIE_LOGGED_IN - Static variable in class com.jivesoftware.base.AuthFactory
Cookie used to show that the current user is logged in.
copyAuthProviderConfigToLDAP() - Static method in class com.jivesoftware.base.AuthFactory
 
copyGlobalFilters() - Method in interface com.jivesoftware.community.renderer.RenderManager
Copy all global filters to the current context.
copyLdapConfigToAuthProvider() - Static method in class com.jivesoftware.base.AuthFactory
 
copyWidgetFrames(JiveObject, JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Copies the WidgetFrames from the source JiveObject to the destination JiveObject.
CORRECT_ANSWER_SET - Static variable in class com.jivesoftware.community.event.QuestionEvent
A correct answer was added to the question.
correctAnswerAdded(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when a correct answer has been added to the question.
create(UserTemplate) - Method in interface com.jivesoftware.spi.user.UserProvider
Creates a user based on the data passed in the UserTemplate
create(User) - Static method in class com.jivesoftware.spi.user.UserTemplate
 
CREATE_ANNOUNCEMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create, delete, and schedule announcements.
CREATE_BLOG - Static variable in class com.jivesoftware.community.Permissions
Permission to create a blog.
CREATE_COMMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a comment
CREATE_DOC_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create an attachment
CREATE_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a document
CREATE_IMAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to create an image
CREATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to create a new message.
CREATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create attachments.
CREATE_POLL - Static variable in class com.jivesoftware.community.Permissions
Permission to create polls.
CREATE_PRIVATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create attachments in a private message.
CREATE_THREAD - Static variable in class com.jivesoftware.community.Permissions
Permission to create a new thread.
createAbuseOnlyFilter() - Static method in class com.jivesoftware.community.ModerationFilter
Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
createAllStatesFilter() - Static method in class com.jivesoftware.community.DocumentResultFilter
 
createAnnouncement(User) - Method in interface com.jivesoftware.community.AnnouncementManager
Creates a new system announcement.
createAnnouncement(User, Community) - Method in interface com.jivesoftware.community.AnnouncementManager
Creates a new community announcement.
createAnonymousAuthToken() - Method in class com.jivesoftware.base.AuthFactory
Creates anonymous AuthToken tokens.
createAttachment(String, String, InputStream, File) - Method in interface com.jivesoftware.community.AttachmentContentResource
Creates a new attachment for the object.
createAuthToken(String, String) - Method in class com.jivesoftware.base.AuthFactory
Creates AuthToken tokens based on a username.
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.community.AvatarManager
Creates a new avatar for a user allowing the user to specify an inputstream for the image.
createBan(Ban) - Method in interface com.jivesoftware.community.BanManager
Creates a ban entry in the database
createBlog(User) - Method in interface com.jivesoftware.community.BlogManager
Creates a new blog.
createBlogPost(User) - Method in interface com.jivesoftware.community.Blog
Creates a new blog post.
createComment(JiveObject, User, String) - Method in interface com.jivesoftware.community.CommentManager
Create a new comment.
createCommunity(String, String, String) - Method in interface com.jivesoftware.community.Community
Creates a new Community as a sub-community of this community using the name and description.
createDefaultBanFilter() - Static method in class com.jivesoftware.community.BanFilter
Creates a default BanFilter: Filters out expired bans with results sorted by expiration date in descending order.
createDefaultContentFilter() - Static method in class com.jivesoftware.community.ResultFilter
Creates a default ResultFilter: no filtering with results sorted on the modification date.
createDefaultFilter() - Static method in class com.jivesoftware.community.BlogPostResultFilter
Creates a default blog post ResultFilter: only blog posts that have status = BlogPost.STATUS_PUBLISH with results sorted on the blog post publish date (newest blog posts first).
createDefaultFilter() - Static method in class com.jivesoftware.community.BlogTagResultFilter
Creates a default tag ResultFilter: all tags associated with blog posts that have status = BlogPost.STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.
createDefaultFilter() - Static method in class com.jivesoftware.community.CommentResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
createDefaultFilter(Community) - Static method in class com.jivesoftware.community.CommentResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
createDefaultFilter() - Static method in class com.jivesoftware.community.DocumentResultFilter
Creates a default document ResultFilter: no filtering with results sorted on the document's creation date in descending order.
createDefaultFilter() - Static method in class com.jivesoftware.community.FeedbackResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment / trackback creation date.
createDefaultFilter() - Static method in class com.jivesoftware.community.StatusResultFilter
Creates a default status ResultFilter: 25 results sorted on the creation date in descending order.
createDefaultFilter() - Static method in class com.jivesoftware.community.TagResultFilter
Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.
createDefaultMessageFilter() - Static method in class com.jivesoftware.community.ThreadResultFilter
Creates a default message ResultFilter: no filtering with results sorted on the message creation date in ascending order.
createDefaultModerationFilter() - Static method in class com.jivesoftware.community.ModerationFilter
Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
createDefaultRecursiveContentFilter() - Static method in class com.jivesoftware.community.ResultFilter
Creates a default recursive ResultFilter: no filtering with results sorted on the modification date.
createDefaultThreadFilter() - Static method in class com.jivesoftware.community.ThreadResultFilter
Creates a default thread ResultFilter: no filtering with results sorted on the thread modification date.
createDefaultUserMessagesFilter() - Static method in class com.jivesoftware.community.ThreadResultFilter
Creates a default user messages ResultFilter: no filtering with results sorted on the message creation date descending (newest messages appear first).
createDocument(User, DocumentType, String, String, String) - Method in interface com.jivesoftware.community.DocumentManager
Create a new document.
createDocumentField(String, String, String, DocumentFieldType) - Method in interface com.jivesoftware.community.DocumentFieldManager
Creates a new document field.
createDocumentFieldType(String, String, String, DocumentFieldType.DataType, DocumentFieldValidator, DocumentFieldFormatter) - Method in interface com.jivesoftware.community.DocumentFieldTypeManager
Creates a new DocumentFieldType.
createDocumentType(String, String) - Method in interface com.jivesoftware.community.DocumentTypeManager
Create a new document type with the specified attributes.
createDraft(Draft) - Method in interface com.jivesoftware.community.DraftManager
Creates a new draft.
createFolder(User, String) - Method in interface com.jivesoftware.community.PrivateMessageManager
Creates a new folder.
createGroup(String) - Method in interface com.jivesoftware.base.GroupManager
Factory method for creating a new Group.
createImage(String, String, InputStream) - Method in interface com.jivesoftware.community.ImageContentResource
Creates a new image for the object.
createMessage() - Method in interface com.jivesoftware.community.Community
Factory method to create a message with an anonymous author.
createMessage(User) - Method in interface com.jivesoftware.community.Community
Factory method to create a message as the specified user.
createMessage(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Creates a new private message.
createModerationOnlyFilter() - Static method in class com.jivesoftware.community.ModerationFilter
Creates a default Moderation Filter: shows all messages marked for moderation with results sorted by creation date in ascending order.
createPoll(int, long, User, String) - Method in interface com.jivesoftware.community.PollManager
Create a new Poll.
createPresence(User, String, String) - Method in interface com.jivesoftware.community.PresenceManager
Create a presence for a user.
createPresenter(String) - Method in interface com.jivesoftware.community.DocumentType
Creates a DocumentPresenter and adds it to this DocumentType.
createProfileField(ProfileField) - Method in interface com.jivesoftware.community.ProfileFieldManager
Creates a new profile field.
createQuestion(ForumThread) - Method in interface com.jivesoftware.community.QuestionManager
Creates a new question.
createRating(int, String) - Method in interface com.jivesoftware.community.RatingManager
Create a new rating with the specified attributes.
createSearchQuery(SearchQueryCriteria) - Method in interface com.jivesoftware.community.SearchQueryManager
Creates a SearchQuery object to search through all blogs, documents and messages system wide.
createSearchQuery(SearchQueryCriteria, Community...) - Method in interface com.jivesoftware.community.SearchQueryManager
Creates a SearchQuery object to search through the specified array of communities.
createSearchQueryCriteria(String) - Method in interface com.jivesoftware.community.SearchQueryManager
Creates a SearchQueryCriteria using the provided query string that can be used to find blog posts, documents and messages matching the query string.
createSearchQueryCriteria(Blog) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for blogs that are deemed similar to the provided blog.
createSearchQueryCriteria(BlogPost) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for blog posts, documents and messages that are deemed similar to the provided blog post.
createSearchQueryCriteria(Document) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for blog posts, documents and messages that are deemed similar to the provided document.
createSearchQueryCriteria(ForumMessage) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for blog posts, documents and messages that are deemed similar to the provided message.
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.community.StatusLevelManager
Creates a new points based StatusLevel.
createStatusLevel(String, String, Group) - Method in interface com.jivesoftware.community.StatusLevelManager
Creates a new group based StatusLevel Level
createTag(String) - Method in interface com.jivesoftware.community.TagManager
Creates a tag in the database.
createTagSet(String, String, Iterable<ContentTag>, Community) - Method in interface com.jivesoftware.community.TagSetManager
Creates a new TagSet with the supplied name, description, and tags.
createThread(ForumMessage) - Method in interface com.jivesoftware.community.Community
Factory method to create a new thread.
createTrackback() - Method in interface com.jivesoftware.community.TrackbackManager
Factory method to create a trackback .
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<String, String>) - Method in interface com.jivesoftware.base.UserManager
Factory method for creating a new User with all required AND optional values.
createVersionComment(User, String) - Method in interface com.jivesoftware.community.DocumentVersion
Creates a new version comment.
createWatch(User, JiveObject) - Method in interface com.jivesoftware.community.WatchManager
Create a watch on a jive object for the specified user.
CREATION_DATE - Static variable in class com.jivesoftware.community.BanFilter
An integer value that represents the modification date filed.
CREATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
creation_date - Static variable in class com.jivesoftware.community.QuestionFilter.SortField
 
CRONTASK - Static variable in class com.jivesoftware.community.JiveConstants
 
cssUrls - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
cullCache() - Method in class com.jivesoftware.community.cache.DefaultCache
Removes the least recently used elements if the cache size is greater than or equal to the maximum allowed size until the cache is at least 10% empty.
customURLMapperList - Variable in class com.jivesoftware.base.plugin.PluginManager
 

D

databaseKey - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
databaseVersion - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
DAY - Static variable in class com.jivesoftware.community.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.
Decorate - Annotation Type in com.jivesoftware.community.action.util
Should be placed on methods whose result should not be wrapped by the Sitemesh / Clearspace decorator.
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.community.AvatarException
 
DEFAULT_ABUSE_THRESHOLD - Static variable in interface com.jivesoftware.community.AbuseManager
 
DEFAULT_TRACKING_THRESHOLD_DAYS - Static variable in interface com.jivesoftware.community.ReadTracker
Default value used to determine number of days old a thread can be before being marked as read.
DefaultCache - Class in com.jivesoftware.community.cache
Default, non-distributed implementation of the Cache interface.
DefaultCache(String, int, long) - Constructor for class com.jivesoftware.community.cache.DefaultCache
Create a new cache and specify the maximum size of for the cache in bytes, and the maximum lifetime of objects.
DefaultImplementation - Annotation Type in com.jivesoftware.community
Used to specify what the default implementation is on an interface of a JiveManager
delayedLoadExecutor - Variable in class com.jivesoftware.base.plugin.PluginManager
 
delete(User) - Method in interface com.jivesoftware.spi.user.UserProvider
Deletes a user
DELETE_THREADS - Static variable in interface com.jivesoftware.community.ArchiveManager
An archive mode that specifies that threads should be deleted.
deleteAllComments(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Deletes all comments on the object.
deleteAllRatings() - Method in interface com.jivesoftware.community.Document
Deletes all ratings associated with this document.
deleteAllTrackbacks() - Method in interface com.jivesoftware.community.TrackbackManager
Deletes all trackbacks on the object.
deleteAnnouncement(Announcement) - Method in interface com.jivesoftware.community.AnnouncementManager
Deletes an announcement.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.community.Announcement
Deletes an attachment that belongs to the announcement.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.community.AttachmentContentResource
Deletes an attachment that belongs to the object.
deleteAttachment(Attachment) - Method in interface com.jivesoftware.community.PrivateMessage
Deletes an attachment that belongs to this private message.
deleteAvatar(Avatar) - Method in interface com.jivesoftware.community.AvatarManager
Deletes an avatar from the system.
deleteBlog(Blog) - Method in interface com.jivesoftware.community.BlogManager
Permanently deletes a blog and all of the blog postings and comments associated with the blog.
deleteBlogPost(BlogPost) - Method in interface com.jivesoftware.community.Blog
Deletes a blogpost.
deleteComment(JiveObject, Comment) - Method in interface com.jivesoftware.community.CommentManager
Deletes a comment in the object.
deleteComment(JiveObject, Comment, boolean) - Method in interface com.jivesoftware.community.CommentManager
Deletes a comment in the object.
deleteCommunity(Community) - Method in interface com.jivesoftware.community.CommunityManager
Deletes a community.
deleteDocument(Document) - Method in interface com.jivesoftware.community.DocumentManager
Deletes a document.
deleteDocumentElement(DocumentTypeElement) - Method in interface com.jivesoftware.community.DocumentType
Removes the specified DocumentTypeElement from this DocumentType
deleteDocumentElement(DocumentTypeElement) - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Removes the specified DocumentTypeElement from this DocumentType
deleteDocumentField(DocumentField) - Method in interface com.jivesoftware.community.DocumentFieldManager
Deletes a document field.
deleteDocumentFieldType(DocumentFieldType) - Method in interface com.jivesoftware.community.DocumentFieldTypeManager
Deletes an existing DocumentFieldType.
deleteDocumentPresenter() - Method in interface com.jivesoftware.community.DocumentType
Deletes the document presenter associated with the given name within the document type.
deleteDocumentState(DocumentState) - Method in class com.jivesoftware.community.DocumentResultFilter
Deletes a document state from the list of document states that will be filtered upon.
deleteDocumentType(DocumentType) - Method in class com.jivesoftware.community.DocumentResultFilter
Add a document type to the list of document states that will be filtered upon.
deleteDocumentType(DocumentType) - Method in interface com.jivesoftware.community.DocumentTypeManager
Deletes the specified document type from the system.
deleteDocumentVersion(int) - Method in interface com.jivesoftware.community.VersionManager
Delete a document version.
deleteDraft(Draft) - Method in interface com.jivesoftware.community.DraftManager
Delete an existing draft.
deleteExpiredEntries() - Method in class com.jivesoftware.community.cache.DefaultCache
Clears all entries out of cache where the entries are older than the maximum defined age.
deleteFolder(PrivateMessageFolder) - Method in interface com.jivesoftware.community.PrivateMessageManager
Deletes a folder.
deleteGroup(Group) - Method in interface com.jivesoftware.base.GroupManager
Deletes a group from the system.
deleteImage(Image) - Method in interface com.jivesoftware.community.ImageContentResource
Deletes an image that belongs to the object.
deleteJiveProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Deletes a Jive property.
deleteLanguage(String) - Method in class com.jivesoftware.community.DocumentResultFilter
Deletes a language from the list of languages that will be filtered upon.
deleteLocalizedJiveProperty(String, Locale) - Static method in class com.jivesoftware.community.JiveGlobals
Deletes a localized Jive property.
deleteLocalProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Deletes a local property.
deleteMessage(ForumMessage) - Method in interface com.jivesoftware.community.ForumThread
Deletes a message in this thread.
deleteMessage(ForumMessage, boolean) - Method in interface com.jivesoftware.community.ForumThread
Deletes a message in this thread, optionally recusively deleting child messages.
deleteMessage(PrivateMessage) - Method in interface com.jivesoftware.community.PrivateMessageFolder
Deletes a private message from the folder by moving it to the trash folder.
deleteOption(DocumentFieldOption) - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Deletes an option.
deleteOption(int) - Method in interface com.jivesoftware.community.Poll
Remove an option from the poll.
deletePlugin(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
Removes a plugin from the system.
deletePoll(Poll) - Method in interface com.jivesoftware.community.PollManager
Deletes a poll.
deleteProfileByID(long) - Method in interface com.jivesoftware.community.ProfileManager
Removes all user profile data associated with a particular profile field.
deleteProfileByUserID(long) - Method in interface com.jivesoftware.community.ProfileManager
Removes all user profile data associated with a particular user.
deleteProfileField(long) - Method in interface com.jivesoftware.community.ProfileFieldManager
Removes a profile field from the system.
deleteProfileImage(User) - Method in interface com.jivesoftware.community.ProfileManager
Deletes the users profile image
deleteQuestion(Question) - Method in interface com.jivesoftware.community.QuestionManager
Deletes an existing question.
deleteSettings(User) - Method in interface com.jivesoftware.community.WatchManager
Delete the watch settings for a user
deleteStatusLevel(StatusLevel) - Method in interface com.jivesoftware.community.StatusLevelManager
Deletes a statusLevel level from the system
deleteTagSet(TagSet) - Method in interface com.jivesoftware.community.TagSetManager
Deletes the specified TagSet.
deleteThread(ForumThread) - Method in interface com.jivesoftware.community.ForumManager
Deletes a thread and all of its messages.
deleteTrackback(Trackback) - Method in interface com.jivesoftware.community.TrackbackManager
Deletes a trackback on this object.
deleteUser(User) - Method in interface com.jivesoftware.base.UserManager
Deletes a user.
deleteWatch(Watch) - Method in interface com.jivesoftware.community.WatchManager
Delete the specified watch.
deleteWatches(User) - Method in interface com.jivesoftware.community.WatchManager
Deletes all watches that a user has.
DESCENDING - Static variable in class com.jivesoftware.community.BanFilter
Descending sort (ie 3, 2, 1...).
DESCENDING - Static variable in class com.jivesoftware.community.QuestionFilter
Descending sort (ie 3, 2, 1...).
DESCENDING - Static variable in class com.jivesoftware.community.ResultFilter
Descending sort (ie 3, 2, 1...).
description - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
Description - Annotation Type in com.jivesoftware.community.annotations
Annotation used by JiveBeanInfo toolkit to provide a Description to a class.
destroy() - Static method in class com.jivesoftware.base.event.GroupEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.base.event.JivePropertyEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.base.event.UserEventDispatcher
Destroy dispatcher.
destroy() - Method in class com.jivesoftware.base.GroupManagerFactory
 
destroy() - Method in class com.jivesoftware.base.plugin.PluginManager
Shuts down all running plugins.
destroy() - Method in class com.jivesoftware.community.AvatarManagerFactory
 
destroy() - Static method in class com.jivesoftware.community.event.AnnouncementEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.AttachmentEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.BlogEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.BlogPostEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.CommentEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.CommunityEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.DocumentEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.EmailEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.ImageEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.MessageEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.PollEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.ProfileEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.QuestionEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.TagEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.TagSetEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.ThreadEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.TrackbackEventDispatcher
Destroy dispatcher.
destroy() - Method in interface com.jivesoftware.community.importer.ImportSource
Called to destroy the import source.
destroy() - Method in interface com.jivesoftware.community.JiveManager
Notifies the manager to release any resources that may be holding on too.
destroy(JiveApplication.ManagerHandler) - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle
Called to shutdown the application.
destroy() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Destroys the application.
destroy() - Method in class com.jivesoftware.community.PollManagerFactory
 
destroy() - Method in class com.jivesoftware.community.StatusLevelManagerFactory
 
destroy() - Method in class com.jivesoftware.community.TagManagerFactory
 
destroy() - Method in class com.jivesoftware.community.TrackbackManagerFactory
 
destroy() - Method in class com.jivesoftware.community.xmpp.IMManager
 
destroy() - Method in interface com.jivesoftware.spi.ServiceProvider
This method is called to allow services to shutdown/close any open resources and perform any clean up that is needed.
destroyAuthFactory() - Static method in class com.jivesoftware.base.AuthFactory
Method used internally by Jive.
destroyed() - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle.Listener
This method is called when the application has completely shutdown.
destroyPlugin() - Method in interface com.jivesoftware.base.plugin.Plugin
Destroys the plugin.
determinePluginClassLoader(File, Element) - Method in class com.jivesoftware.base.plugin.PluginManager
 
devPlugins - Variable in class com.jivesoftware.base.plugin.PluginManager
 
discardWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Discards the draft WidgetFrames for the specified parent JiveObject.
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(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.community.event.AnnouncementEventDispatcher
 
dispatchEvent(AttachmentEvent) - Method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
dispatchEvent(BlogEvent) - Method in class com.jivesoftware.community.event.BlogEventDispatcher
 
dispatchEvent(BlogPostEvent) - Method in class com.jivesoftware.community.event.BlogPostEventDispatcher
 
dispatchEvent(CommentEvent) - Method in class com.jivesoftware.community.event.CommentEventDispatcher
 
dispatchEvent(CommunityEvent) - Method in class com.jivesoftware.community.event.CommunityEventDispatcher
 
dispatchEvent(DocumentEvent) - Method in class com.jivesoftware.community.event.DocumentEventDispatcher
 
dispatchEvent(EmailEvent) - Method in class com.jivesoftware.community.event.EmailEventDispatcher
 
dispatchEvent(ImageEvent) - Method in class com.jivesoftware.community.event.ImageEventDispatcher
 
dispatchEvent(MessageEvent) - Method in class com.jivesoftware.community.event.MessageEventDispatcher
 
dispatchEvent(PollEvent) - Method in class com.jivesoftware.community.event.PollEventDispatcher
Dispatches an event to all listeners.
dispatchEvent(PrivateMessageEvent) - Method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
 
dispatchEvent(ProfileEvent) - Method in class com.jivesoftware.community.event.ProfileEventDispatcher
 
dispatchEvent(ProfileSearchIndexEvent) - Method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
 
dispatchEvent(QuestionEvent) - Method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
dispatchEvent(SearchIndexEvent) - Method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
 
dispatchEvent(StorageManagerEvent) - Method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
 
dispatchEvent(TagEvent) - Method in class com.jivesoftware.community.event.TagEventDispatcher
 
dispatchEvent(TagSetEvent) - Method in class com.jivesoftware.community.event.TagSetEventDispatcher
 
dispatchEvent(JiveEvent) - Method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
dispatchEvent(TrackbackEvent) - Method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
dispatchEvent(ServiceEvent<T, O>) - Method in class com.jivesoftware.spi.ServiceEventDispatcher
Send events to registered listeners.
doCancel() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
Document - Interface in com.jivesoftware.community
A Document object encapsulates a document in Clearspace.
DOCUMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_ADDED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is added to a community.
DOCUMENT_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a document is added to the search index.
DOCUMENT_BACKCHANNEL - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_BODY - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_DELETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a document is removed from the search index.
DOCUMENT_DELETING - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is deleted from a community.
DOCUMENT_EXPIRE_WARNING - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is about to expire.
DOCUMENT_EXPIRED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document expires.
DOCUMENT_FIELD - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_FIELD_OPTION - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_FIELD_TYPE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_ID - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_MODIFIED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is modified.
DOCUMENT_MOVED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is moved.
DOCUMENT_PRESENTER - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_RATED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is rated.
DOCUMENT_RELATED_DOCUMENT_ADDED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a related document is added to a document.
DOCUMENT_RELATED_DOCUMENT_DELETED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a related document is deleted from a document.
DOCUMENT_STATE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TITLE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TYPE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TYPE_ELEMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_UNDELETED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is un-deleted from a community.
DOCUMENT_VERSION - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_VERSION_COMMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_VIEWED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for when a document is marked as viewed
documentAdded(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is added.
documentAdded(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a document is added to the index.
documentAdded(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentAlreadyExistsException - Exception in com.jivesoftware.community
Thrown whenever a Document's title is set to be the same as a title to an existing published document.
DocumentAlreadyExistsException() - Constructor for exception com.jivesoftware.community.DocumentAlreadyExistsException
 
DocumentAlreadyExistsException(String) - Constructor for exception com.jivesoftware.community.DocumentAlreadyExistsException
 
DocumentAlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.community.DocumentAlreadyExistsException
 
DocumentAlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.community.DocumentAlreadyExistsException
 
DocumentAttributes - Interface in com.jivesoftware.community
Attributes for documents -- recommendation status and published status.
documentDeleted(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is deleted.
documentDeleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a document is deleted from the search index.
documentDeleted(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentEvent - Class in com.jivesoftware.community.event
A class for Document events.
DocumentEvent(int, Document, Community, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.DocumentEvent
 
DocumentEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for DocumentEvents.
documentExpired(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document expires.
documentExpired(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
documentExpireWarning(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is about to expire.
documentExpireWarning(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentField - Interface in com.jivesoftware.community
The DocumentType interface allows for an arbitrary number of document fields to be created for each document type.
DocumentFieldAttributes - Interface in com.jivesoftware.community
Document field attributes consist of properties which control how the field is used throughout the system.
DocumentFieldFormatter - Interface in com.jivesoftware.community
Document field formatters format a document field for display to the end user.
DocumentFieldManager - Interface in com.jivesoftware.community
Manages the creation and deletion of document fields in Clearspace.
DocumentFieldOption - Interface in com.jivesoftware.community
Container object for document field options.
DocumentFieldType - Interface in com.jivesoftware.community
Type information that can be associated with a DocumentField.
DocumentFieldType.DataType - Enum in com.jivesoftware.community
Represents the XMPP data form field type.
DocumentFieldTypeManager - Interface in com.jivesoftware.community
Manages the creation and deletion of Document Field Types for Clearspace.
DocumentFieldValidator - Interface in com.jivesoftware.community
Document field validators validate a document field value as entered or selected by the end user.
DocumentFieldValue - Class in com.jivesoftware.community
Bean holder for document field values.
DocumentFieldValue(long) - Constructor for class com.jivesoftware.community.DocumentFieldValue
 
DocumentListener - Interface in com.jivesoftware.community.event
A DocumentListener gets notified anytime a document event is fired.
DocumentManager - Interface in com.jivesoftware.community
This manager provides methods to load documents and to retrieve popular documents.
documentModified(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is modified.
documentModified(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
documentMoved(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is moved.
documentMoved(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentObjectNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Document was not found
DocumentObjectNotFoundException(int, long) - Constructor for exception com.jivesoftware.community.DocumentObjectNotFoundException
 
DocumentObjectNotFoundException(int, long, String) - Constructor for exception com.jivesoftware.community.DocumentObjectNotFoundException
 
DocumentObjectNotFoundException(int, long, Throwable) - Constructor for exception com.jivesoftware.community.DocumentObjectNotFoundException
 
DocumentObjectNotFoundException(int, long, String, Throwable) - Constructor for exception com.jivesoftware.community.DocumentObjectNotFoundException
 
DocumentObjectNotFoundException(String) - Constructor for exception com.jivesoftware.community.DocumentObjectNotFoundException
 
DocumentPresenter - Interface in com.jivesoftware.community
Similar to the DocumentBuilder interface, document presenters allow for organizing the fields of a document type into an optimal layout for display.
documentRated(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is rated.
documentRated(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
documentRelatedObjectAdded(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a related document is added to a document.
documentRelatedObjectAdded(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
documentRelatedObjectDeleted(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a related document is deleted from a document.
documentRelatedObjectDeleted(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentResultFilter - Class in com.jivesoftware.community
Filters and sorts lists of Documents.
DocumentResultFilter() - Constructor for class com.jivesoftware.community.DocumentResultFilter
 
DocumentSearchQueryCriteria - Interface in com.jivesoftware.community
Search criteria specific to searching documents may be specified using this criteria class.
DocumentSearchQueryCriteria.DocumentSortType - Enum in com.jivesoftware.community
Represents how document search queries will be sorted
DocumentState - Enum in com.jivesoftware.community
Throughout the document lifecycle a document will have different documents states appropriate to where it is along the lifecycle.
DocumentType - Interface in com.jivesoftware.community
The DocumentType interface provides structure to Documents by defining the fields that make up a document and the creators and presenters to use to create and display it.
DocumentTypeElement - Interface in com.jivesoftware.community
This class gives the DocumentType the ability to handle kinds entities (DocumentFields, document, and summaries).
DocumentTypeElement.Type - Enum in com.jivesoftware.community
Simple enumerated type for Document elements.
DocumentTypeLabelElement - Interface in com.jivesoftware.community
Used to specify labels in the DocumentCreation process
DocumentTypeManager - Interface in com.jivesoftware.community
Handles the creation, deletion, and access of DocumentTypes.
DocumentTypeSectionElement - Interface in com.jivesoftware.community
Used to specify a Section of Elements in the Document creation process.
DocumentTypeValidator - Interface in com.jivesoftware.community
A document type validator is useful to validate document input when there are interdepencies between multiple document fields.
documentUndeleted(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is un-deleted in the admin console.
documentUndeleted(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
DocumentVersion - Interface in com.jivesoftware.community
Information about a document's version is stored and retrieved using this interface.
documentViewed(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is marked as read.
documentViewed(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
doDestroy() - Static method in class com.jivesoftware.base.GroupManagerFactory
Method used internally by Jive.
doDestroy() - Static method in class com.jivesoftware.base.UserManagerFactory
Method used internally by Jive.
doInitialization() - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle.Listener
Called by the initialization code after all Jive managers are initialized but prior to clustering and the task engine being started.
doInitialize() - Static method in class com.jivesoftware.base.GroupManagerFactory
 
doInitialize() - Static method in class com.jivesoftware.base.UserManagerFactory
Initializes the UserManagerFactory: creates internal cache structures, (optionally) loads up a custom user manager if the UserManager.className jiveProperty has been set or by default loads a DbUserManager.
doInitialize() - Static method in class com.jivesoftware.community.AvatarManagerFactory
 
doInitialize() - Static method in class com.jivesoftware.community.PollManagerFactory
 
doInitialize() - Static method in class com.jivesoftware.community.renderer.RendererFactory
 
doInitialize() - Static method in class com.jivesoftware.community.StatusLevelManagerFactory
 
doInitialize() - Static method in class com.jivesoftware.community.TagManagerFactory
 
doInitialize() - Static method in class com.jivesoftware.community.TrackbackManagerFactory
 
doInput() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
Draft - Interface in com.jivesoftware.community
A container for a draft of a message of any type.
DRAFT - Static variable in class com.jivesoftware.community.JiveConstants
 
DraftManager - Interface in com.jivesoftware.community
Manages the draft features of Clearspace.
DuplicateIDException - Exception in com.jivesoftware.community
Thrown when attempting to set a document ID for a Document that already exists and is associated with a different document than the current document.
DuplicateIDException() - Constructor for exception com.jivesoftware.community.DuplicateIDException
 
DuplicateIDException(String) - Constructor for exception com.jivesoftware.community.DuplicateIDException
 
DuplicateIDException(String, Throwable) - Constructor for exception com.jivesoftware.community.DuplicateIDException
 
DuplicateIDException(Throwable) - Constructor for exception com.jivesoftware.community.DuplicateIDException
 

E

EDIT_AVATAR - Static variable in class com.jivesoftware.community.Permissions
Permission to create and delete avatars
editAndApprove(AuthToken, ForumMessage, String, String, String) - Method in interface com.jivesoftware.community.ModerationManager
Edit and approve a moderated message
editProfileField(ProfileField) - Method in interface com.jivesoftware.community.ProfileFieldManager
Edits the profile field data.
editProfileFieldOptions(ProfileField) - Method in interface com.jivesoftware.community.ProfileFieldManager
Edits the ProfileFieldOption objects for a profile field.
EMAIL_RECEIVED - Static variable in class com.jivesoftware.community.event.EmailEvent
An email was received.
EMAIL_SENDING - Static variable in class com.jivesoftware.community.event.EmailEvent
An email is about to be sent.
EMAIL_WATCH - Static variable in interface com.jivesoftware.community.Watch
Email watch type.
EmailEvent - Class in com.jivesoftware.community.event
A class for EmailEvent events.
EmailEvent(int, Message, EmailMessage, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.EmailEvent
Creates a new email event.
EmailEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for EmailEvents.
EmailManager - Interface in com.jivesoftware.community
Provides ability to send email messages.
EmailMessage - Class in com.jivesoftware.community
Represents an Email message that can be sent using EmailManager
EmailMessage() - Constructor for class com.jivesoftware.community.EmailMessage
 
EmailMessage.EmailAddress - Class in com.jivesoftware.community
Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com>
EmailMessage.EmailAddress(String, String) - Constructor for class com.jivesoftware.community.EmailMessage.EmailAddress
 
EmailTokenManager - Interface in com.jivesoftware.community.mail
Manages email tokens.
EnableByDefault - Annotation Type in com.jivesoftware.community.renderer.annotations
Used by a macro to set whether it is enabled or disabled by default.
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.
EntityDescriptor - Class in com.jivesoftware.community
An object that describes a specific entity.
EntityDescriptor() - Constructor for class com.jivesoftware.community.EntityDescriptor
No args constructor for serialization
EntityDescriptor(int, long) - Constructor for class com.jivesoftware.community.EntityDescriptor
Creates a new descripter given an ID and type.
EntityDescriptor(JiveObject) - Constructor for class com.jivesoftware.community.EntityDescriptor
Creates an EntityDescriptor instance from an existing JiveObject.
entrySet() - Method in class com.jivesoftware.community.cache.DefaultCache
 
equals(Object) - Method in class com.jivesoftware.community.ApprovalStatus
 
equals(Object) - Method in class com.jivesoftware.community.Ban
 
equals(Object) - Method in class com.jivesoftware.community.BanFilter
 
equals(Object) - Method in class com.jivesoftware.community.BanManagerFactory.BanCacheKey
 
equals(Object) - Method in class com.jivesoftware.community.DocumentFieldValue
 
equals(Object) - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
equals(Object) - Method in class com.jivesoftware.community.EmailMessage
 
equals(Object) - Method in class com.jivesoftware.community.EntityDescriptor
 
equals(Object) - Method in class com.jivesoftware.community.PermissionType
 
equals(Object) - Method in class com.jivesoftware.community.ProfileField
 
equals(Object) - Method in class com.jivesoftware.community.ProfileFieldValue
 
equals(Object) - Method in class com.jivesoftware.community.QuestionFilter
 
equals(Rating) - Method in interface com.jivesoftware.community.Rating
Test for equality between two rating objects.
equals(SearchQuery) - Method in interface com.jivesoftware.community.SearchQuery
Return true if the query is equal to the current query, false otherwise.
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.community.ResultFilter
Exact match.
exclude(long) - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
execute() - Method in class com.jivesoftware.community.action.JiveActionSupport
Default implementation of doExecute() method.
execute(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
execute(String, RenderContext) - Method in interface com.jivesoftware.community.renderer.RenderFilter
Applies the filter to the passed in string and returns the filtered string.
execute(String, RenderContext) - Method in interface com.jivesoftware.community.renderer.RenderMacro
Executes the render macro against the provided string and render context.
executeHtmlTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_HTML.
executeNoMarkupTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_NO_MARKUP.
executePlainEmailTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_EMAIL.
executePlainTextTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_PLAIN_TEXT.
executeWysiwygEditorTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_WYSIWYG_EDITOR.
executeXMLTarget(String, RenderContext) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
This method is called to execute the filter when the render target specified in the context is RenderTarget.TARGET_XML.
executor - Variable in class com.jivesoftware.base.plugin.PluginManager
 
exists(String) - Method in interface com.jivesoftware.spi.user.UserProvider
Returns true if a user exitst whose username matches.
exists(UserTemplate) - Method in interface com.jivesoftware.spi.user.UserProvider
Returns true if the user that matches the template exists
EXPIRATION_DATE - Static variable in class com.jivesoftware.community.BanFilter
An integer value that represents the creation date filed.
EXPIRATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
EXPLICIT_CONTENT - Static variable in class com.jivesoftware.community.AbuseType
Type representing an explicit content abuse report.
EXTENDED_PROPERTY - Static variable in class com.jivesoftware.community.JiveConstants
 
extended_property - Static variable in class com.jivesoftware.community.QuestionFilter.SortField
 

F

failedLoading - Static variable in class com.jivesoftware.community.JiveGlobals
Indicates loading a reference to the jiveHome directory failed.
FATAL_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent
Event type for whenever a fatal log event occurs.
FeedbackResultFilter - Class in com.jivesoftware.community
Filters and sorts blog comments and blog trackbacks.
FeedbackResultFilter() - Constructor for class com.jivesoftware.community.FeedbackResultFilter
 
FILE_NOT_ACCEPTED - Static variable in exception com.jivesoftware.community.AvatarException
 
FILE_SYSTEM_CACHE_MODE_CHANGED - Static variable in class com.jivesoftware.community.event.StorageManagerEvent
Event type for whenever the storage fs cache mode is changed.
FILE_SYSTEM_CACHE_SIZE_CHANGED - Static variable in class com.jivesoftware.community.event.StorageManagerEvent
Event type for whenever the storage fs cache size is changed.
fileSystemCacheModeChanged(StorageManagerEvent) - Method in interface com.jivesoftware.community.event.StorageManagerListener
Fired when the storage file system cache mode is changed.
fileSystemCacheSizeChanged(StorageManagerEvent) - Method in interface com.jivesoftware.community.event.StorageManagerListener
Fired when the storage file system cache size is changed.
filterOnBlog(Blog) - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Restricts the query results to posts posted in a specific blog.
filterOnUser(User) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Restricts the query results to content objects created 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
 
fireMapEvent(MapEvent, int) - Method in class com.jivesoftware.community.cache.DefaultCache
 
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.community.PrivateMessageFolder
 
FOLDER_INBOX - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
FOLDER_SENT - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
FOLDER_TRASH - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
forceReload() - Static method in class com.jivesoftware.base.AuthFactory
 
format(String, User) - Method in interface com.jivesoftware.community.DocumentFieldFormatter
Format a document field for display to the end user with the given AuthToken.
format(String, User) - Method in interface com.jivesoftware.community.field.formatter.ProfileFieldFormatter
Format a profile field for display to the end user with the given AuthToken.
format8601Date(Date) - Static method in class com.jivesoftware.community.util.BlogUtils
 
formatDate(Date) - Static method in class com.jivesoftware.community.JiveGlobals
Formats a Date object and returns a formatted String.
formatDateTime(Date) - Static method in class com.jivesoftware.community.JiveGlobals
Formats a Date object to return a date and time using the global locale.
ForumManager - Interface in com.jivesoftware.community
This manager provides methods to load forum threads, user messages and to retrieve popular forum threads.
ForumMessage - Interface in com.jivesoftware.community
A ForumMessage encapsulates message data.
ForumMessageNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified ForumMessage was not found
ForumMessageNotFoundException() - Constructor for exception com.jivesoftware.community.ForumMessageNotFoundException
 
ForumMessageNotFoundException(String) - Constructor for exception com.jivesoftware.community.ForumMessageNotFoundException
 
ForumThread - Interface in com.jivesoftware.community
A ForumThread is a container for a hierarchy of ForumMessages.
ForumThreadNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified ForumThread was not found
ForumThreadNotFoundException() - Constructor for exception com.jivesoftware.community.ForumThreadNotFoundException
 
ForumThreadNotFoundException(String) - Constructor for exception com.jivesoftware.community.ForumThreadNotFoundException
 

G

GATEWAY - Static variable in class com.jivesoftware.community.JiveConstants
 
GENERAL - Static variable in class com.jivesoftware.community.AbuseType
Type representing a general abuse report.
GENERAL_ERROR - Static variable in exception com.jivesoftware.community.AttachmentException
 
GENERAL_ERROR - Static variable in exception com.jivesoftware.community.BinaryBodyException
 
GENERAL_ERROR - Static variable in exception com.jivesoftware.community.ImageException
 
get(Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
getAbuse() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of abuse import beans corresponding to the aubse reports to be imported
getAbuseCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of abuse reports to be imported
getAbuseManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an abuse manager that can be used for managing abuse reports
getAbuseReports(ForumMessage) - Method in interface com.jivesoftware.community.AbuseManager
Gets a list of open abuse reports for a particular message
getAbuseReports(User) - Method in interface com.jivesoftware.community.AbuseManager
Gets a list of open abuse reports from a particular user
getAbuseThreshold() - Method in interface com.jivesoftware.community.AbuseManager
Gets the number of abuse reports needed to automatically hide a message.
getAbuseType() - Method in class com.jivesoftware.community.AbuseReport
Gets the AbuseType for this abuse report.
getAbuseType(int) - Static method in class com.jivesoftware.community.AbuseType
A helper method to get a specific AbuseType object from its key
getActiveAvatar(User) - Method in interface com.jivesoftware.community.AvatarManager
Returns an avatar for a user, else the SystemDefaultAvatar if the user does not have an active avatar specified.
getActivePollCount() - Method in interface com.jivesoftware.community.PollManager
Returns a count of all active polls in the system.
getActivePollCount(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns a count of all active polls of a given type and object ID.
getActivePolls() - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of active polls in the system.
getActivePolls(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of active polls associated with the object specified by the objectType and objectID.
getActivityManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the activity manager.
getAdminID() - Method in class com.jivesoftware.community.Ban
Gets the admin user that created this ban object.
getAdminID() - Method in class com.jivesoftware.community.BanFilter
Gets the currently selected admin ID that bans will be filtered on.
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.community.SearchQueryCriteria
Returns the earliest date for search results.
getAIMIMService() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getAllowedTypes() - Method in interface com.jivesoftware.community.AttachmentManager
Returns a List of explicitly allowed types.
getAllowedTypes() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns a list of explicitly allowed types.
getAllowedTypes() - Method in interface com.jivesoftware.community.ImageManager
Returns a list of explicitly allowed types.
getAllowedTypesAsFileExtensions() - Method in interface com.jivesoftware.community.AttachmentManager
Returns a list of explicitly allowed file types by extensions.
getAllowedTypesAsFileExtensions() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns a list of explicitly allowed file types by extensions.
getAllPointLevels(User) - Method in interface com.jivesoftware.community.StatusLevelCalculator
Returns the status level points for a user for all communities the user has points in
getAllPointLevels(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns a map of community -> status level points for all the communities the user has points in.
getAllStatusLevelScenarios() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns all of the StatusLevelScenario objects.
getAllWatches(User, int) - Method in interface com.jivesoftware.community.WatchManager
Returns an iterable for all objects of a particular type that a user is watching.
getAllWatches(User) - Method in interface com.jivesoftware.community.WatchManager
Returns an iterable for all objects that a user is watching.
getAnnouncement(long) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns an announcement by announcement ID.
getAnnouncementCount(Object) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the count of all currently viewable announcements in a container.
getAnnouncementCount(Object, boolean) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the count of all currently viewable announcements in a container.
getAnnouncementCount(Object, Date, Date) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the count of all announcements in a container that are viewable within the specified date range.
getAnnouncementCount(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of announcements to be imported in the given community
getAnnouncementManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an announcement manager, which is used to create and retrieve announcements.
getAnnouncements(Object) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns all currently viewable announcements in a container.
getAnnouncements(Object, Date, Date) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the announcements in a container that are viewable within a specified date range.
getAnnouncements(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of announcement import beans corresponding to annnouncements in the given parent community
getAnnouncment() - Method in class com.jivesoftware.community.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.community.Poll
Returns a count of all guests user votes for all options in the poll.
getAnonymousVoteCount(int) - Method in interface com.jivesoftware.community.Poll
Returns a count of all user votes for the specified option in the poll.
getAnonymousVotes() - Method in interface com.jivesoftware.community.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.community.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.community.Poll
Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.
getApplicationLifeCycle() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Method used internally by Jive to retrieve the ApplicationLifeCycle.
getApprovalStatus() - Method in interface com.jivesoftware.community.Document
Returns a collection of ApprovalStatus objects.
getApprovedDate() - Method in class com.jivesoftware.community.ApprovalStatus
If the document is approved it will return the date the user approved it, else null will be returned.
getApproverCount() - Method in interface com.jivesoftware.community.Document
Returns a count of all of the users that must approve this document before it reaches a PUBLISHED state when it is in a PENDING_APPROVAL state.
getApprovers() - Method in interface com.jivesoftware.community.Document
Returns all of the users that must approve this document before it reaches a PUBLISHED state when it is in a PENDING_APPROVAL state.
getArchiveCommunity(Community) - Method in interface com.jivesoftware.community.ArchiveManager
Returns the "archive community" for the specified community.
getArchiveDays(Community) - Method in interface com.jivesoftware.community.ArchiveManager
Returns the number of days that threads in community must be inactive before being archived.
getArchiveManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an archive manager that can be used to manage archiving for communities.
getArchiveMode(Community) - Method in interface com.jivesoftware.community.ArchiveManager
Returns the archive mode for the community.
getAttachment(long) - Method in interface com.jivesoftware.community.AttachmentContentResource
Returns the attachment corresponding to the attachmentID.
getAttachment() - Method in interface com.jivesoftware.community.Avatar
Returns the attachment for this avatar
getAttachment() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getAttachmentCount() - Method in interface com.jivesoftware.community.Announcement
Returns the number of attachments the announcement has.
getAttachmentCount() - Method in interface com.jivesoftware.community.AttachmentContentResource
Returns the number of attachments the object has.
getAttachmentCount(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of attachments to be imported
getAttachmentCount() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the number of attachments this private message has.
getAttachmentDirectorySize() - Method in interface com.jivesoftware.community.StorageManager
Returns the size (in bytes) of the attachment directory on the file system.
getAttachmentManager() - Method in interface com.jivesoftware.community.DocumentType
Returns an attachment manager that can be used to manage attachment settings for the document type.
getAttachmentManager() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getAttachmentManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an attachment manager that can be used to manage attachment rules.
getAttachmentName() - Method in exception com.jivesoftware.community.AttachmentException
 
getAttachments() - Method in interface com.jivesoftware.community.Announcement
Returns an Iterable for all the attachments of the message.
getAttachments() - Method in interface com.jivesoftware.community.AttachmentContentResource
Returns an Iterable for the object's attachments.
getAttachments() - Method in class com.jivesoftware.community.EmailMessage
Returns the attachments of the email
getAttachments(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of attachment import beans corresponding to the attachments for the given ID
getAttachments() - Method in interface com.jivesoftware.community.PrivateMessage
Returns an Iterable for all attachments of this private message.
getAttributes() - Method in interface com.jivesoftware.community.DocumentField
Retrieve the document attributes for the document field.
getAuthenticatedCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getAuthenticationProvider() - Method in class com.jivesoftware.base.AuthFactory
 
getAuthor() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getAuthor() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the user that authored the document version.
getAuthor() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The author of the result (will be displayed on the view).
getAuthor() - Method in interface com.jivesoftware.community.VersionComment
Returns the author of the comment.
getAuthorCommentDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a comment manager to manage document author comments.
getAuthorCount() - Method in interface com.jivesoftware.community.Document
Returns the count of authors.
getAuthorFeedURL(Blog, User) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the author feed for a specific blog / author combination.
getAuthorPermalink(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a author permalink for a blog which is a combination of the base URL, the blog display name and the word 'authors'.
getAuthorPermalink(Blog, User) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a author permalink for a blog and author which is a combination of the base URL, the blog display name and the word 'authors' and the authors username.
getAuthors() - Method in interface com.jivesoftware.community.Document
Returns the Users who are allowed to edit the document.
getAuthorshipPolicy() - Method in interface com.jivesoftware.community.Document
Returns the authorship policy of this document, one of AUTHORSHIP_OPEN, AUTHORSHIP_SINGLE, or AUTHORSHIP_MULTIPLE.
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.
getAuthToken() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getAuthToken() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the current page user's auth token
getAutoArchiveInterval() - Method in interface com.jivesoftware.community.ArchiveManager
Returns the inverval between auto archive executions (in hours).
getAutoIndexInterval() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the number of minutes that the indexer waits between each update.
getAutoIndexInterval() - Method in interface com.jivesoftware.community.SearchManager
Returns the number of minutes that the indexer waits between each update.
getAutosaveInterval() - Method in interface com.jivesoftware.community.DraftManager
Returns the setting for the number of seconds between autosave invocations when autosave is enabled for a text field.
getAvailableInterceptors() - Method in interface com.jivesoftware.community.InterceptorManager
Returns an array of JiveInterceptor objects that are all of the currently available incerceptors in the system.
getAvailableRatingCount() - Method in interface com.jivesoftware.community.RatingManager
Returns the count of currently available ratings.
getAvailableRatings() - Method in interface com.jivesoftware.community.RatingManager
Returns an iterable of Rating objects that list all the available ratings.
getAvailableWidgets() - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns a list of all available Widgets in the system
getAvatar(long) - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire an avatar by its id
getAvatarCount(User) - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire a count of all the avatars for a specific user
getAvatarCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of avatars to be imported
getAvatarManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a AvatarManager that can be used to find, create, delete, and make avatars active
getAvatars(User) - Method in interface com.jivesoftware.community.AvatarManager
Returns a collection of avatars for a user
getAvatars() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of avatar import beans corresponding to the avatars to be imported
getBan() - Method in exception com.jivesoftware.community.BanException
Gets the ban object that caused this BanException to be thrown.
getBan(long) - Method in interface com.jivesoftware.community.BanManager
Gets a Ban Object from the database.
getBan(long, BanLevel) - Method in interface com.jivesoftware.community.BanManager
Gets a Ban Object from the database.
getBan(String, BanLevel) - Method in interface com.jivesoftware.community.BanManager
Gets a Ban Object from the database.
getBanCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of bans to be imported
getBanLevel() - Method in class com.jivesoftware.community.Ban
Gets the BanLevel for this ban.
getBanLevel() - Method in class com.jivesoftware.community.BanFilter
Gets the currently selected BanLevel that bans will be filtered on.
getBanLevel(int) - Static method in class com.jivesoftware.community.BanLevel
A helper method to get a specific BanLevel object from its key
getBanLock(long) - Static method in class com.jivesoftware.community.BanManagerFactory
 
getBanManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a ban manager that can be used for banning users
getBannedUserID() - Method in class com.jivesoftware.community.Ban
Gets the banned user id.
getBannedUserID() - Method in class com.jivesoftware.community.BanFilter
Returns the ID of the user that bans will be filtered on.
getBans() - Method in interface com.jivesoftware.community.BanManager
Gets an unfiltered list of Ban objects from database
getBans(BanFilter) - Method in interface com.jivesoftware.community.BanManager
Gets a filtered list of Ban objects from the database
getBans() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of ban import beans corresponding to the bans to be imported
getBanType() - Method in class com.jivesoftware.community.Ban
Returns BanManager.TYPE_BAN_USER for a user ban or BanManager.TYPE_BAN_IP for an IP address ban.
getBanType() - Method in class com.jivesoftware.community.BanFilter
Gets the currently selected ban type.
getBaseCommunities() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of community import beans corresponding to the first child level of communities beneath the root level community.
getBeforeDate() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the latest date for search results.
getBinaryBody() - Method in interface com.jivesoftware.community.Document
Returns the binary body of the document.
getBinaryBodyByID(long) - Method in interface com.jivesoftware.community.BinaryBodyManager
Retrieve a binary body by its ID.
getBinaryBodyContentType(int) - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the binary body content type at the specified index.
getBinaryBodyContentTypeCount() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the count of the content types that will be used to filter binary documents
getBinaryBodyDirectorySize() - Method in interface com.jivesoftware.community.StorageManager
Returns the size (in bytes) of the documentbody directory on the file system.
getBinaryBodyManager() - Method in interface com.jivesoftware.community.DocumentType
Returns a binary body manager that can be used to manage binary document body settings.
getBinaryBodyManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a binary document manager that can be used to manage binary body rules.
getBinaryBodyMode() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the mode that will be used to select results if binary body content types have been specified.
getBlog(long) - Method in interface com.jivesoftware.community.BlogManager
Returns a blog by blog ID.
getBlog(String) - Method in interface com.jivesoftware.community.BlogManager
Returns a blog by blog display name.
getBlog() - Method in interface com.jivesoftware.community.BlogPost
Returns the blog this post belongs to.
getBlog() - Method in class com.jivesoftware.community.event.BlogEvent
Returns the blog that the event corresponds to.
getBlogCommentFeedURL() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to a feed which contains recent comments across the entire system.
getBlogCount() - Method in interface com.jivesoftware.community.BlogManager
Returns the total number of blogs on this system.
getBlogCount(BlogResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the total number of blogs on this system that match the criteria specified by the ResultFilter.
getBlogCount() - Method in interface com.jivesoftware.community.Community
Returns the number of blogs associated with this community.
getBlogFeedURL() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to a feed which contains newly created blogs across the entire system.
getBlogID() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns the blogID that results will be filtered on.
getBlogManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a blog manager that can be used to manage blogs
getBlogPost(long) - Method in interface com.jivesoftware.community.Blog
Returns a blogpost by blogpost ID.
getBlogPost(String, int, int, int) - Method in interface com.jivesoftware.community.Blog
Returns a blog post for a given permalink and year/month/day combination, where the permalink is the subject turned into a string value suitable to be a directory name.
getBlogPost(long) - Method in interface com.jivesoftware.community.BlogManager
Returns the BlogPost specified by the blog post ID.
getBlogPost() - Method in class com.jivesoftware.community.event.BlogPostEvent
Returns the post that the event corresponds to.
getBlogPostCount() - Method in interface com.jivesoftware.community.Blog
Returns the number of blog posts on this blog, by default only includes blog posts where status = BlogPost.STATUS_PUBLISH and publish date less than now().
getBlogPostCount(BlogPostResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns the number of blog posts on this blog The default blog post result filter (BlogPostResultFilter.createDefaultFilter()) only includes blog posts where status = BlogPost.STATUS_PUBLISH and publish date less than now().
getBlogPostCount() - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts on the system, by default only includes blog posts where status = BlogPost.STATUS_PUBLISH and publish date less than now().
getBlogPostCount(BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts on the system.
getBlogPostCount() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of blog posts in all blogs associated with the community based sorted by descending publish date.
getBlogPostCount(BlogPostResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of blog posts in all blogs associated with the community based on the specified ResultFilter.
getBlogPosts(BlogPostResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all the blog posts that match the criteria specified by the BlogPostResultFilter on a specific blog.
getBlogPosts(BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all the blog posts that match the criteria specified by the BlogPostResultFilter on the entire system.
getBlogPosts() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns all BlogPosts in all Blogs associated with this Community sorted by descending publish date.
getBlogPosts(BlogPostResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns all BlogPosts in all Blogs associated with this Community based on the specified ResultFilter.
getBlogPostSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the BlogPostSearchQueryCriteria that can be used to specify criteria to sort and/or filter blog post search results.
getBlogPostSortType(int) - Static method in enum com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType
A helper method to get a specific BlogSortType object from its key
getBlogs(BlogResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all the blogs on this system that match the criteria specified by the ResultFilter.
getBlogs(User) - Method in interface com.jivesoftware.community.BlogManager
Returns all blogs which are associated with the given user.
getBlogs() - Method in interface com.jivesoftware.community.Community
Returns all Blogs associated with this community.
getBlogsByDisplayName(String, int, int, int) - Method in interface com.jivesoftware.community.BlogManager
Returns all the blogs on this system whose display name is LIKE the given query.
getBlogsCount(User) - Method in interface com.jivesoftware.community.BlogManager
Returns the count of all blogs which are associated with the given user.
getBlogTrackbackFeedURL() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to a feed which contains recent trackbacks across the entire system.
getBlogURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the URL for the blog which is a combination of the base URL and the blog display name.
getBody() - Method in interface com.jivesoftware.community.Announcement
Returns the announcement body.
getBody() - Method in interface com.jivesoftware.community.BlogPost
Returns the post body.
getBody() - Method in interface com.jivesoftware.community.Comment
Returns the comment body.
getBody() - Method in interface com.jivesoftware.community.Document
Returns the textual body of the document.
getBody() - Method in interface com.jivesoftware.community.Draft
Returns the body of the draft.
getBody() - Method in interface com.jivesoftware.community.ForumMessage
Returns the message body.
getBody() - Method in interface com.jivesoftware.community.JiveContentObject
Return a summary of the jive object content.
getBody() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message body.
getBranchedParentThreadID() - Method in interface com.jivesoftware.community.ForumThread
Returns the ID of the thread this was branched from, if any, else null.
getBranchedThreadID() - Method in interface com.jivesoftware.community.ForumThread
Returns the ID of a brached thread, or null if no thread is branched from this one.
getBuildProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a build-level property.
getBuiltinTypes() - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns a list of all the builtin types
getCachedSize() - Method in class com.jivesoftware.community.Ban
 
getCachedSize() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getCachedSize() - Method in enum com.jivesoftware.community.DocumentState
 
getCachedSize() - Method in class com.jivesoftware.community.EntityDescriptor
 
getCachedSize() - Method in class com.jivesoftware.community.Permissions
 
getCachedSize() - Method in class com.jivesoftware.community.ProfileField
Returns the esitmated cache size of this obejct by calculating the size of each field.
getCachedSize() - Method in class com.jivesoftware.community.ProfileFieldOption
Returns the esitmated cache size of this obejct by calculating the size of each field.
getCachedSize() - Method in class com.jivesoftware.community.ProfileFieldValue
Returns the estimated cache size for this object.
getCacheHits() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getCacheKey(JiveObject) - Static method in class com.jivesoftware.community.TagManagerFactory
Returns a tag content cache key.
getCacheMisses() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getCacheSize() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getCalculator() - Static method in class com.jivesoftware.community.StatusLevelManagerFactory
Used to acquire the StatusLevelCalculator, this should only be called by implementations of StatusLevelManager that delegate to a StatusLevelCalculator
getCallback() - Method in interface com.jivesoftware.community.importer.Importer
Returns a callback if one is waiting or null if no callback is waiting for user input.
getCharacterEncoding() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the character set that Jive uses for encoding.
getChild(Comment, int) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the child of parent at index index in the parent's child array.
getChild(ForumMessage, int) - Method in interface com.jivesoftware.community.TreeWalker
Returns the child of parent at index index in the parent's child array.
getChildCount(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the number of children of parent.
getChildCount(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the number of children of parent.
getChildren(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns an Iterable for all the child messages of the parent.
getChildrenNames(K) - Method in interface com.jivesoftware.community.JiveProperties
Return all children property names of a parent property as a Collection of String objects.
getClassLoader() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getClassLoaders() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a collection of all plugin classloaders.
getClearspaceComponent() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getCode() - Method in class com.jivesoftware.community.Question.State
Returns the integer code associated with the state.
getCombinedContent(ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all threads, documents, and blog posts in the community, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContent(ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all threads, documents, and blog posts in the community, depending on which ContentRetrieval.ContentTypes are supplied as an argument, and according the the supplied ResultFilter.
getCombinedContentCount(ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the combined number of threads, documents, and blog posts in the community, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContentCount(ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the combined number of threads, documents, and blog posts in the community, depending on which ContentRetrieval.ContentTypes are supplied as an argument, and restricted by the ResultFilter.
getComment() - Method in class com.jivesoftware.community.AbuseReport
Gets a comment explaining this abuse report.
getComment() - Method in class com.jivesoftware.community.Ban
Gets a comment for this ban object.
getComment(long) - Method in interface com.jivesoftware.community.Blog
Returns a comment by comment ID.
getComment(JiveObject, long) - Method in interface com.jivesoftware.community.CommentManager
Returns a comment from the object based on its id.
getComment() - Method in class com.jivesoftware.community.event.CommentEvent
 
getComment() - Method in interface com.jivesoftware.community.VersionComment
Returns the version comment string.
getCommentAuthenticationStrategy() - Method in interface com.jivesoftware.community.Blog
Returns the comment authentication strategy of this blog which may be any one of the following: Blog.COMMENT_AUTH_REQUIRED -- must register and login to comment Blog.COMMENT_AUTH_OPTIONAL_WITH_EMAIL -- must either register and login or provide an email address in the comment form.
getCommentCount() - Method in interface com.jivesoftware.community.Blog
Returns the total number of comments on this blog.
getCommentCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns the total number of comments on this blog that match the criteria specified by the ResultFilter.
getCommentCount() - Method in interface com.jivesoftware.community.BlogManager
Returns the number of comments on blog posts in the system.
getCommentCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getCommentCount(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Returns the number of comments in the object.
getCommentCount(JiveObject, CommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns the number of comments in the object based on the specified ResultFilter.
getCommentDate() - Method in interface com.jivesoftware.community.VersionComment
Returns the date the version comment was created.
getCommentDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a comment manager to manage blog post comments.
getCommentDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a comment manager to manage document comments.
getCommentDelegator() - Method in interface com.jivesoftware.community.Poll
Retrieve a comment delegator to manage poll comments.
getCommentDepth(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the depth of a comment in the comment tree hierarchy.
getCommentFeedURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the comments feed for a blog.
getCommentFeedURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the comments feed for a specific post.
getCommentID() - Method in exception com.jivesoftware.community.CommentNotFoundException
 
getCommentManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the CommentManager.
getCommentPermalink(Comment) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a permalink for a blog comment which is a combination of the base URL, the blog display name, the year / month / day, the entry name and a suffix / comment ID.
getComments(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all the comments on this blog that match the criteria specified by the ResultFilter.
getComments(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all the comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getComments(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Returns an iterable for all the comments in the object.
getComments(JiveObject, CommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns an Iterable for all the comments in the object that match the criteria specified by the ResultFilter.
getCommentsCreationDate(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Convenience method that return the date that the first comment was created.
getCommentsModificationDate(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Convenience method that returns the date of the latest comment modification in the object.
getCommentStatus() - Method in interface com.jivesoftware.community.BlogPost
Returns the comment status of this blog post which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now Defaults to OPEN.
getCommentStatus() - Method in interface com.jivesoftware.community.Document
Returns the comment status of this document which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now Defaults to OPEN.
getCommentStatus() - Method in interface com.jivesoftware.community.Poll
Returns the comment status of this poll which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now Defaults to OPEN.
getCommentTreeWalker(JiveObject) - Method in interface com.jivesoftware.community.CommentManager
Returns a CommentTreeWalker for the comments in the object.
getCommentURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the script that accepts comment postings which is a combination of the base URL, the blog display name and the post permalink.
getCommunities() - Method in interface com.jivesoftware.community.Blog
Returns the communities this blog has been associated with.
getCommunities() - Method in interface com.jivesoftware.community.Community
Returns an Iterable for the child communities of this community.
getCommunities(int, int) - Method in interface com.jivesoftware.community.Community
Returns an Iterable for the child communities of this community using a start index and the number of results to return.
getCommunities(AuthToken) - Method in interface com.jivesoftware.community.ModerationManager
This method will return a list of communities where the user is a moderator.
getCommunity(long) - Method in interface com.jivesoftware.community.CommunityManager
Returns the Community with the supplied communityID.
getCommunity(String) - Method in interface com.jivesoftware.community.CommunityManager
Returns the community with the specified NNTP name.
getCommunity() - Method in interface com.jivesoftware.community.Document
Returns the community of the document.
getCommunity() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getCommunity() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getCommunity() - Method in interface com.jivesoftware.community.ForumMessage
Returns the community this message belongs to.
getCommunity() - Method in interface com.jivesoftware.community.ForumThread
Returns the community this thread belongs to.
getCommunity() - Method in class com.jivesoftware.community.ProfileSearchQuery
Gets the community used for this query.
getCommunity() - Method in interface com.jivesoftware.community.TagSet
Returns the Community to which this TagSet is bound.
getCommunity() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the community object for this widget context, or null if the widget is being rendered outside of a community.
getCommunityCount() - Method in interface com.jivesoftware.community.Community
Returns the number of sub-communities of this community.
getCommunityCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of communities to be imported
getCommunityDepth() - Method in interface com.jivesoftware.community.Community
Returns the depth of a this community relative to the root.
getCommunityID() - Method in class com.jivesoftware.community.CommentResultFilter
Returns the communityID.
getCommunityID() - Method in exception com.jivesoftware.community.CommunityNotFoundException
The id of the community that was not found.
getCommunityIDs() - Method in interface com.jivesoftware.community.SearchQuery
Returns an array of communityID's denoting the communities that will be searched within.
getCommunityIndex() - Method in interface com.jivesoftware.community.ForumMessage
Returns the index of this message in the community.
getCommunityManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a community manager which is used to access community wide resources
getCompletionTasks() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of ImportTasks that should be run after the rest of the import is complete.
getConfig() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getConfiguration() - Method in interface com.jivesoftware.community.importer.Importer
Returns the import configuration for this importer.
getConfigurationMap() - Method in interface com.jivesoftware.spi.ServiceProvider
This method is must return all of the configuration keys that need to be set before calling initialize method.
getContainerKeys() - Static method in class com.jivesoftware.community.action.JiveActionSupport
Used in conjunction with the overridden getText(...) method below, this method loads up all the EN properties files and examines each one for the existence of a matching "...internal" and "...external" key.
getContainerObject() - Method in interface com.jivesoftware.community.Activity
Returns the parent object of the piece of content this activity pertains to, or null if no parent exists.
getContainerObjectID() - Method in interface com.jivesoftware.community.Announcement
Returns the object ID of the announcement container.
getContainerObjectID() - Method in interface com.jivesoftware.community.Poll
Returns the object ID of the container that 'contains' the poll.
getContainerObjectType() - Method in interface com.jivesoftware.community.Announcement
Returns the object type of the announcement container.
getContainerObjectType() - Method in interface com.jivesoftware.community.Poll
Returns the object type of the container that 'contains' the poll.
getContentObject() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns the object this macro is being used inside of.
getContentObjectType() - Method in interface com.jivesoftware.community.Attachment
Returns the object type of this attachments content object.
getContentType() - Method in interface com.jivesoftware.community.Attachment
Returns the content type of the attachment.
getContentType() - Method in interface com.jivesoftware.community.BinaryBody
Returns the content type of the body object.
getContentType() - Method in interface com.jivesoftware.community.Image
Returns the content type of the image.
getContentTypes() - Method in interface com.jivesoftware.community.Community
Gets an array of ContentRetrieval.ContentTypes that are enabled for this community.
getContext() - Method in class com.jivesoftware.community.EmailMessage
Returns a map of replacement tokens to use in the email
getContext(AuthToken) - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Returns a concrete JiveContext instance.
getContextParameter(String) - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the context parameter associated with the specified key, or null if no association exists.
getContextParameters() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns a map of all the context parameters.
getCorrectAnswer() - Method in interface com.jivesoftware.community.Question
Returns the correct answer, or null if no correct answer has been set.
getCount() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns total number of users in the system.
getCreated() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getCreationDate() - Method in interface com.jivesoftware.base.Group
Returns the date that the group was created.
getCreationDate() - Method in interface com.jivesoftware.base.User
Returns the date that the user was created.
getCreationDate() - Method in interface com.jivesoftware.community.Activity
Returns the date the activity was created.
getCreationDate() - Method in interface com.jivesoftware.community.Attachment
Returns the date the attachment was created.
getCreationDate() - Method in class com.jivesoftware.community.Ban
Gets the date this ban object was created.
getCreationDate() - Method in interface com.jivesoftware.community.Blog
Returns the date that this blog was created.
getCreationDate() - Method in interface com.jivesoftware.community.BlogPost
Returns the date that this post was created.
getCreationDate() - Method in interface com.jivesoftware.community.Comment
Returns the date that the comment was created.
getCreationDate() - Method in interface com.jivesoftware.community.Community
Returns the Date that the community was created.
getCreationDate() - Method in interface com.jivesoftware.community.ContentTag
Returns the date that this tag was created.
getCreationDate() - Method in interface com.jivesoftware.community.Document
A convenience method which returns the date the document was originally created.
getCreationDate() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the date the document version was created.
getCreationDate() - Method in interface com.jivesoftware.community.ForumMessage
Returns the date this message was created.
getCreationDate() - Method in interface com.jivesoftware.community.ForumThread
Returns the date that this thread was created.
getCreationDate() - Method in interface com.jivesoftware.community.Image
Returns the date the image was created.
getCreationDate() - Method in interface com.jivesoftware.community.JiveContentObject
Gets the creation date of the jive object
getCreationDate() - Method in interface com.jivesoftware.community.Poll
Returns the date the poll was created.
getCreationDate() - Method in interface com.jivesoftware.community.Question
Returns the date this question was created.
getCreationDate() - Method in interface com.jivesoftware.community.TagSet
A convenience method which returns the date the tag set was originally created.
getCreationDate() - Method in interface com.jivesoftware.community.Trackback
Returns the date this trackback was created.
getCreationDateRangeMax() - Method in class com.jivesoftware.community.BanFilter
Returns a date that represents the upper boundry for bans to be selected by the ban filter.
getCreationDateRangeMax() - Method in class com.jivesoftware.community.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.community.ResultFilter
Returns the date that represents the upper boundry for creation dates that will pass the result filter.
getCreationDateRangeMin() - Method in class com.jivesoftware.community.BanFilter
Returns the creation date that represents the lower boundary for bans to be filtered on.
getCreationDateRangeMin() - Method in class com.jivesoftware.community.QuestionFilter
Returns the creation date that represents the lower boundary for messages or threads to be filtered on.
getCreationDateRangeMin() - Method in class com.jivesoftware.community.ResultFilter
Returns the date that represents the lower boundry for creation dates that will pass the result filter.
getCronTaskManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a cron task manager that can be used to schedule tasks to run at a specific day/time.
getCssClass() - Method in class com.jivesoftware.community.widget.BaseWidget
 
getCssClass() - Method in interface com.jivesoftware.community.widget.Widget
Returns a custom css class for the widget, or null if a custom css class does not exist.
getCssUrls() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getCurrentCount() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getCurrentCount() - Method in interface com.jivesoftware.community.SearchManager
Returns the number of content objects that have been indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getCustomTitle() - Method in class com.jivesoftware.community.widget.BaseWidget
 
getCustomTitle() - Method in interface com.jivesoftware.community.widget.Widget
Returns a custom title that will override the default title when the widget is rendered, or null if a custom title does not exist.
getData() - Method in interface com.jivesoftware.community.Attachment
Returns a InputStream for the binary contents of the attachment.
getData() - Method in interface com.jivesoftware.community.BinaryBody
Returns a InputStream for the binary contents of the body object.
getData() - Method in interface com.jivesoftware.community.Image
Returns a InputStream for the binary contents of the image.
getDatabaseKey() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getDatabaseVersion() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getDataType(long) - Static method in enum com.jivesoftware.community.DocumentFieldType.DataType
Used to acquire a DataType with a specific data type ID.
getDataType() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the XMPP data form type that this object is.
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.UserEvent
 
getDate() - Method in class com.jivesoftware.community.event.AnnouncementEvent
 
getDate() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getDate() - Method in class com.jivesoftware.community.event.BlogEvent
 
getDate() - Method in class com.jivesoftware.community.event.BlogPostEvent
 
getDate() - Method in class com.jivesoftware.community.event.CommentEvent
 
getDate() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getDate() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getDate() - Method in class com.jivesoftware.community.event.EmailEvent
 
getDate() - Method in class com.jivesoftware.community.event.ImageEvent
 
getDate() - Method in class com.jivesoftware.community.event.MessageEvent
 
getDate() - Method in class com.jivesoftware.community.event.PollEvent
 
getDate() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
 
getDate() - Method in class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
getDate() - Method in class com.jivesoftware.community.event.QuestionEvent
 
getDate() - Method in class com.jivesoftware.community.event.SearchIndexEvent
 
getDate() - Method in class com.jivesoftware.community.event.StorageManagerEvent
 
getDate() - Method in class com.jivesoftware.community.event.TagEvent
 
getDate() - Method in class com.jivesoftware.community.event.TagSetEvent
 
getDate() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getDate() - Method in class com.jivesoftware.community.event.TrackbackEvent
 
getDate() - Method in interface com.jivesoftware.community.JiveEvent
Returns the date (as a Date object) that the event was created.
getDate() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the date the message was saved or sent, or null if the message hasn't been sent or saved yet.
getDefaultBaseURL() - Static method in class com.jivesoftware.community.action.JiveActionSupport
Returns the base URL of this Jive installation - usually:

http://[yoursite]/[webapp-path]

This uses the Jive property of jiveURL which is settable through the config file or admin console.

getDefaultBaseURL() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the base URL of this Jive installation - usually:

http://[yoursite]/[webapp-path]

This uses the Jive property of jiveURL which is settable through the config file or admin console.

getDefaultDocumentType() - Method in interface com.jivesoftware.community.DocumentTypeManager
Returns the default document type in the system, which includes the fields title, body, attachments, and language.
getDefaultHelp() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
Returns a String[section,title,body] for the default help for the filter.
getDefaultHelp() - Method in class com.jivesoftware.community.renderer.BaseFilter
Not currently used.
getDefaultValue() - Method in interface com.jivesoftware.community.DocumentField
Returns a value that should be used as a default for text based (non select,radio,etc) fields during document creation.
getDeleteDays() - Method in interface com.jivesoftware.community.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 class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getDescription() - Method in interface com.jivesoftware.community.Blog
Returns the description of the blog.
getDescription() - Method in interface com.jivesoftware.community.Community
Returns the description of the community.
getDescription() - Method in interface com.jivesoftware.community.DocumentField
Returns the description of the document field.
getDescription() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the description of this document field type
getDescription() - Method in interface com.jivesoftware.community.DocumentType
Retrieve the description of the document type.
getDescription() - Method in interface com.jivesoftware.community.Poll
Returns a brief description of the poll.
getDescription() - Method in class com.jivesoftware.community.ProfileField
Gets the description of this profile field.
getDescription() - Method in enum com.jivesoftware.community.ProfileField.Type
Gets the description of this type.
getDescription() - Method in interface com.jivesoftware.community.Rating
Retrieve the description for the rating.
getDescription() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get a description of the search engine.
getDescription() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The description of the result (will be displayed on the view).
getDescription() - Method in interface com.jivesoftware.community.StatusLevel
Returns the description of this status level
getDescription() - Method in interface com.jivesoftware.community.TagSet
Returns the description of this TagSet.
getDescription(WidgetContext) - Method in interface com.jivesoftware.community.widget.Widget
Returns the default description of the widget
getDescriptorURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the URL of the XML opensearch descriptor file.
getDevPlugins() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a set of all the plugins that have been specified with -DpluginDirs system property
getDisabledCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getDisallowedTypes() - Method in interface com.jivesoftware.community.AttachmentManager
Returns a List of explicitly disallowed types.
getDisallowedTypes() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns a list of explicitly disallowed types.
getDisallowedTypes() - Method in interface com.jivesoftware.community.ImageManager
Returns a list of explicitly disallowed types.
getDisallowedTypesAsFileExtensions() - Method in interface com.jivesoftware.community.AttachmentManager
Returns a list of explicitly disallowed file types by default extensions.
getDisallowedTypesAsFileExtensions() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns a list of explicitly disallowed file types by default extensions.
getDisplayName() - Method in interface com.jivesoftware.community.Blog
Gets the display name of a blog.
getDisplayName() - Method in interface com.jivesoftware.community.Community
Gets the display name of the community.
getDisplayName() - Method in interface com.jivesoftware.community.DocumentField
Returns the display name for this field.
getDisplayName() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns a display friendly name that can be shown in the UI.
getDisplayName() - Method in enum com.jivesoftware.community.ProfileField.Type
Gets the displayName of this type.
getDocument(long) - Method in interface com.jivesoftware.community.DocumentManager
Returns the document with the specified docID.
getDocument(long, int) - Method in interface com.jivesoftware.community.DocumentManager
Returns the revision of document with the specified docID and version number.
getDocument(String) - Method in interface com.jivesoftware.community.DocumentManager
Returns a document from the community based on its document ID.
getDocument(String, int) - Method in interface com.jivesoftware.community.DocumentManager
Returns the revision of the document with the specified docID and version number.
getDocument(Community, String) - Method in interface com.jivesoftware.community.DocumentManager
Returns a document from a community based on its subject.
getDocument() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the Document object corresponding to this version.
getDocument() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getDocument() - Method in class com.jivesoftware.community.ProfileSearchResult
Gets the search Document for this user.
getDocumentApprovers() - Method in interface com.jivesoftware.community.Community
Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.
getDocumentationMap() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
Returns a documentation Map keyed by languageCode -> String[section,title,body].
getDocumentationMap() - Method in class com.jivesoftware.community.renderer.BaseFilter
Not currently used.
getDocumentAttributes() - Method in interface com.jivesoftware.community.Document
Return the attributes of the document.
getDocumentCount() - Method in interface com.jivesoftware.community.Community
Returns the number of published documents in the community.
getDocumentCount(DocumentResultFilter) - Method in interface com.jivesoftware.community.Community
Returns the number of documents in the community {and possibly all subcommunities} based on the specified ResultFilter.
getDocumentCount() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of published documents in the community.
getDocumentCount(DocumentResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of documents in the community based on the specified ResultFilter.
getDocumentCount(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of documents to be imported in the given community
getDocumentElements() - Method in interface com.jivesoftware.community.DocumentType
Returns the elements that make up this document type as a list of DocumentTypeElements.
getDocumentElements(DocumentTypeElement.Type) - Method in interface com.jivesoftware.community.DocumentType
Returns the elements that make up this document type and match the given type.
getDocumentElements() - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Returns a list of all the Document Elements associated with this DocumentSection
getDocumentField(long) - Method in interface com.jivesoftware.community.DocumentFieldManager
Returns the document field with the given id.
getDocumentField(String) - Method in interface com.jivesoftware.community.DocumentFieldManager
Returns the document field with the given name.
getDocumentField(int) - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the document field at the specified index in the list of document fields to be filtered on.
getDocumentFieldCount() - Method in class com.jivesoftware.community.DocumentResultFilter
 
getDocumentFieldManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a document field manager that can be used to manage document fields.
getDocumentFieldMode() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the mode that will be used to select results if multiple document field values have been specified.
getDocumentFields() - Method in interface com.jivesoftware.community.DocumentFieldManager
Returns an collection of DocumentField objects that list all the current document fields.
getDocumentFieldType(long) - Method in interface com.jivesoftware.community.DocumentFieldTypeManager
Returns the DocumentFieldType with a given id
getDocumentFieldType(String) - Method in interface com.jivesoftware.community.DocumentFieldTypeManager
Returns the DocumentFieldType with a given name
getDocumentFieldTypeManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a document fieldtype manager that can be used to manage document field types.
getDocumentFieldTypes() - Method in interface com.jivesoftware.community.DocumentFieldTypeManager
Returns a collection of all the DocumentFieldTypes.
getDocumentFieldValue(DocumentField) - Method in interface com.jivesoftware.community.Document
Returns the value of the document field as a DocumentFieldValue object.
getDocumentFieldValue(int) - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the optionID(s) at the specified index in the list of DocumentFields to be filtered on.
getDocumentFieldValues() - Method in interface com.jivesoftware.community.Document
Returns a map of DocumentField -> DocumentFieldValue for the document.
getDocumentID() - Method in interface com.jivesoftware.community.Document
Returns the document ID corresponding to the document.
getDocumentManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a document manager which can be used to retrieve documents.
getDocumentPresenter() - Method in interface com.jivesoftware.community.DocumentType
Returns a document presenter with the specified name, or null if no presenter is defined with the specified name.
getDocuments() - Method in interface com.jivesoftware.community.Community
Returns an Iterable for all the published documents in the community.
getDocuments(DocumentResultFilter) - Method in interface com.jivesoftware.community.Community
Returns an Iterable for all the documents in the community {and possibly all subcommunities} that match the criteria specified by the ResultFilter.
getDocuments() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable of published documents objects in the community.
getDocuments(DocumentResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all the documents in the community that match the criteria specified by the ResultFilter.
getDocuments(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of document import beans corresponding to the child documents of the given parent community
getDocumentSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the DocumentSearchQueryCriteria that can be used to specify criteria to sort and/or filter document search results.
getDocumentSortType(int) - Static method in enum com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType
A helper method to get a specific DocumentSortType object from its key
getDocumentState() - Method in interface com.jivesoftware.community.Document
Return the state of the document.
getDocumentState(String) - Static method in enum com.jivesoftware.community.DocumentState
A helper method to get a specific DocumentState object from its key
getDocumentState() - Method in interface com.jivesoftware.community.DocumentVersion
Retrieve the document state for the version.
getDocumentStateCount() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the number of document states that results will be filtered on.
getDocumentStates() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the list of document states to filter results selected by the result filter.
getDocumentsUnderEdit() - Method in interface com.jivesoftware.community.Community
Returns an Iterable of documents currently being editted in the community.
getDocumentsUnderEdit() - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable of documents currently being editted.
getDocumentsUnderEditCount() - Method in interface com.jivesoftware.community.Community
Returns the count of the number of documents currently being editted in the community.
getDocumentsUnderEditCount() - Method in interface com.jivesoftware.community.DocumentManager
Returns the count of the number of documents currently being editted.
getDocumentType() - Method in interface com.jivesoftware.community.Document
Return the type of the document.
getDocumentType(long) - Method in interface com.jivesoftware.community.DocumentTypeManager
Retrieve the document type with the specified id.
getDocumentTypeManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a document type manager that can be used to manage document types.
getDocumentTypes() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the list of document types to filter results selected by the result filter.
getDocumentTypes() - Method in interface com.jivesoftware.community.DocumentTypeManager
Returns a list of DocumentType objects that list all the current document types.
getDocumentTypesCount() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the number of document types that results will be filtered on.
getDocumentVersion() - Method in interface com.jivesoftware.community.Document
Returns a DocumentVersion object corresponding to the current instance.
getDocumentVersion(int) - Method in interface com.jivesoftware.community.VersionManager
Returns a specific document version for the document.
getDocumentVersionCount() - Method in interface com.jivesoftware.community.VersionManager
Returns the count of versions the document has.
getDocumentVersions() - Method in interface com.jivesoftware.community.VersionManager
Returns a list of DocumentVersion objects for the document.
getDownloadCount() - Method in interface com.jivesoftware.community.Attachment
Returns the number of times the attachment has been downloaded.
getDownloadCount() - Method in interface com.jivesoftware.community.BinaryBody
Returns the number of times the binary body has been downloaded.
getDraft(long) - Method in interface com.jivesoftware.community.DraftManager
Returns a draft by draft ID or null if no draft exists with the specified draftID.
getDraft(long, int, int, long) - Method in interface com.jivesoftware.community.DraftManager
Returns the draft for a particular user associated with a particular community, thread and / or message.
getDraftContainerObjectID() - Method in interface com.jivesoftware.community.Draft
Returns the ID of the object that contains this draft.
getDraftContainerObjectType() - Method in interface com.jivesoftware.community.Draft
Returns the type of the object that contains this draft.
getDraftManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a draft manager that can be used to manage message drafts.
getDraftObjectType() - Method in interface com.jivesoftware.community.Draft
Returns the type of object this draft represents.
getDraftsByUser(long) - Method in interface com.jivesoftware.community.DraftManager
Returns all drafts for a particular user.
getEditAutoExpireTimeout() - Method in interface com.jivesoftware.community.DocumentManager
Returns the number of minutes that a document will be marked as being editted without any updates before the document will be remarked as not being editted.
getEditGuest() - Method in interface com.jivesoftware.community.Document
Returns the sessionID for the guest user editing the document, or null if the document is not currently being edited by a guest user.
getEditUser() - Method in interface com.jivesoftware.community.Document
Returns the user editing the document, or null if the document is not currently being edited
getElementValue(String) - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
Returns the value of an element selected via an xpath expression from a Plugin's plugin.xml file.
getEmail() - Method in interface com.jivesoftware.base.User
Returns the user's email address.
getEmail() - Method in interface com.jivesoftware.community.Comment
Returns the email of the person that authored this comment.
getEmail() - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
getEmail() - Method in interface com.jivesoftware.spi.user.User
User's email address
getEmail() - Method in class com.jivesoftware.spi.user.UserTemplate
 
getEmailManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an email manager that can be used for sending out emails
getEmailMessage() - Method in class com.jivesoftware.community.event.EmailEvent
Returns the Clearspace email message that this email wraps.
getEmailTokenManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an email token manager
getEnabledCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getEnabledUserCount() - Method in interface com.jivesoftware.base.UserManager
 
getEndDate() - Method in interface com.jivesoftware.community.Announcement
Returns the date when the announcement should not longer be visible.
getEndDate() - Method in interface com.jivesoftware.community.Poll
Returns the date voting for the poll should end.
getErrorHeader() - Method in class com.jivesoftware.community.action.JiveActionSupport
This will provide a way of customizing the error message on the error.ftl
getErrorType() - Method in exception com.jivesoftware.community.AttachmentException
 
getErrorType() - Method in exception com.jivesoftware.community.BinaryBodyException
 
getErrorType() - Method in exception com.jivesoftware.community.ImageException
 
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.UserEvent
 
getEventType() - Method in class com.jivesoftware.community.event.AnnouncementEvent
 
getEventType() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getEventType() - Method in class com.jivesoftware.community.event.BlogEvent
 
getEventType() - Method in class com.jivesoftware.community.event.BlogPostEvent
 
getEventType() - Method in class com.jivesoftware.community.event.CommentEvent
 
getEventType() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getEventType() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getEventType() - Method in class com.jivesoftware.community.event.EmailEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ImageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.MessageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.PollEvent
 
getEventType() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ProfileEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
getEventType() - Method in class com.jivesoftware.community.event.QuestionEvent
 
getEventType() - Method in class com.jivesoftware.community.event.SearchIndexEvent
 
getEventType() - Method in class com.jivesoftware.community.event.StorageManagerEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TagEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TagSetEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TrackbackEvent
 
getEventType() - Method in interface com.jivesoftware.community.JiveEvent
Returns the event type corresponding to the event.
getEventType() - Method in class com.jivesoftware.spi.ServiceEvent
Return the enum that denotes the event type.
getExcerpt() - Method in interface com.jivesoftware.community.Trackback
Returns the excerpt of the trackback.
getExpirationDate() - Method in class com.jivesoftware.community.Ban
Gets the date this ban object will expire, or null if it is a permanent ban object.
getExpirationDate() - Method in interface com.jivesoftware.community.Document
Returns the date that the document is set to expire on.
getExpirationDate() - Method in interface com.jivesoftware.community.Poll
Returns the date the poll should expire.
getExpirationDateRangeMax() - Method in class com.jivesoftware.community.BanFilter
Returns a date that represents the upper boundry for bans to be selected by the ban filter.
getExpirationDateRangeMax() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns a date that represents the upper boundry for documents to be selected by the result filter.
getExpirationDateRangeMin() - Method in class com.jivesoftware.community.BanFilter
Returns the expiration date that represents the lower boundary for bans to be filtered on.
getExpirationDateRangeMin() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns a date that represents the lower boundry for documents to be selected by the result filter.
getExternalSearchableURL(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the externral search URL with the {searchTerms} token substitued by the argument.
getExternalSearchURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get an OpenSearch compliant URL that can be queried against.
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.community.event.ProfileEvent
Returns the exception that indicates why a listener failed to handle an event.
getFeedURL() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to a feed which contains recent posts across the entire system.
getFeedURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the feed which is a combination of the base URL, the blog display name and the default system feed type.
getFieldID() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getFieldID() - Method in class com.jivesoftware.community.ProfileFieldOption
Gets the id of the ProfileField in which this option belongs.
getFieldID() - Method in class com.jivesoftware.community.ProfileFieldValue
Returns the ID of the ProfileField for this value.
getFieldID() - Method in class com.jivesoftware.community.ProfileSearchFilter
Gets the ID of the ProfileField used to filter the user results.
getFieldType() - Method in interface com.jivesoftware.community.DocumentField
Returns the DocumentFieldType associated with this DocumentField.
getFile() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getFilteredBlog() - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Returns the blog that query results are restricted to.
getFilteredDocumentType() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns a DocumentType that query results are restricted to.
getFilteredTagSets() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns a collection of TagSets that query results are restricted to.
getFilteredThread() - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Returns the thread that query results are restricted to.
getFilteredUser() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the user that query results are restricted to.
getFilterRenderTypes() - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns a Long list of filter render types corresponding with the contents of the array returned by getRenderFilters.
getFilterRenderTypes(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns the bitset render types installed for the filter at the given index.
getFilters() - Method in class com.jivesoftware.community.ProfileSearchQuery
Gets a list of ProfileSearchFilters used to filter user results for this query.
getFilterTags() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns a list of tags for all the currently configured render filters which implement the TagFilter interface.
getFinalGroupPerms(int, long, long, PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Returns the Permissions object that corresponds to the permissions that a group has for a particular object.
getFinalLocale() - Method in interface com.jivesoftware.community.Community
Returns the locale for this community.
getFinalUserPerms(int, long, long, PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Returns the Permissions object that corresponds to the combined permissions that a user has for a particular object: Anonymous and "registered users" permissions.
getFinishDate() - Method in interface com.jivesoftware.community.importer.Importer
Returns the date the import finished or null if the import has not yet finished
getFirstPost() - Method in interface com.jivesoftware.community.Blog
Returns the first blog post on this blog.
getFolder() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the folder the private message or null if the message does not yet belong to a folder.
getFolder(User, long) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the specified folder for a user.
getFolderCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of folders the user has.
getFolders(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns an Iterable of PrivateMessageFolder objects for the folders the user has.
getFormatter() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the formatter for this document field type.
getFormatter() - Method in enum com.jivesoftware.community.ProfileField.Type
Gets the profile field formatter for this type
getForumManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a forum manager which can be used to access threads and messages
getForumThread(long) - Method in interface com.jivesoftware.community.ForumManager
Returns the thread with the specified threadID.
getForumThread() - Method in interface com.jivesoftware.community.ForumMessage
Returns the thread this message belongs to.
getForumThread() - Method in interface com.jivesoftware.community.Question
Returns the thread that the question is associated with.
getForumThreadCount(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of forum threads to be imported in the given community
getForumThreads(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of forum thread import beans corresponding to child threads of the given parent community
getFromEmail() - Static method in class com.jivesoftware.community.util.BlogUtils
Get an available email address to use for outbound emails.
getFromName() - Static method in class com.jivesoftware.community.util.BlogUtils
Get an available from name to use for outbound emails.
getGatewayCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of gateways to be imported
getGatewayManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a gateway manager that can be used for managing gateways
getGateways() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of gateway import beans corresponding to the gateways to be imported
getGlobalAvatars() - Method in interface com.jivesoftware.community.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.community.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.
getGroupCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of groups to be imported
getGroupManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a group manager 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.
getGroups() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of group import beans corresponding to the groups to be imported
getGroupStatusLevels() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an iterable of all group based status levels in the system.
getGuestProperty(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a guest property.
getHelpfulAnswers() - Method in interface com.jivesoftware.community.Question
Returns a read-only Collection of ForumMessage objects that have been marked as helpful.
getHelpfulAnswersPerThread() - Method in interface com.jivesoftware.community.QuestionManager
Returns the number of helpful answers allowed per question.
getHtmlBody() - Method in class com.jivesoftware.community.EmailMessage
Returns the html version of the body
getHtmlBodyProperty() - Method in class com.jivesoftware.community.EmailMessage
 
getHttpBindSecureUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the secure URL on which it can be reached.
getHttpBindUnsecureUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the unsecure URL on which it can be reached.
getHttpBindUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the URL on which it can be reached.
getHumanFriendlyDate(Date) - Static method in class com.jivesoftware.community.util.BlogUtils
Deprecated. Replaced by DateUtils.displayFriendly(long)
getIconURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the URL of an icon described in the descriptor file.
getID() - Method in interface com.jivesoftware.base.Group
Returns the id of the group.
getID() - Method in interface com.jivesoftware.base.User
Returns the user's id.
getID() - Method in class com.jivesoftware.community.AbuseReport
Gets the unique ID of this abuse report.
getID() - Method in enum com.jivesoftware.community.Activity.Type
 
getID() - Method in class com.jivesoftware.community.Ban
Returns the unique ID that represents this ban object.
getID() - Method in interface com.jivesoftware.community.Blog
Returns the unique ID of the blog, or -1 if the blog hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.community.BlogPost
Returns the unique ID of this post, or -1 if the post hasn't been added to the database yet.
getID() - Method in enum com.jivesoftware.community.ContentRetrieval.ContentType
 
getID() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the ID of the document field option.
getId() - Method in enum com.jivesoftware.community.DocumentFieldType.DataType
 
getID() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns the id of this type
getID() - Method in class com.jivesoftware.community.EntityDescriptor
Returns the ID of this entity (object).
getID() - Method in interface com.jivesoftware.community.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.community.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.community.JiveObject
Retrieve the unique identifier for the jive object, or -1 if the object hasn't yet been added/inserted into the system.
getID() - Method in class com.jivesoftware.community.PermissionType
Returns the id of the PermissionType
getID() - Method in interface com.jivesoftware.community.Poll
Returns the unique ID of the poll.
getID() - Method in interface com.jivesoftware.community.Presence
Returns the unique ID for this status.
getID() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the id of the message.
getID() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the ID of the folder.
getID() - Method in class com.jivesoftware.community.ProfileField
Gets the id representing this profile field.
getID() - Method in enum com.jivesoftware.community.ProfileField.Type
Gets the id representing this type.
getID() - Method in interface com.jivesoftware.community.Trackback
Returns the id of this trackback, or -1 if this trackback hasn't been added to the database yet.
getID() - Method in class com.jivesoftware.community.widget.BaseWidget
 
getID() - Method in enum com.jivesoftware.community.widget.Widget.ContainerSize
 
getID() - Method in interface com.jivesoftware.community.widget.Widget
Gets the internal id of the widget
getID() - Method in interface com.jivesoftware.spi.user.User
Returns the unique identifier for this user.
getID() - Method in class com.jivesoftware.spi.user.UserTemplate
 
getIdentifiedObject() - Method in class com.jivesoftware.community.event.DocumentEvent
Return an EntityDescriptor if document is null and documentID is not.
getIdentifiedObject() - Method in class com.jivesoftware.community.event.MessageEvent
Return an EntityDescriptor if message is null and messageID is not.
getIdentifiedObject() - Method in class com.jivesoftware.community.event.ThreadEvent
Return an EntityDescriptor if thread is null and threadID is not.
getImage() - Method in class com.jivesoftware.community.event.ImageEvent
 
getImage(long) - Method in interface com.jivesoftware.community.ImageContentResource
Returns the image corresponding to the imageID.
getImage(long) - Method in interface com.jivesoftware.community.ImageManager
Returns an image given the image id.
getImageCount() - Method in interface com.jivesoftware.community.ImageContentResource
Returns the number of images the object has.
getImageCount(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of images to be imported
getImageDirectorySize() - Method in interface com.jivesoftware.community.StorageManager
Returns the size (in bytes) of the image directory on the file system.
getImageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an image manager that can be used to manage image settings.
getImageMaxHeight() - Method in interface com.jivesoftware.community.ImageManager
Returns the max height of images that will be displayed.
getImageMaxWidth() - Method in interface com.jivesoftware.community.ImageManager
Returns the max width of images that will be displayed.
getImagePath() - Method in interface com.jivesoftware.community.StatusLevel
Returns the relative path to the image.
getImagePreviewMaxSize() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getImagePreviewMaxSize() - Method in interface com.jivesoftware.community.ImageManager
Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getImages() - Method in interface com.jivesoftware.community.Draft
Returns a list of images for the draft, or an empty list if no images are associated with the draft.
getImages() - Method in interface com.jivesoftware.community.ImageContentResource
Returns an Iterable for the object's images.
getImages(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of image import beans corresponding to the images for the given ID
getIMManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the IMManager.
getImporter(Class<?>) - Method in class com.jivesoftware.community.importer.ImporterFactory
Returns an importer instance given the importer class.
getImporters() - Method in class com.jivesoftware.community.importer.ImporterFactory
Returns a collection of Class's corresponding to the available importers.
getImportStatistics() - Method in interface com.jivesoftware.community.importer.Importer
Returns statistics for the current import.
getIndex() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the index of the option in the list of options for the document field.
getIndex() - Method in class com.jivesoftware.community.ProfileField
Gets the index of this profile field.
getIndex() - Method in class com.jivesoftware.community.ProfileFieldOption
Gets the index of this option which represents the order in which the options will appear in the list.
getIndexContent() - Method in interface com.jivesoftware.community.JiveContentObject
 
getIndexOfChild(Comment, Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the index of child in parent.
getIndexOfChild(ForumMessage, ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the index of child in parent.
getInheritedRenderFilters() - Method in interface com.jivesoftware.community.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.
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.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.UserManagerFactory
Returns a concrete instance of the user manager interface.
getInstance() - Static method in class com.jivesoftware.community.AvatarManagerFactory
Returns a concrete instance of the Avatar interface.
getInstance() - Static method in class com.jivesoftware.community.BanManagerFactory
Returns a concrete implementation of the BanManager interface.
getInstance() - Static method in class com.jivesoftware.community.event.AnnouncementEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.BlogEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.BlogPostEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.CommentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.CommunityEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.DocumentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.EmailEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ImageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.MessageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.PollEventDispatcher
Returns an event dispatcher instance.
getInstance() - Static method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ProfileEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TagEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TagSetEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.importer.ImporterFactory
Returns an instance of this factory.
getInstance() - Static method in class com.jivesoftware.community.PollManagerFactory
Returns a concrete instance of the poll manager interface.
getInstance() - Static method in class com.jivesoftware.community.renderer.RendererFactory
Returns an implementation of the Renderer interface.
getInstance(AuthToken) - Static method in class com.jivesoftware.community.SearchQueryLoggerFactory
Returns a concrete instance of the query logger interface wrapped by a protection proxy.
getInstance() - Static method in class com.jivesoftware.community.StatusLevelManagerFactory
Returns a concrete instance of the StatusLevel interface.
getInstance() - Static method in class com.jivesoftware.community.TagManagerFactory
Returns a concrete instance of the tag manager interface.
getInstance(int, long, JiveContext) - Static method in class com.jivesoftware.community.TrackbackManagerFactory
Returns a concrete instance of the trackback manager interface.
getInstance() - Static method in class com.jivesoftware.community.widget.WidgetDAOFactory
Returns a concrete implementation of the WidgetDAO interface.
getInterceptor(int) - Method in interface com.jivesoftware.community.InterceptorManager
Return the interceptor at the specified index in the list of currently configured interceptors.
getInterceptorCount() - Method in interface com.jivesoftware.community.InterceptorManager
Returns the count of currently active interceptors.
getInterceptorManager() - Method in interface com.jivesoftware.community.BlogManager
Returns an interceptor manager that can be used to manage interceptors for all the blogs in the system.
getInterceptorManager() - Method in interface com.jivesoftware.community.Community
Returns a message interceptor manager that can be used to manage interceptors for this community.
getInterceptorManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an interceptor manager that can be used to manage global interceptors.
getInterceptorManager() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getIpAddress() - Method in class com.jivesoftware.community.Ban
Gets the IP address that is banned.
getIpAddress() - Method in class com.jivesoftware.community.BanFilter
Gets the currently selected IP address that bans will be filtered on.
getIPAddress() - Method in interface com.jivesoftware.community.Comment
Returns the IP address of the person that authored this comment.
getIPAddress() - Method in interface com.jivesoftware.community.Presence
Returns the IP address of the user.
getIPAddress() - Method in interface com.jivesoftware.community.Trackback
Returns the IP address of the person that authored this comment.
getIqDiscoHandler() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJavaScriptUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJavaScriptUrls() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getJIDForUser(User) - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJiveBooleanProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as a boolean or returns false if the property doesn't exist or isn't parseable.
getJiveBooleanProperty(String, boolean) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as a boolean or returns defaultValue if the property doesn't exist or isn't parseable.
getJiveContentObject() - Method in interface com.jivesoftware.community.Attachment
Returns the parent JiveContentObject of the attachment.
getJiveContentObject(int, long) - Method in interface com.jivesoftware.community.CommunityManager
Returns the JiveContentObject with the supplied objectType and objectID or null if the specified objectType is not a valid JiveContentObject.
getJiveContentObject() - Method in interface com.jivesoftware.community.Image
Returns the parent JiveContentObject of the image.
getJiveContentObject() - Method in interface com.jivesoftware.community.SearchQueryResult
This method returns a JiveContentObject this query result pertains to.
getJiveContentObject() - Method in interface com.jivesoftware.community.Trackback
Returns the JiveContentObject this trackback belongs to.
getJiveContentObjectID() - Method in interface com.jivesoftware.community.SearchQueryResult
Retrieve the unique id for the jive content object this query result pertains to.
getJiveContentObjectType() - Method in interface com.jivesoftware.community.SearchQueryResult
Retrieve the type of the jive content object this query result pertains to.
getJiveContext() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns a JiveContext object providing access to the clearspace api.
getJiveContext() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getJiveContext() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the jive context under which the filter is executing.
getJiveContext() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the jive context for the current page user
getJiveHome() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the location of the jiveHome directory.
getJiveHome() - Method in interface com.jivesoftware.community.JiveGlobals.JiveHomeProvider
Returns a String representing the real path of the jiveHome configuration directory.
getJiveIntProperty(String, int) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as an integer or returns the defaultValue if the property does't exist or the value isn't a number.
getJiveManager(Class<?>) - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of a manager if one exists for the specified class.
getJiveManager(Class) - Method in class com.jivesoftware.community.lifecycle.JiveApplication.ManagerHandler
Returns an instance of a JiveManager when given the class it is mapped too.
getJiveObject() - Method in interface com.jivesoftware.community.Activity
Returns the jive object this activity pertains to.
getJiveObject() - Method in interface com.jivesoftware.community.Comment
Returns the parent JiveContentObject of the comment.
getJiveObject(int, long) - Method in interface com.jivesoftware.community.CommunityManager
Returns the JiveObject with the supplied objectType and objectID or null if the specified objectType is not a valid JiveObject.
getJiveObject() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getJiveObject() - Method in class com.jivesoftware.community.event.ImageEvent
 
getJiveObject() - Method in exception com.jivesoftware.community.RejectedException
Returns the jive object that triggered the exception.
getJiveObjectFromURL(JiveContext, String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a JiveObject that matches the specified url or null if no object matches the specified url.
getJiveObjectURL(JiveObject) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the full (including domain name as set in the jiveURL jive property ) URL to this JiveObject or the default base url if the jive content object does not have a specific url.
getJiveProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property values of a parent Jive property as a list of strings, or an empty list if there are no children.
getJiveProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the value of the specified property or null if the value doesn't exist.
getJiveProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a Jive property.
getJivePropertyNames() - Static method in class com.jivesoftware.community.JiveGlobals
Returns all Jive property names.
getJivePropertyNames(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property names of a parent Jive property as a list of strings, or an empty list if there are no children.
getKey() - Method in class com.jivesoftware.community.AbuseType
Gets the unique key representing this abuse type.
getKey() - Method in class com.jivesoftware.community.BanLevel
Gets the key of a BanLevel object
getKey() - Method in enum com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType
 
getKey() - Method in enum com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType
 
getKey() - Method in enum com.jivesoftware.community.JiveInterceptor.Type
 
getKey() - Method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
 
getKey() - Method in enum com.jivesoftware.community.renderer.RenderTarget
Gets the key of a RenderTarget object
getKey() - Method in enum com.jivesoftware.community.renderer.RenderType
Gets the key of a RenderType object
getKey() - Method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
 
getKey() - Method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
 
getKey() - Method in enum com.jivesoftware.community.SearchQueryResult.ResultType
 
getKeywords() - Method in class com.jivesoftware.community.ProfileSearchQuery
Gets the keywords for the user search.
getLanguage() - Method in interface com.jivesoftware.community.Document
Return the ISO-639 code of the language associated with the document, or null if the document has no language specified (thus implying that it uses the global default language).
getLanguages() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the list of languages to filter results selected by the result filter.
getLanguages() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns the collection of languages that query results will be restricted to.
getLargeImagePath() - Method in interface com.jivesoftware.community.StatusLevel
 
getLastArchivedDate() - Method in interface com.jivesoftware.community.ArchiveManager
Returns the date the archiving process was last run.
getLastIndexedDate() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the date that the last update to the index was made.
getLastIndexedDate() - Method in interface com.jivesoftware.community.SearchManager
Returns the date that the last update to the index was made.
getLastLoggedIn() - Method in interface com.jivesoftware.base.User
Returns the date the user last logged in.
getLastUpdatedDate() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The last updated date of this resource.
getLastUpdateTime() - Method in interface com.jivesoftware.community.Presence
Return the time when the presence was last updated (when the user last visited).
getLatestDocument() - Method in interface com.jivesoftware.community.Community
Returns the most recently created or edited document in this community (including all sub-communities).
getLatestMessage() - Method in interface com.jivesoftware.community.Community
Returns the most recently created or edited message in this community (including all sub-communities).
getLatestMessage() - Method in interface com.jivesoftware.community.ForumThread
Returns the most recently created messages in this thread.
getLatestPost() - Method in interface com.jivesoftware.community.Blog
Returns the most recently created and published blog post on this blog.
getLeaderIds(Community, int, int) - Method in interface com.jivesoftware.community.StatusLevelCalculator
Returns a long array of user ids of community leaders given a start index and desired number of results.
getLeaders() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of system wide leaders.
getLeaders(int, int) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of system wide leaders.
getLeaders(Community) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of leaders for a specific community
getLeaders(Community, int, int) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of leaders for a specific community
getLicense() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getLicenseManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the license manager.
getLinkingObjects(JiveObject) - Method in interface com.jivesoftware.community.LinkManager
Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject.
getLinkManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a WikiLinkManager which can be used to manage links between content in the system.
getLinks(JiveObject) - Method in interface com.jivesoftware.community.LinkManager
Retrieve all the links in a particular jive object (With the exception of internal anchor links).
getLivePollCount() - Method in interface com.jivesoftware.community.PollManager
Returns a count of all live polls in the system.
getLivePollCount(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns a count of all live polls of a given type and object ID.
getLivePolls() - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of live polls in the system.
getLivePolls(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of live polls associated with the object specified by the objectType and objectID.
getLocale() - Method in interface com.jivesoftware.community.Community
Returns the locale for this community.
getLocale() - Method in class com.jivesoftware.community.EmailMessage
Return the locale for the email message.
getLocale() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the global Locale used by Jive.
getLocale(Community, User, HttpServletRequest) - Method in interface com.jivesoftware.community.LocaleManager
Returns a Locale object for the specified entity, if one exists.
getLocaleManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a locale manager which can be used to get a locale for a particular user/object.
getLocales() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a list of available locales as a sorted list of Locale objects.
getLocalizedJiveProperty(String, Locale) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a localized Jive property given its name and locale.
getLocalizedPropertyLocales(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a list of locales where this property is set.
getLocalizedString(String, WidgetContext) - Method in class com.jivesoftware.community.widget.BaseWidget
 
getLocalProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property values of a parent local property as a list of strings, or an empty list if there are no children.
getLocalProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a local property.
getLocalProperty(String, int) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a local property as an integer.
getLogDirectory() - Static method in class com.jivesoftware.base.Log
Returns the directory that log files exist in.
getLoggedSearchQueryInfo(SearchQuery) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns the logged information about the query, or null if the query has not been logged yet.
getLoginTime() - Method in interface com.jivesoftware.community.Presence
Return the time when the presence was created.
getMacros() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getMacroTagName() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the name of the macro tag Defined by the MacroTagName annotation if defined, otherwise the value of getClass().getShortName() will be used.
getMacroTagName() - Method in interface com.jivesoftware.community.renderer.RenderMacro
Returns the tag name of the macro.
getManagerHandler() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
-- Jive Internal Use --

Returns a manager handler used for initializing and acquring managers.

getMaxAllowableHeight() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum allowable height for an avatar image
getMaxAllowableWidth() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum allowable width for an avatar image
getMaxAttachmentSize() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum size of an individual attachment in kilobytes.
getMaxAttachmentsPerBlogPost() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per blog post.
getMaxAttachmentsPerDocument() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per document.
getMaxAttachmentsPerMessage() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per message.
getMaxBodySize() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns the maximum size of an individual binary document body in kilobytes.
getMaxCacheSize() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getMaxCommunityIndex() - Method in interface com.jivesoftware.community.Community
Returns the largest community index value for a message in the community.
getMaxFieldSize() - Method in interface com.jivesoftware.community.DocumentField
Returns the maximum data size for the field.
getMaxFileSystemCacheSize() - Method in interface com.jivesoftware.community.StorageManager
Returns the maximum amount of storage (in bytes) that will be used by the file system cache when database binary object mode is enabled.
getMaxForumMessageID() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns the maximum ID for forum messages being imported.
getMaxForumThreadID() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns the maximum ID for forum threads being imported.
getMaxImageSize() - Method in interface com.jivesoftware.community.ImageManager
Returns the maximum size of an individual image in kilobytes.
getMaxImagesPerObject() - Method in interface com.jivesoftware.community.ImageManager
Returns the maximum number of images per document.
getMaxLifetime() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getMaxMessagesPerUser() - Method in interface com.jivesoftware.community.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.community.StatusLevel
Returns the maximum value for a status level point range. -1 means unbounded (unless there is a group specified)
getMaxResultCount() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
The maximum number of results you want returned from #performSearch.
getMaxUserAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum amount of avatars a user is allowed to have, -1 for limitless
getMaxValue() - Method in class com.jivesoftware.community.ProfileSearchFilter
Gets the maximum value that will be used to filter the user results.
getMeanRating(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
A convenience method which returns a geometric mean average of all the ratings given to the JiveContentObject.
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.community.AbuseReport
Gets the forum message that caused this abuse report.
getMessage() - Method in class com.jivesoftware.community.event.EmailEvent
Returns the Message that the event corresponds to.
getMessage() - Method in class com.jivesoftware.community.event.MessageEvent
Returns the ForumMessage that the event corresponds to.
getMessage(long) - Method in interface com.jivesoftware.community.ForumManager
Returns the forum message with the specified messageID.
getMessage(long) - Method in interface com.jivesoftware.community.ForumThread
Returns a message from this thread based on its id.
getMessage() - Method in exception com.jivesoftware.community.ImageException
 
getMessage(long) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the specified private message.
getMessageCount() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of messages in the community.
getMessageCount(ThreadResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of messages in the community based on the specified ResultFilter.
getMessageCount() - Method in interface com.jivesoftware.community.ForumThread
Returns the number of messages in the thread.
getMessageCount(ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumThread
Returns the number of messages in this thread based on the specified result filter.
getMessageCount(ModerationFilter, AuthToken) - Method in interface com.jivesoftware.community.ModerationManager
Gets the number of moderated messages in the system
getMessageCount(Community) - Method in interface com.jivesoftware.community.ModerationManager
Gets the number of moderated messages in a community
getMessageCount(ModerationFilter, Community) - Method in interface com.jivesoftware.community.ModerationManager
Gets the number of moderated messages in a community
getMessageCount() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the number of messages in the folder.
getMessageCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of private messages a user has in their mailbox.
getMessageDepth(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the depth of a message in the message tree hierarchy.
getMessageID(long, int) - Method in interface com.jivesoftware.community.ForumManager
Returns the message ID with the specified communityID and communityIndex, or -1 if the communityIndex does not map to a message.
getMessages() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all the messages in the community.
getMessages(ThreadResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all the messages in the community that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.community.ForumThread
Return an Iterable for all the messages in this thread.
getMessages(ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumThread
Returns a Iterable for all the messages in the thread that match the criteria specified by the ResultFilter.
getMessages(AuthToken) - Method in interface com.jivesoftware.community.ModerationManager
This method will return a list of messages where the user is a moderator.
getMessages(ModerationFilter, AuthToken) - Method in interface com.jivesoftware.community.ModerationManager
This method will return a list of messages where the user is a moderator.
getMessages(AuthToken, Community) - Method in interface com.jivesoftware.community.ModerationManager
Gets a list of moderated messages for a particular community.
getMessages(ModerationFilter, AuthToken, Community) - Method in interface com.jivesoftware.community.ModerationManager
Gets a list of moderated messages for a particular community.
getMessages() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns all the messages in the folder sorted by date descending.
getMessages(int, int, int, boolean) - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns messages in the folder based on the params.
getMessageSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the MessageSearchQueryCriteria that can be used to specify criteria to sort and/or filter message search results.
getMessageSortType(int) - Static method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
A helper method to get a specific MessageSortType object from its key
getMessageToken(long, long) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Uses the supplied user id and message id to build a token string which can be used to identify and authenticate that user and message.
getMinCommunityIndex() - Method in interface com.jivesoftware.community.Community
Returns the smallest community index value for a message in the community.
getMinimum() - Method in class com.jivesoftware.community.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.community.StatusLevel
Returns the minimum value for a status level point range. -1 means unbounded (unless there is a group specified)
getMinServerVersion() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getMinValue() - Method in class com.jivesoftware.community.ProfileSearchFilter
Gets the minimum value that will be used to filter the user results.
getModerationAvatarCount() - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire a count of all the avatars that require moderation.
getModerationAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns a collection of all of the avatars that require moderation.
getModerationDefaultMessageValue() - Method in interface com.jivesoftware.community.Community
Returns the default number of moderation points for messages created in the community.
getModerationDefaultThreadValue() - Method in interface com.jivesoftware.community.Community
Returns the default number of moderation points for threads created in the community.
getModerationManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a moderation manager that can be used for moderating messages
getModerationRangeMax() - Method in class com.jivesoftware.community.ModerationFilter
 
getModerationRangeMax() - Method in class com.jivesoftware.community.ThreadResultFilter
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.community.ModerationFilter
 
getModerationRangeMin() - Method in class com.jivesoftware.community.ThreadResultFilter
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.community.ForumMessage
Returns the number of moderation points this message has.
getModerationValue() - Method in interface com.jivesoftware.community.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.User
Returns the date that the user was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Attachment
Returns the date the attachment was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Blog
Returns the date that the blog name, display name or description was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.BlogPost
Returns the date that this post was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Comment
Returns the date that the comment was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Community
Returns the Date this community was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Document
A convenience method which returns the date the document was last modified as determined by the version with a DocumentState.PUBLISHED state, or if no version has that state the modification date of the current instance of the document.
getModificationDate() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the date the document version was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Draft
Returns the date that the draft was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.ForumMessage
Returns the date this message was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.ForumThread
Returns the date that this thread was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Image
Returns the date the image was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.JiveContentObject
Gets the modification date of the jive object
getModificationDate() - Method in interface com.jivesoftware.community.Poll
Returns the date the poll was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the modification date of the jive content object this query result pertains to.
getModificationDate() - Method in interface com.jivesoftware.community.TagSet
A convenience method which returns the date the tag set was last modified

When a tag set is first created, the date returned by this method is identical to the creation date.

getModificationDate() - Method in interface com.jivesoftware.community.Trackback
Returns the date this trackback was last modified.
getModificationDateRangeMax() - Method in class com.jivesoftware.community.ResultFilter
Returns the date that represents the upper boundry for modification dates that will pass the result filter.
getModificationDateRangeMin() - Method in class com.jivesoftware.community.ResultFilter
Returns the date that represents the lower boundry for modification dates that will pass the result filter.
getModifiedObject() - Method in class com.jivesoftware.spi.ServiceEvent
Retrieve the object that was modified.
getModValue() - Method in interface com.jivesoftware.community.Avatar
Returns the moderation value for this Avatar
getModValueList() - Method in class com.jivesoftware.community.ModerationFilter
Gets a list of moderation values that will be used to filter results.
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 class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getName() - Method in interface com.jivesoftware.base.User
Returns the user's name.
getName() - Method in interface com.jivesoftware.community.Attachment
Returns the name of the attachment.
getName() - Method in interface com.jivesoftware.community.BinaryBody
Returns the name of the body object.
getName() - Method in interface com.jivesoftware.community.Blog
Returns the name of the blog.
getName() - Method in class com.jivesoftware.community.cache.DefaultCache
 
getName() - Method in interface com.jivesoftware.community.Comment
Returns the name of the person that authored this comment.
getName() - Method in interface com.jivesoftware.community.Community
Returns the name of the community.
getName() - Method in interface com.jivesoftware.community.ContentTag
The name of the tag
getName() - Method in interface com.jivesoftware.community.DocumentField
Returns the unique name of the document field.
getName() - Method in enum com.jivesoftware.community.DocumentFieldType.DataType
 
getName() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns unique name of this Document Field Type.
getName() - Method in interface com.jivesoftware.community.DocumentPresenter
Returns the identifying name of the document presenter.
getName() - Method in interface com.jivesoftware.community.DocumentType
Returns the name of the document type.
getName() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns the text representation of this Type
getName() - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
getName() - Method in interface com.jivesoftware.community.ForumThread
Returns the subject of the root message of this thread.
getName() - Method in interface com.jivesoftware.community.Image
Returns the name of the image.
getName() - Method in interface com.jivesoftware.community.Poll
Returns the name of the poll.
getName() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the name of the folder.
getName() - Method in class com.jivesoftware.community.ProfileField
Gets the internal name of this profile field.
getName() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getName() - Method in class com.jivesoftware.community.renderer.BaseFilter
Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().
getName() - Method in interface com.jivesoftware.community.renderer.RenderFilter
Returns the unique name of the filter.
getName() - Method in enum com.jivesoftware.community.renderer.RenderType
Returns a string based key representing this render type.
getName() - Method in interface com.jivesoftware.community.StatusLevel
Returns the name of this status level
getName() - Method in interface com.jivesoftware.community.TagSet
Returns the name of this TagSet.
getNestedThrowable() - Method in exception com.jivesoftware.base.UnauthorizedException
 
getNewestDocumentVersion() - Method in interface com.jivesoftware.community.VersionManager
Convenience method which returns the newest document version as determined by version number.
getNextPost() - Method in interface com.jivesoftware.community.BlogPost
Returns the next blogpost that has been published or null if this is the most recent post.
getNNTPName() - Method in interface com.jivesoftware.community.Community
Returns the NNTP name for the community, which is the name of the community used in the NNTP protocol (newsgroups).
getNonAuthenticatedCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getNonParseableCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getNumberOfAbuseReports(ForumMessage) - Method in interface com.jivesoftware.community.AbuseManager
Gets the number of abuse reports for a particular message
getNumResults() - Method in class com.jivesoftware.community.QuestionFilter
Returns the max number of results that should be returned.
getNumResults() - Method in class com.jivesoftware.community.ResultFilter
Returns the max number of results that should be returned.
getObjectID() - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
getObjectID() - Method in interface com.jivesoftware.community.TrackbackManager
Returns the id of the object managed by this instance.
getObjectID() - Method in interface com.jivesoftware.community.Watch
Returns the object ID of the object being watched.
getObjectType() - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
getObjectType() - Method in class com.jivesoftware.community.EntityDescriptor
Returns the type of object this is.
getObjectType() - Method in interface com.jivesoftware.community.JiveObject
Return the object type of the jive object.
getObjectType() - Method in interface com.jivesoftware.community.TrackbackManager
Returns the type (one of the values in JiveConstants) of the object managed by this instance.
getObjectType() - Method in interface com.jivesoftware.community.Watch
Returns the object type of the object being watched.
getOnlineGuestCount() - Method in interface com.jivesoftware.community.PresenceManager
Returns the number of guests who are currently online.
getOnlineUserCount() - Method in interface com.jivesoftware.community.PresenceManager
Returns the number of users who are currently online.
getOnlineUserCount(Group) - Method in interface com.jivesoftware.community.PresenceManager
Returns the number of users in the group who are currently online.
getOnlineUserCount() - Method in interface com.jivesoftware.community.Roster
Returns the number of users in the roster who are currently online.
getOnlineUsers() - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online.
getOnlineUsers(Group) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users in the group who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(Group, boolean, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(boolean, int, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(Group, boolean, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers() - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users in the roster who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users who are currently online matching the criteria given.
getOption(long) - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Returns a DocumentFieldOption by its id.
getOption(int) - Method in interface com.jivesoftware.community.Poll
Returns the text of the option at the specified index.
getOptionCount() - Method in interface com.jivesoftware.community.Poll
Returns the number of options available in the poll.
getOptionIDs() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getOptionIDs() - Method in class com.jivesoftware.community.ProfileFieldValue
Gets a list of the selected options.
getOptions() - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Returns an iterator of DocumentFieldOption objects.
getOptions() - Method in class com.jivesoftware.community.ProfileField
Gets a list of ProfileFieldOption objects for this profile field.
getOwner() - Method in interface com.jivesoftware.community.Avatar
Returns user who created this avatar, if the user is null then this is a global avatar
getOwner() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the owner of the private message folder.
getPageURL() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the URL of the current page as a string.
getParameters() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the parameters passed into this tag.
getParameters() - Method in interface com.jivesoftware.community.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.UserEvent
 
getParams() - Method in class com.jivesoftware.community.event.AnnouncementEvent
 
getParams() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getParams() - Method in class com.jivesoftware.community.event.BlogEvent
 
getParams() - Method in class com.jivesoftware.community.event.BlogPostEvent
 
getParams() - Method in class com.jivesoftware.community.event.CommentEvent
 
getParams() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getParams() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getParams() - Method in class com.jivesoftware.community.event.EmailEvent
 
getParams() - Method in class com.jivesoftware.community.event.ImageEvent
 
getParams() - Method in class com.jivesoftware.community.event.MessageEvent
 
getParams() - Method in class com.jivesoftware.community.event.PollEvent
 
getParams() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
 
getParams() - Method in class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
getParams() - Method in class com.jivesoftware.community.event.QuestionEvent
 
getParams() - Method in class com.jivesoftware.community.event.SearchIndexEvent
 
getParams() - Method in class com.jivesoftware.community.event.StorageManagerEvent
 
getParams() - Method in class com.jivesoftware.community.event.TagEvent
 
getParams() - Method in class com.jivesoftware.community.event.TagSetEvent
 
getParams() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getParams() - Method in class com.jivesoftware.community.event.TrackbackEvent
 
getParams() - Method in interface com.jivesoftware.community.JiveEvent
Returns a map of parameters which can be used to pass data to a listener.
getParent(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the parent of the child comment.
getParent(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the parent of the child ForumMessage.
getParentCommunity() - Method in interface com.jivesoftware.community.Community
Returns the parent community of this community.
getParentMessage() - Method in interface com.jivesoftware.community.ForumMessage
Returns the parent message of this message or null if this message is the root message of a thread.
getParentObjectID() - Method in class com.jivesoftware.community.event.TagEvent
 
getParentObjectType() - Method in class com.jivesoftware.community.event.TagEvent
 
getParseableCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getPassword() - Method in interface com.jivesoftware.spi.user.User
return user's password
getPassword() - Method in class com.jivesoftware.spi.user.UserTemplate
 
getPasswordHash() - Method in interface com.jivesoftware.base.User
Returns the user's password in hashed form.
getPasswordHash() - Method in interface com.jivesoftware.spi.user.User
return user's password hash
getPasswordHash() - Method in class com.jivesoftware.spi.user.UserTemplate
 
getPercentComplete() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getPercentComplete() - Method in interface com.jivesoftware.community.SearchManager
Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getPermalink() - Method in interface com.jivesoftware.community.BlogPost
Returns the permalink for this post, where the permalink is a composed only of unreserved characters: unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" as according to RFC 3986: http://www.ietf.org/rfc/rfc3986.txt Space characters and characters not in the list of unreserved characters are replaced with a hyphen character.
getPermissionCount(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of permissions to be imported for the given ID
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.community.Blog
Returns the permissions for the blog that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.Community
Returns the permissions for the community that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.Document
Returns the permissions for the document that correspond to the passed-in AuthToken.
getPermissions(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns the permission import bean corresponding to the given ID
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.JiveContext
Returns the global permissions that correspond to the passed-in AuthToken.
getPermissionsManager() - Method in interface com.jivesoftware.community.Community
Returns a permissions manager that can be used to set permissions for this community.
getPermissionsManager() - Method in interface com.jivesoftware.community.Document
Returns a permissions manager that can be used to set permissions for the document.
getPermissionsManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a permissions manager that can be used to set system wide permissions.
getPingServices() - Method in interface com.jivesoftware.community.Blog
Returns a line break separated list of services that the user has chosen to ping.
getPingServices() - Method in interface com.jivesoftware.community.BlogManager
Returns a comma delimited list of available ping services for the system.
getPlainBody() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the body of the jive object content with no markup applied.
getPlainSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the title of the jive object content with no markup applied
getPlugin(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a plugin by name or null if a plugin with that name does not exist.
getPlugin() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginClassloader(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns the classloader of a plugin.
getPluginCSSSrcURLs() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a list of all CSS source urls defined by plugins
getPluginDirectory(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns the plugin's directory.
getPluginDirectory() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns the directory {jiveHome}/plugins.
getPluginDirectory() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginJavascriptSrcURLs() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a list of all javascript source urls defined by plugins
getPluginManager() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the plugin which can be used for acquiring plugin instances.
getPluginMap() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a map of plugin name plugin entries.
getPluginMetaData() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns meta data about the plugin this macro is deployed in.
getPluginMetaData(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns meta data associated with the plugin.
getPluginMetaData(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns meta data assosiated with the plugin.
getPluginMonitor() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns the PluginMonitor instance.
getPluginProperties(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a object for storing and receving property setting for a plugin.
getPluginProperties() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginResourceBundle(Plugin<?>, Locale) - Method in class com.jivesoftware.base.plugin.PluginManager
Acquires a plugins resource bundle which should be stored in /plugin_i18n in the plugin's classloader.
getPluginResourceBundle(Locale) - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginResourceBundles(Locale) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns all of the plugin resource bundles that match the specified locale.
getPlugins() - Method in class com.jivesoftware.base.plugin.PluginManager
Returns a Collection of all installed plugins.
getPointLevel(User, Community) - Method in interface com.jivesoftware.community.StatusLevelCalculator
Returns the status level points for a user in regards to a specific community
getPointLevel(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the point level for a user system wide.
getPointLevel(User, Community) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the status level points for a user in regards to a specific community
getPoints() - Method in class com.jivesoftware.community.ProfileSearchResult
Gets the StatusLevel points for this user.
getPointStatusLevels() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an iterable of point based status levels in the system sorted by point range.
getPoll() - Method in class com.jivesoftware.community.event.PollEvent
Returns the Poll that the event corresponds to.
getPoll(long) - Method in interface com.jivesoftware.community.PollManager
Returns the Poll specified by the poll ID.
getPollCount(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of polls to be imported for the given ID
getPollCount() - Method in interface com.jivesoftware.community.PollManager
Returns a count of all polls, both active and inactive.
getPollCount(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPollManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a poll manager that can be used to retrieve and manager polls.
getPolls(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of poll import beans corresponding to the polls in the given ID
getPolls() - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of all polls, both active and inactive.
getPolls(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPopularBlogPosts() - Method in interface com.jivesoftware.community.Blog
Returns the top x blog posts according to blog post views, number of comments & time passed since the blog post was created.
getPopularBlogPosts() - Method in interface com.jivesoftware.community.BlogManager
Returns the top x blog posts according to blog post views, number of comments & time passed since the blog post was created.
getPopularDocuments() - Method in interface com.jivesoftware.community.Community
Returns the top x documents according to document views, number of comments & time passed since the document was created.
getPopularDocuments() - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across all communities according to ratings, document views & time passed since the document was created.
getPopularDocuments(List<String>) - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across all communities according to ratings, document views & time passed since the document was created in the languages specified.
getPopularDocumentsByCommunity(Community) - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across a given community & it's subcommunities according to ratings, document views & time passed since the document was created in the languages specified.
getPopularTags() - Method in interface com.jivesoftware.community.Blog
Returns the 20 most popular tags for a given blog 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 blog.
getPopularThreads() - Method in interface com.jivesoftware.community.Community
Returns the top x threads according to thread views, replies per thread & time passed since the thread was last modified.
getPopularThreads() - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for the most threads in the system as ForumThread objects.
getPostPermalink(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a permalink for a blog post which is a combination of the base URL, the blog display name and the post permalink.
getPresence(User) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getPresence(User) - Method in interface com.jivesoftware.community.PresenceManager
Returns the presence for the user, or null if the user isn't online.
getPresence(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a particular XMPP address, or null if is unavailable (offline) or if no presence information is available.
getPresence(User) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a User, or null if is unavailable (offline) or if no presence information is available.
getPresenceForResource(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a particular XMPP address resource, or null if the resource is unavailable (offline) or if no presence information is available.
getPresenceManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a presence manager that can be used to retrieve and manage presences.
getPresences(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns a collection Presence information for all the user's current resources or null if the user is unavailable (offline) or if no presence information is available.
getPreviousPost() - Method in interface com.jivesoftware.community.BlogPost
Returns the previous blogpost that has been published or null if this is the first post.
getPrivateMessage() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
Returns the ForumMessage that the event corresponds to.
getPrivateMessageFolders(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of private message folder import beans corresponding to the private message folders for the given user
getPrivateMessageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a private message manager, which controls private message settings.
getProfile(User) - Method in interface com.jivesoftware.community.ProfileManager
Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.
getProfileField(long) - Method in interface com.jivesoftware.community.ProfileFieldManager
Gets a profile field object by its id.
getProfileFieldCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of profile fields to be imported
getProfileFieldManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile field manager.
getProfileFields() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of profile field import beans corresponding to the profile fields to be imported
getProfileFields() - Method in interface com.jivesoftware.community.ProfileFieldManager
Gets the list of all profile fields in the system.
getProfileImage(User) - Method in interface com.jivesoftware.community.ProfileManager
Returns the profile image for a user.
getProfileManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile manager.
getProfileSearchManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile search manager.
getProperties() - Method in interface com.jivesoftware.base.Group
Retrieve a map of all the extended properties for the group.
getProperties() - Method in interface com.jivesoftware.base.User
Retrieve a map of all the extended properties for the user.
getProperties() - Method in interface com.jivesoftware.community.Announcement
Retrieve a map of all the extended properties for the announcement.
getProperties() - Method in interface com.jivesoftware.community.Attachment
Retrieve a map of all the extended properties for the attachment.
getProperties() - Method in interface com.jivesoftware.community.Avatar
Retrieve a map of all the extended properties for the avatar.
getProperties() - Method in interface com.jivesoftware.community.Blog
Retrieve a map of all the extended properties for the blog.
getProperties() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a map of all the extended properties for the post.
getProperties() - Method in interface com.jivesoftware.community.Comment
Retrieve a map of all the extended properties for the comment.
getProperties() - Method in interface com.jivesoftware.community.Community
Retrieve a map of all the extended properties for the community.
getProperties() - Method in interface com.jivesoftware.community.Document
Retrieve a map of all the extended properties for the document.
getProperties() - Method in interface com.jivesoftware.community.DocumentType
Retrieve a map of all the extended properties for the document type.
getProperties() - Method in interface com.jivesoftware.community.Draft
Returns a map of properties associated with this draft.
getProperties() - Method in interface com.jivesoftware.community.ForumMessage
Retrieve a map of all the extended properties for the message.
getProperties() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a map of all the extended properties for the thread.
getProperties() - Method in interface com.jivesoftware.community.PrivateMessage
Retrieve a map of all the extended properties for the private message.
getProperties() - Method in interface com.jivesoftware.community.Question
Retrieve a map of all the extended properties for the question.
getProperties() - Method in interface com.jivesoftware.community.Trackback
Retrieve a map of all the extended properties for the trackback.
getProperties() - Method in class com.jivesoftware.spi.ServiceEvent
Retrieve properties associated with the event
getPropertyCount() - Method in class com.jivesoftware.community.QuestionFilter
Returns the number of properties that results will be filtered on.
getPropertyCount() - Method in class com.jivesoftware.community.ResultFilter
Returns the number of properties that results will be filtered on.
getPropertyMatchType(int) - Method in class com.jivesoftware.community.ResultFilter
Returns the value of the property at the specified index in the list of properties.
getPropertyMode() - Method in class com.jivesoftware.community.ResultFilter
Returns the mode that will be used to select results if multiple properties have been specified.
getPropertyName(int) - Method in class com.jivesoftware.community.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.community.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.community.JiveProperties
Returns all property names as a Collection of String values.
getPropertyValue(int) - Method in class com.jivesoftware.community.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.community.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.community.ResultFilter
Returns the value of the property at the specified index in the list of properties to be filtered on.
getPublishDate() - Method in interface com.jivesoftware.community.BlogPost
Returns that date that this post should be published.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns a date that represents the upper boundry for blog posts to be selected by the result filter.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.BlogTagResultFilter
Returns a date that represents the upper boundry for tags to be selected by the result filter.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.BlogTagResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getPublishedDate() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The published date of this resource.
getPublishedDocumentVersion() - Method in interface com.jivesoftware.community.VersionManager
Convenience method which returns the published document version.
getPublishedWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the map containing all the published WidgetFrames for the specified parent JiveObject.
getQueryString() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the search query string for the SearchQuery object.
getQueryTestTerm() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the test term that is used for performing the test query.
getQuestion() - Method in class com.jivesoftware.community.event.QuestionEvent
Returns the Question that the event corresponds to.
getQuestion() - Method in interface com.jivesoftware.community.ForumThread
Returns the question associated with a thread or null if the question does not exist.
getQuestion(ForumThread) - Method in interface com.jivesoftware.community.QuestionManager
Returns the question associated with a thread.
getQuestionAnswerCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of all the question answer data in the system
getQuestionAnswers() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns all the question answer data
getQuestionCount() - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in the system.
getQuestionCount(QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in the system that pass the specified question filter.
getQuestionCount(Community) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in a community.
getQuestionCount(Community, QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of questions in a community that pass the specified question filter.
getQuestionManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a QuestionManager, which can be used to manage Questions.
getQuestions() - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in the system.
getQuestions(QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in the system that pass the specified question filter.
getQuestions(Community) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in a community.
getQuestions(Community, QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in a categetory that pass the specified question filter.
getRating(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns the rating associated with the user, or null if this user hasn't rated the JiveContentObject.
getRatingCount(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of ratings to be imported for the given ID
getRatingCount(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns the total number of ratings given to the JiveContentObject.
getRatingDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a rating delegator to manage blog post ratings.
getRatingDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a rating delegator to manage document ratings.
getRatingDelegator() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a rating delegator to manage thread ratings.
getRatingFromScore(int) - Method in interface com.jivesoftware.community.RatingManager
Retrieve the rating with the specified score.
getRatingManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a RatingManager which can be used to add, retrieve and manage ratings
getRatings(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of rating import beans corresponding to the ratings to be imported in the given ID
getRatings(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns an Iterable of all the ratings given to the JiveContentObject.
getRatingTypeCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of rating types to be imported
getRatingTypes() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of rating type import beans corresponding to the rating types to be imported
getReadStatus(User, ForumThread) - Method in interface com.jivesoftware.community.ReadTracker
Returns the read status on the specified thread.
getReadStatus(User, ForumMessage) - Method in interface com.jivesoftware.community.ReadTracker
Returns the read status on the specified message.
getReadTracker() - Method in interface com.jivesoftware.community.JiveContext
Returns a read tracker that can be used to track which threads and messages a user has read.
getRecentBlogPosts() - Method in interface com.jivesoftware.community.Blog
Returns (at most) the ten most recent blog posts on this blog.
getRecentBlogs() - Method in interface com.jivesoftware.community.BlogManager
Returns (at most) the ten most recent blogs created on this system.
getRecentComments() - Method in interface com.jivesoftware.community.Blog
Returns (at most) the ten most recent comments on this blog.
getRecipient() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the user the message was sent to.
getRecipients() - Method in class com.jivesoftware.community.EmailMessage
Returns the recipients of the email
getRecursiveChildCount(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the total number of recursive children of a parent.
getRecursiveChildCount(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the total number of recursive children of a parent.
getRecursiveChildren(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns an Iterable for all child messages (and sub-children, etc) of the parent.
getRecursiveCommunities() - Method in interface com.jivesoftware.community.Community
Returns an Iterable for all sub-communities of this community, including sub-communities of sub-communities, etc.
getRecursiveCommunityCount() - Method in interface com.jivesoftware.community.Community
Returns the total count of all sub-communities of this community, including sub-communities of sub-communities, etc.
getRecursiveMessages() - Method in interface com.jivesoftware.community.TreeWalker
Returns an Iterable for all messages in the thread in depth-first order.
getRegistrationManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a validation manager that can be used for validating user accounts
getRejectionType() - Method in exception com.jivesoftware.community.PrivateMessageRejectedException
Returns the type of the rejection exception.
getRelevance() - Method in class com.jivesoftware.community.ProfileSearchResult
Gets the search relevance for this user, a floating point number between 0.0 and 1.0.
getRelevance() - Method in interface com.jivesoftware.community.SearchQueryResult
Get the relevance of this query result as determined by the search engine.
getRelevanceAsPercentage(Locale) - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the relevance as a percentage (no decimal places) formatted according to the locale passed in.
getRenderCacheManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the render cache manager, used for caching rendered content fields.
getRenderedTextStore() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the text store associated with the context.
getRenderFilter(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Return the render filter with the specified name
getRenderFilterCount() - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns the count of currently installed render filters.
getRenderFilters() - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns an array of RenderFilter objects that list all the currently configured render filters.
getRenderFilters() - Method in class com.jivesoftware.community.renderer.RenderPipe
 
getRenderManager() - Method in interface com.jivesoftware.community.Community
Returns a render manager that can be used to manage render filters and macros for this community.
getRenderManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a render manager that can be used to manage system wide render filters and macros.
getRenderManager() - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns a render manager for private messages in the system.
getRenderPipe() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the render pipe that will be used for rendering.
getRenderStrategy() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the render strategy that will be used for rendering.
getRenderTarget(int) - Static method in enum com.jivesoftware.community.renderer.RenderTarget
A helper method to get a specific RenderTarget object from its key
getRenderType(int) - Static method in enum com.jivesoftware.community.renderer.RenderType
A helper method to get a specific RenderType object from its key
getRenderType(String) - Static method in enum com.jivesoftware.community.renderer.RenderType
 
getReportDate() - Method in class com.jivesoftware.community.AbuseReport
Gets the date that this abuse report was created.
getRequest() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getRequest() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the http servlet request object
getReservedURIs() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a list of reserved words that cannot be used by blog authors as display names.
getResolutionDate() - Method in interface com.jivesoftware.community.Question
Returns the date that question was resolved, or null if the question has not been resolved.
getResolutionDateRangeMax() - Method in class com.jivesoftware.community.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.community.ThreadResultFilter
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.community.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.community.ThreadResultFilter
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.community.QuestionFilter
Returns the set resolution states that will be included in filtered results.
getResolutionStates() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the set resolution states that will be included in filtered results.
getResourceURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The link to the search result resource.
getResponse() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getResponse() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the http servlet response object
getResultBlogCount(Blog) - Method in interface com.jivesoftware.community.SearchQuery
Returns the number of blog posts results in the search that match the given blog.
getResultBlogs() - Method in interface com.jivesoftware.community.SearchQuery
Returns an Iterable of the Blogs that search results are from.
getResultCommunities() - Method in interface com.jivesoftware.community.SearchQuery
Returns an Iterable of the Communities that search results are from.
getResultCommunityCount(Community) - Method in interface com.jivesoftware.community.SearchQuery
Returns the number of document results in the search that match the given community.
getResultCount() - Method in interface com.jivesoftware.community.SearchQuery
Returns the total number of results of the query for all result types.
getResultCount(List<SearchQueryResult.ResultType>) - Method in interface com.jivesoftware.community.SearchQuery
Returns the total number of results of the query across the provided list of result types.
getResults() - Method in interface com.jivesoftware.community.SearchQuery
Returns the search query results for all result types.
getResults(List<SearchQueryResult.ResultType>) - Method in interface com.jivesoftware.community.SearchQuery
Returns the search query results across the provided list of result types.
getResults(int, int) - Method in interface com.jivesoftware.community.SearchQuery
Returns the results of the query for all result types.
getResults(List<SearchQueryResult.ResultType>, int, int) - Method in interface com.jivesoftware.community.SearchQuery
Returns the results of the query across the provided list of result types.
getResultType() - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the ResultType for this search query result.
getResultType(int) - Static method in enum com.jivesoftware.community.SearchQueryResult.ResultType
A helper method to get a specific ResultType object from its key
getReviewerCount() - Method in interface com.jivesoftware.community.Document
Returns the count of reviewers which have been added to this document.
getReviewers() - Method in interface com.jivesoftware.community.Document
Returns the Users who are intended to review the document.
getRoot() - Method in interface com.jivesoftware.community.TreeWalker
Returns the root of the tree.
getRootCommunity() - Method in interface com.jivesoftware.community.CommunityManager
Returns the "root" community that all other communities are children of.
getRootMessage() - Method in interface com.jivesoftware.community.ForumThread
Returns the root message this thread.
getRoster(User) - Method in interface com.jivesoftware.community.PresenceManager
Returns the user's roster.
getScore() - Method in interface com.jivesoftware.community.Rating
Retrieve the score for the rating.
getSearchableURL(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the search URL with the {searchTerms} token substitued by the argument.
getSearchEngineByID(long) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Find a managed search engine by its ID.
getSearchEngineManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a SearchEngineManager which can be used to manager OpenSearch search engines.
getSearchEngines() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Get a List of all managed search engines.
getSearchHttpMethod() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the Http method (i.e.
getSearchManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the search manager which can be used to manage the index used by Jive to perform searches.
getSearchQueries() - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns an iterable of all the queries that have been made.
getSearchQueries(User) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns an Iterable consisting of all the SearchQuery's that the specified user has made.
getSearchQuery(long) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns the query associated with the given queryID.
getSearchQueryCount() - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns a count of all the queries that have been made in the system.
getSearchQueryCount(User) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns a count of all the queries that the user has made.
getSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQuery
Returns the criteria that will be used to return results.
getSearchQueryManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the search query manager which can be used to create SearchQuery objects for searching document/messages and blog posts.
getSearchResultContentType() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the content type (i.e. text/xml) of search results.
getSearchURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get an OpenSearch compliant URL that can be queried against.
getSearchURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the script that accepts search queries for a blog which is a combination of the base URL, the blog display name and the search path.
getSender() - Method in class com.jivesoftware.community.EmailMessage
Returns the sender of them email
getSender() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the user the message was sent by, or null if the message was sent by the system.
getSenderName() - Method in interface com.jivesoftware.community.Trackback
Returns the sender name of the trackback.
getServerInfoCookieProperty(InitialContext, String, String) - Static method in class com.jivesoftware.base.AuthFactory
This method will see if a property for the jive.server.info cookie is on the initial context under java:comp/env/jive/{myprop} if not found there it will check jive local properties for the property under jive.server.info.
getServerInformation() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns information about the XMPP server as well as some basic statistics.
getServerVersion() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns information about the XMPP server version.
getSession() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getSessionAuthToken(HttpServletRequest) - Static method in class com.jivesoftware.base.AuthFactory
Returns the authToken in the session, if one does not exist an anonymous authToken will be returned.
getSessionUser(HttpServletRequest) - Static method in class com.jivesoftware.base.AuthFactory
Returns the currently logged in user.
getSettings(User) - Method in interface com.jivesoftware.community.WatchManager
Retrieve a watch settings for the given user
getShortName() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the short name of the search engine.
getSimilarUserResults(long) - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the hits that are similar to the specified user.
getSize() - Method in interface com.jivesoftware.community.Attachment
Returns the size of the attachment in bytes.
getSize() - Method in interface com.jivesoftware.community.BinaryBody
Returns the size of the body object in bytes.
getSize() - Method in interface com.jivesoftware.community.Image
Returns the size of the image in bytes.
getSize() - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Returns the number of items in the store.
getSort() - Method in class com.jivesoftware.community.ProfileSearchQuery
Gets the sort used for this query.
getSortDocumentField() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the document field that will be sorted on.
getSortField() - Method in class com.jivesoftware.community.BanFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.QuestionFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.ResultFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the currently selected sort field.
getSortOrder() - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected sort order.
getSortOrder() - Method in class com.jivesoftware.community.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.community.ResultFilter
Returns the sort order, which will be ResultFilter.ASCENDING for ascending sorting, or ResultFilter.DESCENDING for descending sorting.
getSortOrder() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the sort order, which will be SearchQueryCriteria.SortOrder.ASCENDING for ascending sorting, or SearchQueryCriteria.SortOrder.DESCENDING for descending sorting.
getSortOrder(int) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
A helper method to get a specific SortOrder object from its key
getSortPropertyName() - Method in class com.jivesoftware.community.QuestionFilter
Returns the name of the extended property that will be sorted on.
getSortPropertyName() - Method in class com.jivesoftware.community.ResultFilter
Returns the name of the extended property that will be sorted on.
getSortType() - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType(int) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
A helper method to get a specific SortType object from its key
getSourceObject() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the source object for which we're filtering a string from.
getSpiProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
 
getSpiProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
 
getStartDate() - Method in interface com.jivesoftware.community.Announcement
Returns the date when the announcement should first be visible.
getStartDate() - Method in interface com.jivesoftware.community.importer.Importer
Returns the date the import started or null if the import has not yet started
getStartDate() - Method in interface com.jivesoftware.community.Poll
Returns the date voting for the poll is set to start.
getStartIndex() - Method in class com.jivesoftware.community.QuestionFilter
Returns the index of the first result to return.
getStartIndex() - Method in class com.jivesoftware.community.ResultFilter
Returns the index of the first result to return.
getStartupDate() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the date the Jive system was started.
getState() - Method in enum com.jivesoftware.community.DocumentState
 
getState() - Method in interface com.jivesoftware.community.Question
Returns the resolution state of this question.
getStats() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Get a {@link SearchEngineManagerStats) object.
getStatus() - Method in interface com.jivesoftware.community.BlogPost
Returns the status of this blog post which may be any one of the following: PENDING_APPROVAL -- post has status of unpublished PUBLISH -- post has status of published.
getStatus() - Method in interface com.jivesoftware.community.Presence
Returns the status of the presence.
getStatusLevel(long) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to acquire a specific status level object from the system
getStatusLevel(String) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to acquire a specific status level by its name
getStatusLevel(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the system wide status level for specific user, will return null if there is no status level for this user.
getStatusLevel(User, Community) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the status level for a user in a specific community. if a status level cannot be determined for this user in this community null will be returned.
getStatusLevel(Group) - Method in interface com.jivesoftware.community.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(long) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to get a status level by a point value.
getStatusLevelCorrectPoints() - Method in interface com.jivesoftware.community.importer.ImportSource
Correct answer points.
getStatusLevelCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of status levels to be imported
getStatusLevelHelpfulPoints() - Method in interface com.jivesoftware.community.importer.ImportSource
Helpful answer points.
getStatusLevelManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a StatusLevelManager that can be used to check a user status level, find leaders system wide or by community.
getStatusLevelPointsForCommunity(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns status levels points for a particular community.
getStatusLevels() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of status level import beans corresponding to the status levels to be imported
getStatusLevelScenarioByCode(String) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns a StatusLevelScenario by its code.
getStatusManager() - Method in interface com.jivesoftware.community.JiveContext
 
getStorageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a StorageManager which can be used to manage storage settings for binary objects such as attachments and images.
getStringValue() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getStringValue() - Method in class com.jivesoftware.community.ProfileFieldValue
Gets the value for this ProfileField.
getSubCommunities(CommunityImportBean) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of community import beans corresponding to the sub communities of the given parent community
getSubject() - Method in interface com.jivesoftware.community.Announcement
Returns the announcement subject.
getSubject() - Method in interface com.jivesoftware.community.BlogPost
Returns the blog post subject.
getSubject() - Method in interface com.jivesoftware.community.Document
Returns the subject of the document.
getSubject() - Method in interface com.jivesoftware.community.Draft
Returns the subject of the draft.
getSubject() - Method in class com.jivesoftware.community.EmailMessage
Returns the subject of the email.
getSubject() - Method in interface com.jivesoftware.community.ForumMessage
Returns the message subject.
getSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Return the title of the jive object content
getSubject() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message subject.
getSubjectProperty() - Method in class com.jivesoftware.community.EmailMessage
Returns the property name for subject of the email
getSummary() - Method in interface com.jivesoftware.community.Document
Returns the summary of the document.
getSystemAuthToken() - Static method in class com.jivesoftware.base.AuthFactory
 
getSystemProperties() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a map of system properties to be imported
getTag() - Method in class com.jivesoftware.community.event.TagEvent
Returns the tag that the event corresponds to.
getTag(String) - Method in interface com.jivesoftware.community.TagManager
Returns a tag by tag name.
getTag(long) - Method in interface com.jivesoftware.community.TagManager
Returns a tag given a tag ID.
getTag(long) - Method in interface com.jivesoftware.community.TagSet
Gets the tag specified by the tagID in this TagSet
getTagCloud(Map<String, Integer>, int) - Method in interface com.jivesoftware.community.TagManager
 
getTagCloud(Map<String, Integer>, int, int) - Method in interface com.jivesoftware.community.TagManager
 
getTagDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a tag delegator to manage blog post tags.
getTagDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a tag delegator to manage document tags.
getTagDelegator() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a tag delegator to manage thread tags.
getTagFeedURL(ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed for the system and a given tag.
getTagFeedURL(List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed for the system and a given list of tags.
getTagFeedURL(Blog, ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURL(Blog, List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURL(Blog, String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURLPrefix(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the tag feed URL prefix for a given blog, which the BlogUtils.getTagFeedURL(com.jivesoftware.community.ContentTag) methods depend on.
getTagFeedURLPrefix() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the tag feed URL prefix for the system tag feeds, which the BlogUtils.getTagFeedURL(com.jivesoftware.community.ContentTag) methods depend on.
getTagManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a tag manager that can be used to manage tags.
getTagPermalink(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for the system which is a combination of the base URL, the word 'tags' and the tag.
getTagPermalink(Blog, ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and the given tag..
getTagPermalink(Blog, List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and a list of tags.
getTagPermalink(Blog, String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and the given tag or tags, delimited using a plus (+) sign.
getTags() - Method in interface com.jivesoftware.community.Blog
Returns all tags for a given blog 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 blog.
getTags(BlogTagResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all tags for a given blog 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 blog filtered by the BlogTagResultFilter.
getTags() - Method in interface com.jivesoftware.community.BlogManager
Returns all tags for blogs in the system 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 system.
getTags(BlogTagResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all tags for blogs in the system 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 system filtered by the BlogTagResultFilter.
getTags() - Method in interface com.jivesoftware.community.Community
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, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.Community
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(ID) - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of tags for the given ID
getTags() - Method in class com.jivesoftware.community.ResultFilter
Returns the the ContentTags to filter on.
getTags(JiveObject) - Method in interface com.jivesoftware.community.TagManager
Return an Iterable for all the tags associated with this manager.
getTags() - Method in interface com.jivesoftware.community.TagSet
Returns an Iterable of ContentTags which define the view this TagSet represents.
getTagSet() - Method in class com.jivesoftware.community.event.TagSetEvent
Returns the tag set that the event corresponds to.
getTagSet(long) - Method in interface com.jivesoftware.community.TagSetManager
Returns the TagSet with the supplied id.
getTagSetManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a TagSetManager that can be used to create and load TagSets.
getTagSets() - Method in interface com.jivesoftware.community.Community
Returns all TagSets which are defined for this Community.
getTagSets(Community) - Method in interface com.jivesoftware.community.TagSetManager
Returns all TagSets which are defined for the specified Community.
getTagSetsTagBelongsTo(ContentTag) - Method in interface com.jivesoftware.community.TagSetManager
Returns all TagSets that contains the specified ContentTag.
getTagsPermalink(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name and the word 'tags'.
getTarget() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
getTemplate() - Method in interface com.jivesoftware.community.DocumentPresenter
Returns the template used to display a document for a particular presenter.
getTermsURL() - Method in interface com.jivesoftware.community.RegistrationManager
Gets the string url representing the terms and conditions page
getText(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Override the getText(..) in ActionSupport so that we can intercept keys that are specific to either the internal or external editions of Clearspace.
getText(String, String, List, OgnlValueStack) - Method in class com.jivesoftware.community.action.JiveActionSupport
Override the getText(..) in ActionSupport so that we can intercept keys that are specific to either the internal or external editions of Clearspace.
getText(String, String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, List) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String[]) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, List) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String[]) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String[], OgnlValueStack) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String) - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Retrieve a text snippet from the store.
getTextBody() - Method in class com.jivesoftware.community.EmailMessage
Returns the text version of the body.
getTextBodyProperty() - Method in class com.jivesoftware.community.EmailMessage
Return the property name for the html version of the email body
getTextExtractors() - Method in interface com.jivesoftware.community.SearchManager
Returns the current collection of TextExtractor objects.
getTexts() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getTexts(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getThread() - Method in class com.jivesoftware.community.event.ThreadEvent
Returns the ForumThread that the event corresponds to.
getThreadCount() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of threads in the community.
getThreadCount(ThreadResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns the number of threads in the community based on the specified ResultFilter.
getThreads() - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all the threads in the community.
getThreads(ThreadResultFilter) - Method in interface com.jivesoftware.community.ContentRetrieval
Returns an Iterable for all the threads in the community that match the criteria specified by the ResultFilter.
getThrowable() - Method in class com.jivesoftware.base.event.LogEvent
 
getTimeZone() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the page user's time zone.
getTimeZone() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the global TimeZone used by Jive.
getTimeZones() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a list of time zones as a double String array.
getTitle() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The title of the result (will be displayed on the view).
getTitle() - Method in interface com.jivesoftware.community.Trackback
Returns the title of the trackback.
getTitle(WidgetContext) - Method in interface com.jivesoftware.community.widget.Widget
Returns the default title of the widget
getTokenPattern() - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Returns a Pattern which matches any email token generated by this EmailTokenManager instance.
getTokens() - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Returns a list of all the tokens in the store.
getTotalCount() - Method in interface com.jivesoftware.community.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).
getTotalCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getTotalCount() - Method in interface com.jivesoftware.community.SearchManager
Returns the total number of content objects that are to be indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getTotalUserCount() - Method in interface com.jivesoftware.community.Roster
Returns the total number of users in the roster.
getTotalWatchCount(User, int) - Method in interface com.jivesoftware.community.WatchManager
Returns a count of all watches that a user has of a particular type.
getTotalWatchCount(User) - Method in interface com.jivesoftware.community.WatchManager
Returns a count of all watches that a user has for all types.
getTrackback(long) - Method in interface com.jivesoftware.community.Blog
Returns a trackback by trackback ID.
getTrackback() - Method in class com.jivesoftware.community.event.TrackbackEvent
Returns the trackback that the event corresponds to.
getTrackback(long) - Method in interface com.jivesoftware.community.TrackbackManager
Returns the Trackback with the supplied id.
getTrackbackCount() - Method in interface com.jivesoftware.community.Blog
Returns the total number of trackbacks on this blog.
getTrackbackCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns the total number of trackbacks on this blog that match the criteria specified by the ResultFilter.
getTrackbackCount() - Method in interface com.jivesoftware.community.BlogManager
Returns the number of trackbacks on blog posts in the system.
getTrackbackCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of trackbacks on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getTrackbackCount() - Method in interface com.jivesoftware.community.TrackbackManager
Returns the number of incoming trackbacks on this object.
getTrackbackCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.TrackbackManager
Returns the number of incoming trackbacks on this object that match the criteria specified by the ResultFilter.
getTrackbackFeedURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the trackbacks feed for a blog.
getTrackbackFeedURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the trackbacks feed for a specific post.
getTrackbackManager() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a trackback manager to manage blog post trackbacks.
getTrackbackManager() - Method in interface com.jivesoftware.community.Document
Retrieve a trackback manager to manage document trackbacks.
getTrackbackManager() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a trackback manager to manage thread trackbacks.
getTrackbackPermalink(Trackback) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a permalink for a blog trackback which is a combination of the base URL, the blog display name, the year / month / day, the entry name and a suffix / trackback ID.
getTrackbacks(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all the trackbacks on this blog that match the criteria specified by the ResultFilter.
getTrackbacks(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all the trackbacks on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getTrackbacks() - Method in interface com.jivesoftware.community.TrackbackManager
Return an Iterable for all the incoming trackbacks on this object.
getTrackbacks(FeedbackResultFilter) - Method in interface com.jivesoftware.community.TrackbackManager
Returns a Iterable for all the incoming trackbacks on this object that match the criteria specified by the ResultFilter.
getTrackbackURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a trackback URL for a blog post which is a combination of the base URL, the blog display name and the post permalink.
getTransformedTemplate(Document, AuthToken, Locale) - Method in interface com.jivesoftware.community.DocumentPresenter
Applies the template to a Document and returns the results as a string
getTreeWalker() - Method in interface com.jivesoftware.community.ForumThread
Returns the TreeWalker for this thread.
getType() - Method in interface com.jivesoftware.community.Activity
Returns the type of activity this instance represents.
getType() - Method in exception com.jivesoftware.community.AvatarException
 
getType() - Method in interface com.jivesoftware.community.DocumentTypeElement
Returns the type of this DocumentTypeElement.
getType(String) - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Acquires a Type by its string name.
getType(long) - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Acquires a Type by its ID.
getType() - Method in class com.jivesoftware.community.EntityDescriptor
Deprecated. EntityDescriptor.getObjectType() should used instead, since it is defined in JiveObject.
getType(int) - Static method in enum com.jivesoftware.community.JiveInterceptor.Type
A helper method to get a specific Type object from its key
getType() - Method in class com.jivesoftware.community.ProfileField
Returns the ProfileField.Type of this profile field.
getTypeID() - Method in class com.jivesoftware.community.ProfileField
Gets the id of the ProfileField.Type of this profile field.
getTypes() - Method in interface com.jivesoftware.community.JiveInterceptor
Returns the interception types the interceptor supports.
getUnfilteredBody() - Method in interface com.jivesoftware.community.Announcement
Returns the announceement body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.community.Comment
Returns the comment body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the body, bypassing any active filters.
getUnfilteredBody() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message body, bypassing any active filters.
getUnfilteredDocumentFieldValue(DocumentField) - Method in interface com.jivesoftware.community.Document
Returns the value of the document field bypassing any active filters.
getUnfilteredName() - Method in interface com.jivesoftware.community.ContentTag
The unfiltered name of the tag
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Announcement
Returns an extended property of the announcement, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Blog
Returns an extended property of the blog, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.BlogPost
Returns an extended property of the blog, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Comment
Returns an extended property of the comment, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Document
Returns an extended property of the document, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.ForumMessage
Returns an extended property of the message, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.PrivateMessage
Returns an extended property of the private message, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Trackback
Returns an extended property of the trackback, bypassing any filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.Announcement
Returns the annoucenment subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message subject, bypassing any active filters.
getUnfilteredSummary() - Method in interface com.jivesoftware.community.Document
Returns the document summary, bypassing any active filters.
getUnmodifiableMap() - Static method in class com.jivesoftware.community.JiveGlobals
 
getUnreadMessageCount() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the number of unread messages in the folder.
getUnreadMessageCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of unread private messages a user has in their mailbox.
getUnreadMessageCount(User, Community) - Method in interface com.jivesoftware.community.ReadTracker
Returns the count of unread messages that the user has in the community.
getUnreadMessages(User, Community) - Method in interface com.jivesoftware.community.ReadTracker
Returns an iterable for the unread messages in the community.
getUnreadThreadCount(User, Community) - Method in interface com.jivesoftware.community.ReadTracker
Returns the count of unread threads that the user has in the community.
getUnreadThreads(User, Community) - Method in interface com.jivesoftware.community.ReadTracker
Returns an iterable for the unread threads in the community.
getUpdateManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the UpdateManager.
getURL() - Method in interface com.jivesoftware.community.Comment
Returns the URL of the person that authored this comment.
getURL() - Method in interface com.jivesoftware.community.Trackback
Returns the URL of the trackback.
getUser(AuthToken) - Method in class com.jivesoftware.base.AuthFactory
 
getUser() - Method in class com.jivesoftware.base.event.UserEvent
 
getUser() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns the current user logged in if the user is not a guest, if the user is a guest null will be returned.
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 class com.jivesoftware.community.AbuseReport
Gets the user that created this abuse report.
getUser() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getUser() - Method in interface com.jivesoftware.community.Activity
Returns the user who performed the activity, or null if the activity was performed by a guest.
getUser() - Method in interface com.jivesoftware.community.Announcement
Returns the User that is the author of the announcemnt.
getUser() - Method in class com.jivesoftware.community.ApprovalStatus
Returns The approval user.
getUser() - Method in interface com.jivesoftware.community.BlogPost
Returns the User that authored this post.
getUser() - Method in interface com.jivesoftware.community.Comment
Returns the user that authored the comment.
getUser() - Method in interface com.jivesoftware.community.Document
Returns the user that authored the document.
getUser() - Method in class com.jivesoftware.community.event.ProfileEvent
 
getUser() - Method in interface com.jivesoftware.community.ForumMessage
Returns the User that authored this message.
getUser() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the user who authored of the jive object.
getUser() - Method in interface com.jivesoftware.community.Poll
Returns the user who created the poll or null if the poll was created anonymously.
getUser() - Method in interface com.jivesoftware.community.Presence
Return the user owning the presence.
getUser() - Method in class com.jivesoftware.community.ProfileSearchResult
Gets the user that this search result represents.
getUser() - Method in interface com.jivesoftware.community.Question
Returns the user that created the question.
getUser() - Method in interface com.jivesoftware.community.Roster
Returns the user that this roster belongs to.
getUser() - Method in interface com.jivesoftware.community.SearchQuery
Returns the user that is executing the search.
getUser() - Method in interface com.jivesoftware.community.Watch
Returns the user who is associated with this watch.
getUser() - Method in class com.jivesoftware.community.widget.WidgetContext
Gets the current page user, or null if annonymous
getUser(String) - Method in interface com.jivesoftware.spi.user.UserProvider
returns the user associated to the username.
getUser(UserTemplate) - Method in interface com.jivesoftware.spi.user.UserProvider
returns the specified user.
getUserAndMessageID(String) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Uses the supplied token string to lookup a user id and forums message id.
getUserApprovalDocumentCount(User) - Method in interface com.jivesoftware.community.DocumentManager
Returns a count of all documents that a user needs to approve.
getUserApprovalDocuments(User) - Method in interface com.jivesoftware.community.DocumentManager
Returns all documents that a user needs to approve.
getUserCommandManager() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getUserContentCommentCount(User) - Method in interface com.jivesoftware.community.CommentManager
Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentCommentCount(User, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns a count of all the comments in all content which has been authored by the supplied user that match the criteria specified by the ResultFilter.
getUserContentComments(User) - Method in interface com.jivesoftware.community.CommentManager
Returns a JiveIterator for all the comments in all content which has been authored by the supplied user.
getUserContentComments(User, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns a JiveIterator for all the comments in all content which has been authored by the supplied user that match the criteria specified by the ResultFilter.
getUserCount() - Method in interface com.jivesoftware.base.UserManager
Returns the number of users in the system.
getUserCount() - Method in interface com.jivesoftware.community.Blog
Returns the number of users associated with this blog.
getUserCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of users to be imported
getUserDocumentation(String) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getUserDocumentation(String) - Method in interface com.jivesoftware.community.renderer.RenderFilter
Returns a string array of [section,title, body] of xml formatted documentation that is targetted for end user usage.
getUserDocumentCount(User, DocumentState[]) - Method in interface com.jivesoftware.community.DocumentManager
Returns a count of all documents in the supplied DocumentStates a user is an author of.
getUserDocuments(User, DocumentState[]) - Method in interface com.jivesoftware.community.DocumentManager
Returns all documents in the supplied DocumentStates for the supplied user.
getUserFeedURL(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the feed which is a combination of the base URL, the username and the default system feed type.
getUserFeedURLPrefix() - Static method in class com.jivesoftware.community.util.BlogUtils
 
getUserForJID(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
 
getUserFromEmailAddress(String) - Method in interface com.jivesoftware.base.UserManager
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 class com.jivesoftware.base.AuthFactory.SystemAuthToken
 
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 interface com.jivesoftware.community.Draft
Returns the ID of the user that authored this draft.
getUserID(String) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Returns just the user id as found in the supplied token string.
getUserID() - Method in class com.jivesoftware.community.QuestionFilter
Returns the ID of the creator of questions that results will be filtered on.
getUserID() - Method in class com.jivesoftware.community.ResultFilter
Returns the userID that results will be filtered on.
getUserManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a UserManager that can be used to manage users.
getUserMessageCount(User) - Method in interface com.jivesoftware.community.ForumManager
Returns the total number of messages a user has posted in all communities.
getUserMessageCount(User, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns the total number of messages a user has posted in all communities that obey the parameters set by the specificed ResultFilter.
getUserMessages(User) - Method in interface com.jivesoftware.community.ForumManager
Returns an iterable for all messages posted by a user.
getUserMessages(User, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an iterable for all messages posted by a user that obey the parameters set by the specified ResultFilter.
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.
getUsername() - Method in interface com.jivesoftware.community.Presence
Returns the unique username for this status.
getUsername(HttpServletRequest) - Method in interface com.jivesoftware.spi.user.AuthenticationProvider
 
getUsername() - Method in interface com.jivesoftware.spi.user.User
returns the username
getUsername() - Method in class com.jivesoftware.spi.user.UserTemplate
 
getUsernames() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns an unmodifiable Collection of usernames of all users in the system.
getUserProperties() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a map of properties for users.
getUsers() - Method in interface com.jivesoftware.community.Blog
Return all the users given permission to post to this blog.
getUsers() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of user import beans corresponding to the users to be imported
getUsers() - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users in this roster.
getUsers() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns an unmodifiable Collections of all users in the system.
getUsers(int, int) - Method in interface com.jivesoftware.spi.user.UserProvider
Returns iterable result set of users, containing size or less users and starting at startIndex.
getUserVoteCount() - Method in interface com.jivesoftware.community.Poll
Returns a count of all user votes for all options in the poll.
getUserVoteCount(int) - Method in interface com.jivesoftware.community.Poll
Returns a count of all user votes for the specified option in the poll.
getUserVotes() - Method in interface com.jivesoftware.community.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.community.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.community.Poll
Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
getValidator() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the validator for the document field.
getValidator() - Method in interface com.jivesoftware.community.DocumentType
Returns the validator for the document type.
getValidator() - Method in enum com.jivesoftware.community.ProfileField.Type
Gets the profile field validator for this type
getValue() - Method in class com.jivesoftware.base.event.JivePropertyEvent
Returns the value of the jive property
getValue() - Method in class com.jivesoftware.community.AbuseType
Gets the i18n key that can be used to lookup the text value for this abuse type.
getValue() - Method in class com.jivesoftware.community.BanLevel
Gets the value of a BanLevel object
getValue() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the value of the option.
getValue() - Method in interface com.jivesoftware.community.DocumentTypeLabelElement
Returns the getValue of this Document label
getValue() - Method in class com.jivesoftware.community.ProfileFieldOption
Gets the value of this option.
getValue() - Method in class com.jivesoftware.community.ProfileSearchFilter
Gets the value that will be used to filter the user results.
getValue() - Method in enum com.jivesoftware.community.renderer.RenderTarget
Gets the value of a RenderTarget object
getValue() - Method in enum com.jivesoftware.community.renderer.RenderType
Gets the value of a RenderType object
getVersion() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getVersionCommentCount() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the number of comments made on the document version.
getVersionComments() - Method in interface com.jivesoftware.community.DocumentVersion
Returns an iterator of VersionComment objects for all the comments made on the document version.
getVersionManager() - Method in interface com.jivesoftware.community.Document
Returns the version manager for the document.
getVersionNumber() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the version number of the version of the document.
getViewCount() - Method in interface com.jivesoftware.community.BlogPost
Returns the number of times this blog post has been viewed.
getViewCount() - Method in interface com.jivesoftware.community.Community
Returns the number of times this thread has been community.
getViewCount() - Method in interface com.jivesoftware.community.Document
Returns the number of times this document has been viewed.
getViewCount() - Method in interface com.jivesoftware.community.ForumThread
Returns the number of times this thread has been viewed.
getViewCountCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns the count of all the view counts
getViewCounts() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns all the view counts
getVoteCount() - Method in interface com.jivesoftware.community.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.community.Poll
Returns a count of all votes (both guest and user votes) for the specified option in the poll.
getWatch(User, JiveObject) - Method in interface com.jivesoftware.community.WatchManager
Returns a watch on a particular JiveObject, or null if there isn't a watch.
getWatchCount() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a count of watches to be imported
getWatchCount(User, Community) - Method in interface com.jivesoftware.community.WatchManager
Return the count of all forum watches in a particular community for the given user.
getWatches() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns an iterable of watch import beans corresponding to the watches to be imported
getWatches(User, Community) - Method in interface com.jivesoftware.community.WatchManager
Returns an Iterable for all the Community objects a user is watching in a community.
getWatchList(User, int) - Method in interface com.jivesoftware.community.WatchManager
Returns an array of Watch objects for a particular object type that the given user is watching.
getWatchManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a WatchManager that can be used to manage watches.
getWatchType() - Method in interface com.jivesoftware.community.Watch
Returns the type of the watch.
getWatchUsers(int, long, int) - Method in interface com.jivesoftware.community.WatchManager
Returns all the users watching a specific objectType, objectID, and watchType.
getWebServiceClasses() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getWidget(WidgetDescriptor) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the instanciated widget object for the specified WidgetDescriptor
getWidgetClasses() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getWidgetContext() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getWidgetFrame(long) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the WidgetFrame corresponding to the specified widget frame id.
getWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the map containing all the draft WidgetFrames for the specified parent JiveObject.
getWidgetManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the widget manager.
getXMPPIMService() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
Group - Interface in com.jivesoftware.base
Organizes users into a group for easier permissions management.
GROUP - Static variable in class com.jivesoftware.community.JiveConstants
 
GROUP_ADMIN - Static variable in class com.jivesoftware.community.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_MANAGER_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
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<String, ? extends Object>) - 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 of members in each group.
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.community.PermissionsManager
Returns an Iterator of groups with a particular permission.
groupsWithPermissionCount(PermissionType, long) - Method in interface com.jivesoftware.community.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

handleDatabase(Plugin<?>, String) - Method in class com.jivesoftware.base.plugin.PluginManager
 
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.
handleUpgradeTasks(File, Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
 
handleWarnEvent(LogEvent) - Method in interface com.jivesoftware.base.event.LogListener
Fired when a warn event occurs.
HARASSMENT - Static variable in class com.jivesoftware.community.AbuseType
Type representing a harassment abuse report.
hasAnonymousVoted(String) - Method in interface com.jivesoftware.community.Poll
Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.
hasApprovers() - Method in interface com.jivesoftware.community.Document
Returns true if this document or its parent community has approvers.
hasBlog(User) - Method in interface com.jivesoftware.community.BlogManager
Returns true if the given user has one or more blogs, false if the user does not have a blog.
hashCode() - Method in class com.jivesoftware.community.ApprovalStatus
 
hashCode() - Method in class com.jivesoftware.community.Ban
 
hashCode() - Method in class com.jivesoftware.community.BanFilter
 
hashCode() - Method in class com.jivesoftware.community.BanManagerFactory.BanCacheKey
 
hashCode() - Method in class com.jivesoftware.community.DocumentFieldValue
 
hashCode() - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
hashCode() - Method in class com.jivesoftware.community.EmailMessage
 
hashCode() - Method in class com.jivesoftware.community.EntityDescriptor
 
hashCode() - Method in class com.jivesoftware.community.ProfileField
 
hashCode() - Method in class com.jivesoftware.community.ProfileFieldValue
 
hasNext() - Method in interface com.jivesoftware.community.JiveIterator
Returns true if this iterator has more elements when traversing the list in the forward direction.
hasParent(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns true if the child message has a parent message.
hasPermission(long) - Method in class com.jivesoftware.community.Permissions
Returns true if one or more of the permission types is set to true.
hasPrevious() - Method in interface com.jivesoftware.community.JiveIterator
Returns true if this list iterator has more elements when traversing the list in the reverse direction.
hasPrivateMessages() - Method in interface com.jivesoftware.community.importer.ImportSource
Returns a system level check to see if there any private messages at all.
hasQuestion() - Method in interface com.jivesoftware.community.ForumThread
Returns true if this thread has been marked as a question.
hasQuestion(ForumThread) - Method in interface com.jivesoftware.community.QuestionManager
Returns true if the thread has a question associated with it.
hasRated(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns whether the user has rated the JiveContentObject or not.
hasUserReportedAbuse(ForumMessage, User) - Method in interface com.jivesoftware.community.AbuseManager
Checks if a user has already reported abuse for a particular message.
hasUserVoted(User) - Method in interface com.jivesoftware.community.Poll
Returns true if the user specified has previously voted in the poll, false otherwise.
HELPFUL_ANSWER_ADDED - Static variable in class com.jivesoftware.community.event.QuestionEvent
A helpful answer was added to the question.
helpfulAnswerAdded(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when a correct answer has been added to the question.
highlightResult(String, String) - Method in interface com.jivesoftware.community.SearchQueryResult
Returns a title and summary with search words highlighted appropriate to the search query string.
HOSTED_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to perform hosted operations
HOUR - Static variable in class com.jivesoftware.community.JiveConstants
One hour (in milliseconds).

I

i18nEditionKeys - Static variable in class com.jivesoftware.community.action.JiveActionSupport
 
Image - Interface in com.jivesoftware.community
An object that encapsulates an image.
IMAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
IMAGE_ADDED - Static variable in class com.jivesoftware.community.event.ImageEvent
Event type for whenever an image is added to a document.
IMAGE_DELETING - Static variable in class com.jivesoftware.community.event.ImageEvent
Event type for whenever an image is about to be deleted.
imageAdded(ImageEvent) - Method in interface com.jivesoftware.community.event.ImageListener
Fired when an image is added.
ImageContentResource - Interface in com.jivesoftware.community
A base interface defining images methods.
imageDeleted(ImageEvent) - Method in interface com.jivesoftware.community.event.ImageListener
Fired when an image is deleted.
ImageEvent - Class in com.jivesoftware.community.event
A class for Image events.
ImageEvent(int, JiveObject, Image, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.ImageEvent
 
ImageEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for ImageEvents.
ImageException - Exception in com.jivesoftware.community
Thrown if there are problems with creation or loading of an Image.
ImageException(int) - Constructor for exception com.jivesoftware.community.ImageException
 
ImageException(int, Throwable) - Constructor for exception com.jivesoftware.community.ImageException
 
ImageException(String, int) - Constructor for exception com.jivesoftware.community.ImageException
 
ImageException(String) - Constructor for exception com.jivesoftware.community.ImageException
 
ImageListener - Interface in com.jivesoftware.community.event
An ImageListener gets notified anytime an image event is fired.
ImageManager - Interface in com.jivesoftware.community
Manages image settings.
IMManager - Class in com.jivesoftware.community.xmpp
Manages connection to the Openfire RTC server.
IMManager() - Constructor for class com.jivesoftware.community.xmpp.IMManager
 
IMManager.LocalRestartTask - Class in com.jivesoftware.community.xmpp
 
IMManager.LocalRestartTask() - Constructor for class com.jivesoftware.community.xmpp.IMManager.LocalRestartTask
 
IMPERSONATION - Static variable in class com.jivesoftware.community.AbuseType
Type representing an impersonation abuse report.
IMPORT - Static variable in class com.jivesoftware.community.JiveConstants
 
Importer - Interface in com.jivesoftware.community.importer
An importer is used to bulk import content into a Clearspace instance.
ImporterFactory - Class in com.jivesoftware.community.importer
A factory for Importers.
ImportSource - Interface in com.jivesoftware.community.importer
An import source is used by the importers extending the BaseImporter to source the information required for importing content into Clearspace.
include(long) - Method in class com.jivesoftware.community.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.
init(ImportConfiguration) - Method in interface com.jivesoftware.community.importer.ImportSource
Called to initialize the import source
initCaches() - Static method in class com.jivesoftware.base.GroupManagerFactory
Creates internal cache structures.
initCaches() - Static method in class com.jivesoftware.base.UserManagerFactory
Creates internal cache structures.
initialize(JiveContext) - Method in class com.jivesoftware.base.GroupManagerFactory
 
initialize(JiveContext) - Method in class com.jivesoftware.base.plugin.PluginManager
Starts plugins and the plugin monitoring service.
initialize(JiveContext) - Method in class com.jivesoftware.community.AvatarManagerFactory
 
initialize(JiveContext) - Method in interface com.jivesoftware.community.JiveManager
Initialize the manager.
initialize(JiveApplication.ManagerHandler) - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle
Initialize the application using the provided manager handle to initialize the application's managers.
initialize() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Initializes the application.
initialize(JiveContext) - Method in class com.jivesoftware.community.PollManagerFactory
 
initialize() - Method in class com.jivesoftware.community.renderer.RendererFactory
 
initialize(JiveContext) - Method in class com.jivesoftware.community.StatusLevelManagerFactory
 
initialize(JiveContext) - Method in class com.jivesoftware.community.TagManagerFactory
 
initialize(JiveContext) - Method in class com.jivesoftware.community.TrackbackManagerFactory
 
initialize(JiveContext) - Method in class com.jivesoftware.community.xmpp.IMManager
 
initialize(Map<String, String>) - Method in interface com.jivesoftware.spi.ServiceProvider
Initialization of the service should be performed in this method.
initialized - Variable in class com.jivesoftware.base.plugin.PluginManager
 
initialized() - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle.Listener
This method is called by the initialization code when application initialization is complete.
initializePlugin(PluginManager, PluginMetaData) - Method in interface com.jivesoftware.base.plugin.Plugin
Initializes the plugin.
initLog() - Static method in class com.jivesoftware.base.Log
This method is used to initialize the Log class.
installPlugin(InputStream, String) - Method in class com.jivesoftware.base.plugin.PluginManager
Installs or updates an existing plugin.
installPlugin(InputStream, String, boolean) - Method in class com.jivesoftware.base.plugin.PluginManager
Installs or updates an existing plugin, with the option to notify the rest of the cluster.
InterceptorManager - Interface in com.jivesoftware.community
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.
InvalidLanguageException - Exception in com.jivesoftware.community
Thrown when attempting to specify a language that is not among the list of allowed languages.
InvalidLanguageException() - Constructor for exception com.jivesoftware.community.InvalidLanguageException
 
InvalidLanguageException(String) - Constructor for exception com.jivesoftware.community.InvalidLanguageException
 
InvalidLanguageException(String, Throwable) - Constructor for exception com.jivesoftware.community.InvalidLanguageException
 
InvalidLanguageException(Throwable) - Constructor for exception com.jivesoftware.community.InvalidLanguageException
 
invokeInterceptor(JiveObject, JiveInterceptor.Type) - Method in interface com.jivesoftware.community.JiveInterceptor
Invokes the interceptor on the specified jive object.
isAccountValidated(long) - Method in interface com.jivesoftware.community.RegistrationManager
Checks if a user account has been validated
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.
isAdmin() - Method in class com.jivesoftware.community.ProfileSearchQuery
Return True if the user performing the search is a system administrator, false otherwise.
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.
isAllowAllByDefault() - Method in interface com.jivesoftware.community.AttachmentManager
Returns true if in the "allow all content types by default" mode.
isAllowAllByDefault() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns true if in the "allow all content types by default" mode.
isAllowAllByDefault() - Method in interface com.jivesoftware.community.ImageManager
Returns true if in the "allow all content types by default" mode.
isAllowImageResize() - Method in interface com.jivesoftware.community.AvatarManager
Returns true if the system should attempt to resize images
isAllTagsRequired() - Method in class com.jivesoftware.community.ResultFilter
Returns true if the content must be tagged with every tag contained in getTags().
isAlterable() - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Returns true if the associated document field is an alterable document field or not.
isAnonymous() - Method in class com.jivesoftware.base.AuthFactory.SystemAuthToken
 
isAnonymous() - Method in interface com.jivesoftware.base.AuthToken
Returns true if this AuthToken is the anonymous auth token.
isAnonymous() - Method in interface com.jivesoftware.community.Comment
Returns true if the comment was posted anonymously.
isAnonymous() - Method in interface com.jivesoftware.community.Document
Returns true if the document was created anonymously.
isAnonymous() - Method in interface com.jivesoftware.community.ForumMessage
Returns true if this message was posted anonymously.
isApproved() - Method in class com.jivesoftware.community.ApprovalStatus
True if this user has approved the document.
isArchivingEnabled(Community) - Method in interface com.jivesoftware.community.ArchiveManager
Returns true if archiving is enabled for the specified community.
isAssumedResolved() - Method in interface com.jivesoftware.community.Question
Determines if the state is Question.State.assumed_resolved
isAttachmentSearchEnabled() - Method in interface com.jivesoftware.community.SearchManager
Returns true if the attachment search feature is turned on.
isAttachmentsEnabled() - Method in interface com.jivesoftware.community.AttachmentManager
Returns true if attachments are enabled, false otherwise.
isAuthenticated() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Check whether or not the search result feed requires HTTP authentication.
isAuthenticatedEngines() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
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.User
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.Blog
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.BlogManager
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.Comment
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.Community
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.Document
Returns true if the handle on the document has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.ForumMessage
Returns true if the handle on this object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.ForumThread
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.JiveContext
Returns true if the AuthToken used to get an instance of this class has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.Poll
Returns true if the handle on the object has the permission specified.
isAuthorized(long) - Method in interface com.jivesoftware.community.PrivateMessage
Returns true if the handle on this object has the permission specified.
isAutoArchiveEnabled() - Method in interface com.jivesoftware.community.ArchiveManager
Returns true if auto-archiving is enabled.
isAutoIndexEnabled() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns true if auto indexing is turned on.
isAutoIndexEnabled() - Method in interface com.jivesoftware.community.SearchManager
Returns true if auto indexing is turned on.
isAutosaveEnabled() - Method in interface com.jivesoftware.community.DraftManager
Determines whether or not the system has been configured to allow for autosave in text fields.
isAvatarsEnabled() - Method in interface com.jivesoftware.community.AvatarManager
Returns true if the avatars feature is enabled, else false
isAvatarsEnabled() - Static method in class com.jivesoftware.community.AvatarManagerFactory
 
isBanningEnabled() - Method in interface com.jivesoftware.community.BanManager
Checks if the ban feature is enabled
isBinaryBodyEnabled() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns true if the documents can contain binary body data, false if they can only contain textual bodies.
isBlogsEnabled() - Method in interface com.jivesoftware.community.BlogManager
Returns true if the blogs feature is turned on.
isBuiltIn() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
If this Type is a builtin type (body, summary, attachment, etc) then this method will return true;
isBusy() - Method in interface com.jivesoftware.community.ArchiveManager
Returns true if the archiving process is currently running.
isBusy() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns true if the search manager is currently busy with an search indexing task.
isBusy() - Method in interface com.jivesoftware.community.SearchManager
Returns true if the search manager is currently busy with an search indexing task.
isCachingDisabled() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns true is caching of generated output is disabled, false otherwise.
isCachingDisabled() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
isChangelogExists() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
isCommentModerationEnabled() - Method in interface com.jivesoftware.community.Blog
Returns true if comment moderation is enabled for this blog, false if not.
isCommentModerationEnabled() - Method in interface com.jivesoftware.community.ModerationManager
Returns whether comment moderation is enabled or not.
isCommentNotificationEnabled() - Method in interface com.jivesoftware.community.Blog
Returns true if comment notification is enabled for this blog, false if not.
isCommentsEnabled() - Method in interface com.jivesoftware.community.BlogManager
Returns true if the comments feature is turned on.
isCommentsEnabled() - Method in interface com.jivesoftware.community.DocumentManager
Returns true if the comments feature is turned on.
isCommentsIncludedInSearch() - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Returns whether comments are included in the search or not.
isCommentsIncludedInSearch() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns whether comments are included in the search or not.
isCommunityBlog() - Method in interface com.jivesoftware.community.Blog
Returns true if this blog is a community blog, false if not.
isConnected() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns true if Clearspace is connected as an external component to a Openfire server.
isCorrectAnswer(ForumMessage) - Method in interface com.jivesoftware.community.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.community.StorageManager
Returns true if binary data such as attachments, images or binary document bodies is stored in the database.
isDebugEnabled() - Static method in class com.jivesoftware.base.Log
 
isDefault() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns true if this option is a default option
isDefaultOption() - Method in class com.jivesoftware.community.ProfileFieldOption
Gets whether or not this option is to be selected by default.
isDefaultTemplate() - Method in interface com.jivesoftware.community.DocumentPresenter
Returns true if this presenter is the default presenter, false otherwise.
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.
isDisplayable() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
The default behavior is to display the filter/macro.
isDisplayable() - Method in interface com.jivesoftware.community.renderer.RenderFilter
 
isDocumentBeingEdited() - Method in interface com.jivesoftware.community.Document
Returns true if the document is currently being editted by a user, false otherwise.
isDocumentDeleted() - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
isEdit() - Method in class com.jivesoftware.community.widget.WidgetContext
Returns true if the parent container is currently in edit mode and false if it is not.
isEditable() - Method in class com.jivesoftware.community.ProfileField
Gets whether or not this profile field is editable by the user.
isEmailAlertEnabled() - Method in interface com.jivesoftware.community.ModerationManager
Returns true if moderation email alerts enabled.
isEmailInUse() - Method in exception com.jivesoftware.base.UserAlreadyExistsException
 
isEmailNotifyEnabled() - Method in interface com.jivesoftware.community.BanManager
Gets the comma-delimited list of email addresses to notify when a user with with ban level notify posts a message.
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.community.ProfileSearchManager
Determines whether or not user email addresses are visible when performing a user search.
isEmpty() - Method in class com.jivesoftware.community.cache.DefaultCache
 
isEnabled() - Method in interface com.jivesoftware.base.User
Returns true if the user is disabled, meaning they cannot log in.
isEnabled() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
isEnabled() - Method in interface com.jivesoftware.community.renderer.RenderFilter
Returns true if the filter is enabled, false otherwise.
isEnabled() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get whether or not this engine will appear in the view.
isEnabled() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns true if Clearspace is setup as an external component to a Openfire server.
isEnabledByDefault() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
Returns true if the filter should be enabled by default, false otherwise.
isEnabledByDefault() - Method in class com.jivesoftware.community.renderer.BaseFilter
Returns the value of the EnableByDefault annotation if it is defined, else true.
isEnabledEngines() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
isEnabledNonParseableEngines() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
isEnabledParseableEngines() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
isErrorEnabled() - Static method in class com.jivesoftware.base.Log
 
isExcludeOwnerInUserFilter() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns true if the document owner should be excluded when filtering by user id.
isExpirable() - Method in interface com.jivesoftware.community.Watch
Returns whether this watch is expirable or not.
isFailedLookup(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Lookup cache - this should be used if you want to note and remember a lookup on a field.
isFeedEnabled() - Method in interface com.jivesoftware.community.Blog
Returns true if feeds are enabled for this blog, false if not.
isFeedFullContent() - Method in interface com.jivesoftware.community.Blog
Returns true if the full blog post should be published in feeds, false to instead include an excerpt of the blog post.
isFileSystemCacheEnabled() - Method in interface com.jivesoftware.community.StorageManager
Returns true if the binary object data is stored in the database and object data is cached on the file system in a directory within the jiveHome in order to relieve load on the database.
isFilterable() - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Returns the filterability of the associated document field.
isFilterable() - Method in class com.jivesoftware.community.ProfileField
Gets whether or not this profile field is filterable.
isFinished() - Method in interface com.jivesoftware.community.importer.Importer
Returns true if the importer has finished running.
isForceThumbnailsEnabled() - Method in interface com.jivesoftware.community.ImageManager
Returns true if forcing thumbnails for any images over the maximum image width/height is enabled.
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.
isGroupByCommunity() - Method in class com.jivesoftware.community.QuestionFilter
Returns true if results will be grouped by community.
isGroupListSupported() - Method in interface com.jivesoftware.base.IntrospectiveGroupManager
Indicates whether the GroupManager supports getting a listing of all groups via the getGroups() method.
isGuest() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns true if the page user is a guest or false if they're logged in.
isHelpfulAnswer(ForumMessage) - Method in interface com.jivesoftware.community.Question
Returns true if the specified message has been marked as a helpful answer to this question.
isHtml() - Method in interface com.jivesoftware.community.ForumMessage
Returns true if this body of this message contains HTML.
isHttpBindEnabled() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns true if the HTTP binding service on the RTC server is currently enabled and false if it is not.
isHumanValidationEnabled() - Method in interface com.jivesoftware.community.RegistrationManager
Returns true if the human input validation feature is turned on.
isImagePreviewEnabled() - Method in interface com.jivesoftware.community.AttachmentManager
Returns true if image preview support is enabled.
isImagePreviewRatioEnabled() - Method in interface com.jivesoftware.community.AttachmentManager
Returns true if the aspect ratio of thumbnails should be preserved.
isImagesEnabled() - Method in interface com.jivesoftware.community.ImageManager
Returns true if images are enabled, false otherwise.
isInApproval() - Method in interface com.jivesoftware.community.Document
Returns true if the document currently is in approval.
isIncludeAuthorsInUserFilter() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns true if users who have been added as authors to a document should be included when filtering by user.
isIncludeModerated() - Method in class com.jivesoftware.community.CommentResultFilter
Returns whether the result to be selected by the result filter should include moderated comments.
isIncludeModerated() - Method in class com.jivesoftware.community.FeedbackResultFilter
Returns whether the result to be selected by the result filter should include moderated comments.
isIncludeNonRecommendedDocuments() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns whether the result to be selected by the result filter should include documents with a recommended attribute set to false.
isIncludeRecommendedDocuments() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns whether the result to be selected by the result filter should include documents with a recommended attribute set to true.
isIncludeReviewersInUserFilter() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns true if users who have been added as reviewers to a document should be included when filtering by user.
isIncludeUnSearchableDocuments() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns whether the result to be selected by the result filter should include documents with a searchable attribute set to false.
isInfoEnabled() - Static method in class com.jivesoftware.base.Log
 
isInitialized() - Method in class com.jivesoftware.base.plugin.PluginManager
 
isInitialized() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Returns true if the application is initialized, false otherwise.
isInRange(long) - Method in interface com.jivesoftware.community.StatusLevel
Used to check to see if a point value is in the range for this status level
isLargeLogoExists() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
isLeaf(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns true if node is a leaf.
isLeaf(ForumMessage) - Method in interface com.jivesoftware.community.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.
isMinorEdit() - Method in interface com.jivesoftware.community.Document
If true, the next call to Document.save() will result in a minor document version.
isMinorRevision() - Method in class com.jivesoftware.community.event.DocumentEvent
 
isMinorVersion() - Method in interface com.jivesoftware.community.DocumentVersion
Returns true if the revision this instance represents is a minor version.
isModeEnabled(long) - Method in interface com.jivesoftware.community.Poll
Returns true if the mode specified is enabled for the poll, false otherwise.
isModerated() - Method in interface com.jivesoftware.community.Comment
Returns true if the commend is moderated, false otherwise.
isModerated() - Method in interface com.jivesoftware.community.Trackback
Returns true if the trackbacks is moderated, false otherwise.
isModerateUserAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns whether or not user avatars will be moderated.
isModerationEnabled() - Method in interface com.jivesoftware.community.ForumManager
Returns true if moderation has been enabled by setting the Jive property "database.moderationEnabled" to true.
isModifiable() - Method in interface com.jivesoftware.community.DocumentFieldType
Whether or not the admin tool should allow this document field to be modified or deleted.
isNameVisible() - Method in interface com.jivesoftware.base.User
Returns true if the user has chosen to make her name visible to other users.
isNewAccountCreationEnabled() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
isOnline(User) - Method in interface com.jivesoftware.community.PresenceManager
Returns whether the user is currently online or not.
isOnlyDraft() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns whether the result to be selected by the result filter should include draft blog posts.
isOnlyIncludeCollaborativeDocuments() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns true to only include collaborative documents (documents having textual bodies instead of binary bodies) in the list of document to filter upon.
isOnlyPublished() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns whether the result to be selected by the result filter should include published blog posts.
isOpen() - Method in interface com.jivesoftware.community.Question
Determines if the state is Question.State.open
isOverridePing() - Method in interface com.jivesoftware.community.Blog
Returns true if the blog has been configured to override the system settings, false to use the system blog ping settings.
isParseableEngines() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
isPasswordUpdateSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager
 
isPerformDistinctCount() - Method in class com.jivesoftware.community.ResultFilter
If the query is a count query, this property indicates whether a distinct count shoud be performed.
isPingsEnabled() - Method in interface com.jivesoftware.community.BlogManager
Returns true if the pings feature is turned on.
isPingsOverrideEnabled() - Method in interface com.jivesoftware.community.BlogManager
Returns true if the system has been configured to allow users to override the ping URIs configured for the system.
isPluginDownloaded(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Returns true if the specified filename, that belongs to a plugin, exists.
isPossiblyResolved() - Method in interface com.jivesoftware.community.Question
Determines if the state is Question.State.possibly_resolved
isPresencesEnabled() - Method in interface com.jivesoftware.community.PresenceManager
Returns whether presences are enabled on a global basis or not.
isPrivateMessageNotificationEnabled() - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns true if the notification feature is enabled, false otherwise.
isPrivateMessagesEnabled() - Method in interface com.jivesoftware.community.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.
isPublished() - Method in interface com.jivesoftware.community.DocumentAttributes
Convenience mathod for whether there is a published version of this document or not.
isQueryResultParseable() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Check whether or not the search result content type is machine parseable (an XML content type such as would be used for RSS or Atom content) or not (a nonstrict-XML type such as HTML content).
isRatingsEnabled() - Method in interface com.jivesoftware.community.RatingManager
Returns true if the rating feature is turned on.
isRead(User) - Method in interface com.jivesoftware.community.Community
Returns true if this community has been read by the user, false otherwise.
isRead(User) - Method in interface com.jivesoftware.community.ForumMessage
Returns true if this message has been read by the user, false otherwise.
isRead(User) - Method in interface com.jivesoftware.community.ForumThread
Returns true if this thread has been read by the user, false otherwise.
isRead() - Method in interface com.jivesoftware.community.PrivateMessage
Returns true if this message has been marked as read.
isReadmeExists() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
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 class com.jivesoftware.community.action.JiveActionSupport
Returns true if read tracking is enabled across the system.
isReadTrackingEnabled() - Method in interface com.jivesoftware.community.ReadTracker
Returns true if read tracking is enabled, false otherwise.
isRecommended() - Method in interface com.jivesoftware.community.DocumentAttributes
Returns true if the document was created as a recommendation.
isRecursive() - Method in class com.jivesoftware.community.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.
isRejected() - Method in class com.jivesoftware.community.ApprovalStatus
True if this user has rejected the document.
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.
isReportAbuseEnabled() - Method in interface com.jivesoftware.community.AbuseManager
Checks if report abuse feature is enabled.
isRequired() - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Returns true if the associated document field is required.
isRequired() - Method in class com.jivesoftware.community.ProfileField
Gets whether or not this profile field is a required field.
isReservedURI(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Used by blog config to make sure a display name provided by a user does not conflict with one of the reserved names in the /blog/ namespace.
isResolved() - Method in interface com.jivesoftware.community.Question
Determines if the state is Question.State.resolved
isRestrictToLatestVersion() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns true if only the latest document version will be tested when filtering on document state.
isRosterMember(User) - Method in interface com.jivesoftware.community.Roster
Returns true if the specified user is a member of the roster, false otherwise.
isRunning() - Method in interface com.jivesoftware.community.importer.Importer
Returns true if the importer is currently running.
isSearchable() - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Returns whether the associated document field is searchable or not.
isSearchable() - Method in class com.jivesoftware.community.ProfileField
Gets whether or not this profile field is searchable.
isSearchEmail() - Method in class com.jivesoftware.community.ProfileSearchQuery
Returns true if the user's email field is to be searched, false otherwise.
isSearchEnabled() - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns true if the profile search feature is turned on.
isSearchEnabled() - Method in interface com.jivesoftware.community.SearchManager
Returns true if the search feature is turned on.
isSearchName() - Method in class com.jivesoftware.community.ProfileSearchQuery
Returns true if the user's name field is to be searched, false otherwise.
isSearchProfile() - Method in class com.jivesoftware.community.ProfileSearchQuery
Returns true if the user's profile field values are to be searched, false otherwise.
isSearchUsername() - Method in class com.jivesoftware.community.ProfileSearchQuery
Returns true if the user's username field is to be searched, false otherwise.
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.
isSetup() - Static method in class com.jivesoftware.community.JiveGlobals
Returns true if the application has been set up, false otherwise.
isSetUsernameSupported() - Method in interface com.jivesoftware.base.IntrospectiveUser
Indicates whether setting the username is supported for this user.
isSingleResultPerThread() - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Returns true if message search results are limited to a single result per thread, false otherwise.
isSingleTagMacro() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the value of the SingleTagMacro annotation if it is defined, other wise true.
isSingleTagMacro() - Method in interface com.jivesoftware.community.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})
isSmallLogoExists() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
isStatusLevelsEnabled() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns true if status levels are enabled in the system
isSystemAdmin() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns true if the page user is the system admin, false otherwise.
isSystemDefault() - Method in interface com.jivesoftware.community.Avatar
Returns true if this is an instance of SystemDefaultAvatar, meaning the user has not selected an avatar or they are a guest user.
isTermsEnabled() - Method in interface com.jivesoftware.community.RegistrationManager
Returns true if terms and conditions is enabled
isTextBody() - Method in interface com.jivesoftware.community.Document
Returns true if the body of the document is text, false if it's binary.
isTrackbackModerationEnabled() - Method in interface com.jivesoftware.community.Blog
Returns true if trackback moderation is enabled for this blog, false if not.
isTrackbackNotificationEnabled() - Method in interface com.jivesoftware.community.Blog
Returns true if trackback notification is enabled for this blog, false if not.
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.BlogManager
Returns true if the trackbacks feature is turned on.
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.BlogPost
Returns true if trackbacks are accepted on this blog post, false if not.
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.Document
Returns true if trackbacks are accepted on this blog post, false if not.
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.DocumentManager
Returns true if the trackbacks feature is turned on.
isUniqueDisplayName(String) - Method in interface com.jivesoftware.community.Community
Returns true if the provided display name is unique within this community, false otherwise
isUnread(User) - Method in interface com.jivesoftware.community.Community
Returns true if this community has not been read by the user, false otherwise.
isUnread(User) - Method in interface com.jivesoftware.community.ForumMessage
Returns true if this message has not been read by the user, false otherwise.
isUnread(User) - Method in interface com.jivesoftware.community.ForumThread
Returns true if this thread has not been read by the user, false otherwise.
isUpdated(User) - Method in interface com.jivesoftware.community.Community
Returns true if this community has been updated since read by the user, false otherwise.
isUpdated(User) - Method in interface com.jivesoftware.community.ForumMessage
Returns true if this message has been updated since read by the user, false otherwise.
isUpdated(User) - Method in interface com.jivesoftware.community.ForumThread
Returns true if this thread has been updated since read by the user, false otherwise.
isUserAvatarsEnabled() - Method in interface com.jivesoftware.community.AvatarManager
Returns true if users can create their own avatars, false otherwise.
isUserBannedFromPosting() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
isUserListSupported() - Method in interface com.jivesoftware.base.IntrospectiveUserManager
Indicates whether getting an Iterator of all users (users()) is supported.
isUsernameInUse() - Method in exception com.jivesoftware.base.UserAlreadyExistsException
 
isValid() - Method in class com.jivesoftware.community.EntityDescriptor
Returns true if this entity descriptor references a valid object.
isValidationEnabled() - Method in interface com.jivesoftware.community.RegistrationManager
Returns true if the validation feature is turned on.
isValidDisplayName(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Method to validate a display name for a blog.
isValidIpAddress(String) - Method in interface com.jivesoftware.community.BanManager
Check that an IP Address is valid.
isValidType(String) - Method in interface com.jivesoftware.community.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.
isValidType(String) - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.
isValidType(String) - Method in interface com.jivesoftware.community.ImageManager
Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.
isValidVersion(Document, File, boolean) - Method in class com.jivesoftware.base.plugin.PluginManager
 
isVersionViewable(int, User) - Method in interface com.jivesoftware.community.VersionManager
Returns true if the supplied User can view the version indicated by the supplied version number.
isVisible() - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Returns the visibility of the associated document field.
isVisible() - Method in class com.jivesoftware.community.ProfileField
Gets whether or not this profile field is visible by the public.
isWarnEnabled() - Static method in class com.jivesoftware.base.Log
 
isWatched(User, JiveObject) - Method in interface com.jivesoftware.community.WatchManager
Returns true if the user is watching the specified jive object.
isWelcomeEnabled() - Method in interface com.jivesoftware.community.RegistrationManager
Returns true if welcome email is enabled
isWhiteLabel() - Static method in class com.jivesoftware.community.JiveGlobals
Returns true if the application is running in white label mode, false otherwise.
isWildcardIgnored() - Method in interface com.jivesoftware.community.SearchManager
Returns true if wildcarding is disabled.

J

javaScriptUrls - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
JiveActionSupport - Class in com.jivesoftware.community.action
A base action class that handles a set of common Jive code.
JiveActionSupport() - Constructor for class com.jivesoftware.community.action.JiveActionSupport
 
JiveApplication - Class in com.jivesoftware.community.lifecycle
This class is the main entry point for the system.
JiveApplication.ManagerHandler - Class in com.jivesoftware.community.lifecycle
A class that is used to initialize and retrieve instances of JiveManager.
JiveApplication.ManagerHandler() - Constructor for class com.jivesoftware.community.lifecycle.JiveApplication.ManagerHandler
 
JiveConstants - Class in com.jivesoftware.community
Contains constant values representing various objects in Clearspace.
JiveContentObject - Interface in com.jivesoftware.community
A base container object that most content objects in Clearspace implement.
jiveContext - Variable in class com.jivesoftware.base.plugin.MacroContext
 
JiveContext - Interface in com.jivesoftware.community
A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application.
JiveEvent - Interface in com.jivesoftware.community
JiveEvent is the base interface that all events must implement.
JiveException - Exception in com.jivesoftware.community
Base exception class for all Jive exceptions.
JiveException() - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(String) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(String, Throwable) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(Throwable) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveGlobals - Class in com.jivesoftware.community
This class controls access to a number of global propeties in the applcation.
JiveGlobals.JiveHomeProvider - Interface in com.jivesoftware.community
A pluggable way to specify a value for jiveHome.
JiveGlobals.ResetLocalizationSettingsClusterTask - Class in com.jivesoftware.community
 
JiveGlobals.ResetLocalizationSettingsClusterTask() - Constructor for class com.jivesoftware.community.JiveGlobals.ResetLocalizationSettingsClusterTask
 
jiveHome - Static variable in class com.jivesoftware.community.JiveGlobals
Location of the jiveHome directory.
JiveInterceptor - Interface in com.jivesoftware.community
A jive interceptor encapsulates an action that is invoked on a jive object immediately before or after it is added to the system and also when the object's subject or body is being edited.
JiveInterceptor.Type - Enum in com.jivesoftware.community
Represents the different ways a JiveInterceptor may be run
JiveIterator<T extends JiveObject> - Interface in com.jivesoftware.community
An extension of the Iterator class which allows backwards and forwards iteration, looking up of the ID of next element as well as setting an index into the iteration.
JiveManager - Interface in com.jivesoftware.community
An interface that all Jive Managers should implement.
JiveObject - Interface in com.jivesoftware.community
An interface for jive objects that contains two method common to all jive objects
JiveProperties<K,V> - Interface in com.jivesoftware.community
An extension of the Map interface to add support for getting child property names or a Collection of all property names.
jivePropertyAdded(JivePropertyEvent) - Method in interface com.jivesoftware.base.event.JivePropertyListener
Fired when a jive property is added
jivePropertyAdded(JivePropertyEvent) - Method in class com.jivesoftware.community.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<String, ? extends Object>) - 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.community.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.community.StatusLevelManagerFactory.StatusCalculatorPropertyListener
 
JiveRuntimeException - Exception in com.jivesoftware.community
Base exception class for all Jive runtime exceptions.
JiveRuntimeException() - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(String) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(String, Throwable) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(Throwable) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 

K

KEY_AUTO_LOGIN - Static variable in class com.jivesoftware.base.AuthFactory
Name of the user property key used to auto login random key.
KEY_LAST_LOGGED_IN - Static variable in class com.jivesoftware.base.AuthFactory
Name of the user property key used to store the last logged in date of a user
keySet() - Method in class com.jivesoftware.community.cache.DefaultCache
 

L

LanguageConfigurationEventListener - Interface in com.jivesoftware.community.event
Listener of modification events that the LanguageConfiguration might have.
largeLogoExists - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
lastAccessedList - Variable in class com.jivesoftware.community.cache.DefaultCache
Linked list to maintain order that cache objects are accessed in, most used to least used.
licenseType - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
LinkManager - Interface in com.jivesoftware.community
Manages links between objects in the system.
listeners - Variable in class com.jivesoftware.community.cache.DefaultCache
 
loadClass(Plugin<?>, String) - Method in class com.jivesoftware.base.plugin.PluginManager
Loads a class from the classloader of a plugin.
loader - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
loadPlugin(File) - Method in class com.jivesoftware.base.plugin.PluginManager
Loads a plug-in module into the container.
loadProperties(WidgetContext, Widget.ContainerSize) - Method in class com.jivesoftware.community.widget.BaseWidget
Responsible for parsing the request URL and adding the necessary parameters to the freemarker context.
loadTagList(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Retuns a List of ContentTag objects from the given space or + delimited list of tags.
LocaleManager - Interface in com.jivesoftware.community
Manages Locale settings for various objects.
localReset() - Method in class com.jivesoftware.community.xmpp.IMManager
 
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<String, ? extends Object>) - Constructor for class com.jivesoftware.base.event.LogEvent
 
LogEvent(int, Map<String, ? extends Object>, Throwable, String) - Constructor for class com.jivesoftware.base.event.LogEvent
 
LogEventDispatcher - Class in com.jivesoftware.base.event
Implementation of the JiveEventDispatcher for LogEvent dispatching.
login(HttpServletRequest, HttpServletResponse, User) - Method in interface com.jivesoftware.spi.user.AuthenticationProvider
 
LOGIN_CANCEL_URL - Static variable in class com.jivesoftware.community.JiveConstants
The name of the session key where the login cancel url is stored
LOGIN_SUCCESS_URL - Static variable in class com.jivesoftware.community.JiveConstants
The name of the session key where the login success url is stored
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.
logout(HttpServletRequest, HttpServletResponse, User) - Method in interface com.jivesoftware.spi.user.AuthenticationProvider
 
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.community.SearchQuery
Logs the query for later statistical analysis.
logSearchClick(long, int, long) - Method in interface com.jivesoftware.community.SearchQueryManager
Logs a search result clickthrough.

M

Macro - Interface in com.jivesoftware.base.plugin
Provides the ability to make custom macros to be used inside content such as blog posts, threads, documents, and comments.
MacroContext - Class in com.jivesoftware.base.plugin
Provides extra information to the macro.
MacroContext(JiveContext, PluginMetaData, JiveContentObject, User) - Constructor for class com.jivesoftware.base.plugin.MacroContext
 
macros - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
MacroTagName - Annotation Type in com.jivesoftware.community.renderer.annotations
Used by a macro to change its tag name.
makeURLSafe(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Trims spaces from the start and end of the string, replaces punctuation, and then replaces occurences of non-alphanumeric characters (except dashes) with a dash.
map - Variable in class com.jivesoftware.community.cache.DefaultCache
The map the keys and values are stored in.
MARK_THREADS - Static variable in interface com.jivesoftware.community.ArchiveManager
An archive mode that specifies that threads are marked as archived and left in their original community.
markAccountForValidation(User) - Method in interface com.jivesoftware.community.RegistrationManager
Marks the user account for validation and sends a validation request to the user.
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.community.ReadTracker
Marks an individual message as read.
markRead(User, Community) - Method in interface com.jivesoftware.community.ReadTracker
Marks an entire community as read up until the current instant in time.
markWarnLogFile(User) - Static method in class com.jivesoftware.base.Log
 
maxCacheSize - Variable in class com.jivesoftware.community.cache.DefaultCache
Maximum size in bytes that the cache can grow to.
maxLifetime - Variable in class com.jivesoftware.community.cache.DefaultCache
Maximum length of time objects can exist in cache before expiring.
memberCheckCache - Static variable in class com.jivesoftware.base.GroupManagerFactory
Contains member checks
mergeCommunities(Community, Community) - Method in interface com.jivesoftware.community.CommunityManager
Merges the content of two communities by copying the threads, documents and blogs from community2 to community1.
MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
MESSAGE_ADDED - Static variable in class com.jivesoftware.community.event.MessageEvent
Message was added to the system.
MESSAGE_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a message is added to the search index.
MESSAGE_BODY - Static variable in class com.jivesoftware.community.JiveConstants
 
MESSAGE_DELETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a message is removed from the search index.
MESSAGE_DELETING - Static variable in class com.jivesoftware.community.event.MessageEvent
Message was deleted.
MESSAGE_MODERATION_ABUSE_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value for messages that have been reported as abusive and should be hidden until the message is reviewed.
MESSAGE_MODERATION_ABUSE_VISIBLE - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value for messages that have been reported as abusive.
MESSAGE_MODERATION_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value at which content is automatically hidden (0).
MESSAGE_MODERATION_MODIFIED - Static variable in class com.jivesoftware.community.event.MessageEvent
The moderation value of the message was changed.
MESSAGE_MODERATION_VIRUSSCAN_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
The moderation value that messages will be set to while waiting to be scanned for viruses.
MESSAGE_MODERATION_VISIBLE - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value at which content is automatically visible (1).
MESSAGE_MODIFIED - Static variable in class com.jivesoftware.community.event.MessageEvent
The message was modified.
MESSAGE_MOVED - Static variable in class com.jivesoftware.community.event.MessageEvent
The message was moved by becoming the root message of a new thread.
MESSAGE_RATED - Static variable in class com.jivesoftware.community.event.MessageEvent
The message was rated.
MESSAGE_SUBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
messageAdded(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when a message has been added to the system.
messageAdded(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a message is added to the index.
messageDeleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when a message is deleted from the search index.
messageDeleting(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when a message is about to be deleted from the system.
MessageEvent - Class in com.jivesoftware.community.event
A class for ForumMessage events.
MessageEvent(int, ForumMessage, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.MessageEvent
Creates a new message event.
MessageEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for MessageEvents.
MessageListener - Interface in com.jivesoftware.community.event
A MessageListener gets notified anytime a message event is fired.
messageModerationModified(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when the moderation value of a message has been changed.
messageModified(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when portions of a message have been modified.
messageMoved(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when a message is moved to another thread.
messageRated(MessageEvent) - Method in interface com.jivesoftware.community.event.MessageListener
Fired when a message has been rated.
MessageSearchQueryCriteria - Interface in com.jivesoftware.community
Search criteria specific to searching messages may be specified using this criteria class.
MessageSearchQueryCriteria.MessageSortType - Enum in com.jivesoftware.community
Represents how message search queries will be sorted
minServerVersion - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
MINUTE - Static variable in class com.jivesoftware.community.JiveConstants
One minute (in milliseconds).
MODERATE - Static variable in class com.jivesoftware.community.BanLevel
Posts from a user will need to be moderated
ModerationFilter - Class in com.jivesoftware.community
Filters and sorts lists of ForumMessages based upon the message's moderation and abuse value.
ModerationFilter() - Constructor for class com.jivesoftware.community.ModerationFilter
 
ModerationManager - Interface in com.jivesoftware.community
Manages the moderation feature within Clearspace
MODERATOR - Static variable in class com.jivesoftware.community.Permissions
Permission to moderate content.
MODIFICATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
MOVE_THREADS - Static variable in interface com.jivesoftware.community.ArchiveManager
An archive mode that specifies that threads should be moved to another community.
moveCommunity(Community, Community) - Method in interface com.jivesoftware.community.CommunityManager
Moves a community to another community.
moveDocument(Document, Community) - Method in interface com.jivesoftware.community.DocumentManager
Moves a document from it's current community to another.
moveMessage(PrivateMessage, PrivateMessageFolder) - Method in interface com.jivesoftware.community.PrivateMessageFolder
Moves a private message to another folder.
moveThread(ForumThread, Community) - Method in interface com.jivesoftware.community.ForumManager
Moves a thread from one community to another.
MultiOptionDocumentField - Interface in com.jivesoftware.community
An extension of the document field interface to support multi optioned field types such as radio and selection lists.
MULTIPLE_SELECTIONS_ALLOWED - Static variable in interface com.jivesoftware.community.Poll
Mode to allow users to select multiple options in a poll.

N

name - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
Name - Annotation Type in com.jivesoftware.community.annotations
Used to provide a name that a bean may be referenced by in the admin tool.
name - Variable in class com.jivesoftware.community.cache.DefaultCache
The name of the cache.
NameAlreadyExistsException - Exception in com.jivesoftware.community
Thrown if the specified name already exists on the object.
NameAlreadyExistsException() - Constructor for exception com.jivesoftware.community.NameAlreadyExistsException
 
NameAlreadyExistsException(String) - Constructor for exception com.jivesoftware.community.NameAlreadyExistsException
 
NEGATIVE - Static variable in class com.jivesoftware.community.PermissionType
The negative permission type indicates that the permission should be 'revoked' or 'removed' from permissions retrieved from parent object(s).
next() - Method in interface com.jivesoftware.community.JiveIterator
Returns the next element in the list.
nextID() - Method in interface com.jivesoftware.community.JiveIterator
Returns the ID of the next element in the iteration.
NO_MARKUP_STRATEGY - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
A render stragegy used to render text without any markup
NONE - Static variable in class com.jivesoftware.community.Permissions
No permissions.
NORMAL_WATCH - Static variable in interface com.jivesoftware.community.Watch
Normal watch type.
NOT_ALLOWED - Static variable in exception com.jivesoftware.community.PrivateMessageRejectedException
 
NOT_MODE - Static variable in class com.jivesoftware.community.DocumentResultFilter
 
NOTFOUND - Static variable in class com.jivesoftware.community.action.JiveActionSupport
An action return type that indicates that the resource being requested doesn't exist.
NotFoundException - Exception in com.jivesoftware.community
Thrown when trying to load an object that does not exist, or the object could not be loaded.
NotFoundException() - Constructor for exception com.jivesoftware.community.NotFoundException
 
NotFoundException(String) - Constructor for exception com.jivesoftware.community.NotFoundException
 
NotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.community.NotFoundException
 
NotFoundException(Throwable) - Constructor for exception com.jivesoftware.community.NotFoundException
 
NotFoundException - Exception in com.jivesoftware.spi.user
Thrown when a resource is not be found.
NotFoundException() - Constructor for exception com.jivesoftware.spi.user.NotFoundException
 
NotFoundException(String) - Constructor for exception com.jivesoftware.spi.user.NotFoundException
 
NotFoundException(Throwable) - Constructor for exception com.jivesoftware.spi.user.NotFoundException
 
NotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.spi.user.NotFoundException
 
NotUniqueException - Exception in com.jivesoftware.community
Thrown by an object when an action is attempted on an object where a parameter (say a name) has to be unique but is not.
NotUniqueException() - Constructor for exception com.jivesoftware.community.NotUniqueException
 
NotUniqueException(String) - Constructor for exception com.jivesoftware.community.NotUniqueException
 
NotUniqueException(String, Throwable) - Constructor for exception com.jivesoftware.community.NotUniqueException
 
NotUniqueException(Throwable) - Constructor for exception com.jivesoftware.community.NotUniqueException
 
NoValidation - Annotation Type in com.jivesoftware.community.web.webwork
Used to tell the WebWork validation framework not to validate an action
NULL_INT - Static variable in class com.jivesoftware.community.QuestionFilter
An integer value that represents NULL.
NULL_INT - Static variable in class com.jivesoftware.community.ResultFilter
An integer value that represents NULL.

O

objectID - Variable in class com.jivesoftware.community.EntityDescriptor
 
objectType - Variable in class com.jivesoftware.community.EntityDescriptor
 
OFFLINE - Static variable in class com.jivesoftware.community.JiveConstants
 
open - Static variable in class com.jivesoftware.community.Question.State
The question is not resolved.
OpenSearchDescriptorParseException - Exception in com.jivesoftware.community.search.opensearch
An exception thrown when trying to parse an OpenSearch Descriptor file.
OpenSearchDescriptorParseException(String) - Constructor for exception com.jivesoftware.community.search.opensearch.OpenSearchDescriptorParseException
 
OpenSearchQueryException - Exception in com.jivesoftware.community.search.opensearch
An exception thrown when trying to query a SearchEngine with parseable results.
OpenSearchQueryException(Throwable) - Constructor for exception com.jivesoftware.community.search.opensearch.OpenSearchQueryException
 
optimize() - Method in interface com.jivesoftware.community.ProfileSearchManager
Optimizes the underlying search index for maximum speed.
optimize() - Method in interface com.jivesoftware.community.SearchManager
Optimizes the underlying search index for maximum speed.
OPTIMIZE_COMPLETED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index optimize is completed.
OPTIMIZE_COMPLETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index optimize is completed.
OPTIMIZE_STARTED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index optimize is started.
OPTIMIZE_STARTED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index optimize is started.
optimizeCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index optimization is completed.
optimizeCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index optimization is completed.
optimizeStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index optimization is started.
optimizeStarted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index optimization is started.
OR_MODE - Static variable in class com.jivesoftware.community.ResultFilter
'OR' mode;
OSWORKFLOW_ENTRY - Static variable in class com.jivesoftware.community.JiveConstants
 
OSWORKFLOW_STEP - Static variable in class com.jivesoftware.community.JiveConstants
 

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
parentPluginMap - Variable in class com.jivesoftware.base.plugin.PluginManager
 
performSearch(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Performs a query agaist the search URL with the specified search terms.
performTestQuery() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Performs a test query using the query test term.
PERM_HIDDEN_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
Used as an alternative to removing messages from the database.
Permissions - Class in com.jivesoftware.community
Represents a set of permissions that an entity has for an object in the system.
Permissions(long) - Constructor for class com.jivesoftware.community.Permissions
Create a new permissions object with the specified permissions.
Permissions(Permissions, Permissions) - Constructor for class com.jivesoftware.community.Permissions
Creates a new Permission object by combining two permissions objects.
PermissionsManager - Interface in com.jivesoftware.community
Manages permissions for users and groups on a particular resource.
PermissionType - Class in com.jivesoftware.community
A class to represent the two modes of permissions - additive and negative.
PersistFilterSettings - Annotation Type in com.jivesoftware.community.renderer.annotations
 
Plugin<T> - Interface in com.jivesoftware.base.plugin
Plugin interface.
plugin - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
pluginCreated(String, Plugin<?>) - Method in interface com.jivesoftware.base.plugin.PluginListener
Called when a plugin has been created.
pluginCSSs - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginDestroyed(String, Plugin<?>) - Method in interface com.jivesoftware.base.plugin.PluginListener
Called when a plugin has been destroyed.
pluginDirectory - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginDirectory - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
pluginDirs - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginJavascripts - Variable in class com.jivesoftware.base.plugin.PluginManager
 
PluginListener - Interface in com.jivesoftware.base.plugin
Allows for notifications that a plugin has been either created or destroyed.
pluginListeners - Variable in class com.jivesoftware.base.plugin.PluginManager
 
PluginManager - Class in com.jivesoftware.base.plugin
Loads and manages plugins.
PluginManager(File) - Constructor for class com.jivesoftware.base.plugin.PluginManager
Constructs a new plugin manager.
pluginManager - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
pluginMeta - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginMetaData - Variable in class com.jivesoftware.base.plugin.MacroContext
 
PluginMetaDataImpl - Class in com.jivesoftware.base.plugin
Provides all information about a plugin
PluginMetaDataImpl(Plugin<?>, PluginClassLoader, PluginManager, Document, File) - Constructor for class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
pluginMonitor - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginProperties - Variable in class com.jivesoftware.base.plugin.PluginManager
 
pluginProviders - Variable in class com.jivesoftware.base.plugin.PluginManager
 
plugins - Variable in class com.jivesoftware.base.plugin.PluginManager
 
POLL - Static variable in class com.jivesoftware.community.JiveConstants
 
Poll - Interface in com.jivesoftware.community
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.community.event.PollEvent
A poll was created.
POLL_DELETED - Static variable in class com.jivesoftware.community.event.PollEvent
A poll is about to be deleted.
pollCache - Static variable in class com.jivesoftware.community.PollManagerFactory
 
pollCreated(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when a poll is created.
pollDeleted(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when a poll is deleted.
PollEvent - Class in com.jivesoftware.community.event
A class for Poll events.
PollEvent(int, Poll, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.PollEvent
Creates a new message event.
PollEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for PollEvents.
PollException - Exception in com.jivesoftware.community
A poll exception is thrown by methods in the Poll class.
PollException() - Constructor for exception com.jivesoftware.community.PollException
 
PollException(String) - Constructor for exception com.jivesoftware.community.PollException
 
PollException(Throwable) - Constructor for exception com.jivesoftware.community.PollException
 
PollException(String, Throwable) - Constructor for exception com.jivesoftware.community.PollException
 
PollListener - Interface in com.jivesoftware.community.event
A PollListener gets notified anytime a poll event is fired.
PollManager - Interface in com.jivesoftware.community
Provides a manager to create, retrieve and delete polls.
PollManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of a PollManager
POPULARITY - Static variable in class com.jivesoftware.community.JiveConstants
 
possibly_resolved - Static variable in class com.jivesoftware.community.Question.State
There are one or more possible answers to the question.
POST_CREATED - Static variable in class com.jivesoftware.community.event.BlogPostEvent
Post was added to the system.
POST_DELETING - Static variable in class com.jivesoftware.community.event.BlogPostEvent
Post is about to be deleted.
POST_MODIFIED - Static variable in class com.jivesoftware.community.event.BlogPostEvent
Post was modified.
POST_RATED - Static variable in class com.jivesoftware.community.event.BlogPostEvent
Post was rated.
POST_VIEWED - Static variable in class com.jivesoftware.community.event.BlogPostEvent
Post was viewed.
postCreated(BlogPostEvent) - Method in interface com.jivesoftware.community.event.BlogPostListener
Fired when a post has been added to the system.
postCreated(BlogPostEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
postDeleting(BlogPostEvent) - Method in interface com.jivesoftware.community.event.BlogPostListener
Fired when a post is about to be deleted from the system.
postDeleting(BlogPostEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
postModified(BlogPostEvent) - Method in interface com.jivesoftware.community.event.BlogPostListener
Fired when a post has been modified in the system.
postModified(BlogPostEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
postViewed(BlogPostEvent) - Method in interface com.jivesoftware.community.event.BlogPostListener
Fired when a post has been viewed in the system.
postViewed(BlogPostEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
Presence - Interface in com.jivesoftware.community
A Presence encapsulates information relating to the owning user such as login time, status and last update time.
PresenceManager - Interface in com.jivesoftware.community
The presence manager creates presences and keeps track on a global basis who's online.
presenceReceived(Presence, Presence) - Method in interface com.jivesoftware.community.event.XMPPListener
A presence update was received for an XMPP user.
PresenterTemplateException - Exception in com.jivesoftware.community
Thrown if there are errors processing a presentation template
PresenterTemplateException() - Constructor for exception com.jivesoftware.community.PresenterTemplateException
 
PresenterTemplateException(String) - Constructor for exception com.jivesoftware.community.PresenterTemplateException
 
PresenterTemplateException(String, Throwable) - Constructor for exception com.jivesoftware.community.PresenterTemplateException
 
PresenterTemplateException(Throwable) - Constructor for exception com.jivesoftware.community.PresenterTemplateException
 
previous() - Method in interface com.jivesoftware.community.JiveIterator
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
 
PRIVATE_INFORMATION - Static variable in class com.jivesoftware.community.AbuseType
Type representing a private information abuse report.
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to get and send private messages.
PRIVATE_MESSAGE_FOLDER - Static variable in class com.jivesoftware.community.JiveConstants
 
PRIVATE_MESSAGE_READ - Static variable in class com.jivesoftware.community.event.PrivateMessageEvent
 
PRIVATE_MESSAGE_SENT - Static variable in class com.jivesoftware.community.event.PrivateMessageEvent
A private message was sent.
PrivateMessage - Interface in com.jivesoftware.community
Private messages are used for user to user communication.
PrivateMessageEvent - Class in com.jivesoftware.community.event
A class for PrivateMessage events.
PrivateMessageEvent(int, PrivateMessage, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.PrivateMessageEvent
Creates a new private message event.
PrivateMessageEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for PrivateMessageEvents.
PrivateMessageFolder - Interface in com.jivesoftware.community
Holds private messages.
PrivateMessageFolderNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified PrivateMessageFolder was not found
PrivateMessageFolderNotFoundException() - Constructor for exception com.jivesoftware.community.PrivateMessageFolderNotFoundException
 
PrivateMessageFolderNotFoundException(String) - Constructor for exception com.jivesoftware.community.PrivateMessageFolderNotFoundException
 
PrivateMessageListener - Interface in com.jivesoftware.community.event
A PrivateMessageListener gets notified anytime a private message event is fired.
PrivateMessageManager - Interface in com.jivesoftware.community
Manages the private message feature.
PrivateMessageNotFoundException - Exception in com.jivesoftware.community
Thrown when a PrivateMessage was not found
PrivateMessageNotFoundException() - Constructor for exception com.jivesoftware.community.PrivateMessageNotFoundException
 
PrivateMessageNotFoundException(String) - Constructor for exception com.jivesoftware.community.PrivateMessageNotFoundException
 
privateMessageRead(PrivateMessageEvent) - Method in interface com.jivesoftware.community.event.PrivateMessageListener
Fired when a private message is read.
PrivateMessageRejectedException - Exception in com.jivesoftware.community
Thrown when a PrivateMessage is prevented from being posted.
PrivateMessageRejectedException(int) - Constructor for exception com.jivesoftware.community.PrivateMessageRejectedException
Creates a new PrivateMessageRejectedException.
privateMessageSent(PrivateMessageEvent) - Method in interface com.jivesoftware.community.event.PrivateMessageListener
Fired when a private message is sent.
processFreemarkerTemplate(Configuration, SimpleHash, String, Locale, TimeZone) - Static method in class com.jivesoftware.community.widget.BaseWidget
Processes the specified template file and returns a String containing the content of the template file.
PROFANITY - Static variable in class com.jivesoftware.community.AbuseType
Type representing a profanity abuse report.
PROFILE_FIELD - Static variable in class com.jivesoftware.community.JiveConstants
 
PROFILE_MODIFIED - Static variable in class com.jivesoftware.community.event.ProfileEvent
Event type for whenever a user profile is modified.
ProfileEvent - Class in com.jivesoftware.community.event
A class for UserProfile events.
ProfileEvent(int, User) - Constructor for class com.jivesoftware.community.event.ProfileEvent
 
ProfileEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for UserProfile events.
ProfileField - Class in com.jivesoftware.community
A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'.
ProfileField() - Constructor for class com.jivesoftware.community.ProfileField
 
ProfileField.Type - Enum in com.jivesoftware.community
A typesafe enum class for ProfileField types.
ProfileFieldFormatter - Interface in com.jivesoftware.community.field.formatter
Profile field formatter format a profile field for display to the end user.
ProfileFieldManager - Interface in com.jivesoftware.community
Defines methods used to create, access, update, and remove profile fields data.
ProfileFieldOption - Class in com.jivesoftware.community
Represents a possible option of a ProfileField
ProfileFieldOption() - Constructor for class com.jivesoftware.community.ProfileFieldOption
 
ProfileFieldValue - Class in com.jivesoftware.community
This class represents a possible value for a ProfileField.
ProfileFieldValue(long) - Constructor for class com.jivesoftware.community.ProfileFieldValue
 
ProfileListener - Interface in com.jivesoftware.community.event
A ProfileListener gets notified anytime a profile event is fired.
ProfileManager - Interface in com.jivesoftware.community
Manages user profile data.
ProfileSearchFilter - Class in com.jivesoftware.community
This class can filter user search results based on specific values for a ProfileField.
ProfileSearchFilter() - Constructor for class com.jivesoftware.community.ProfileSearchFilter
 
ProfileSearchFilter(long, String) - Constructor for class com.jivesoftware.community.ProfileSearchFilter
 
ProfileSearchIndexEvent - Class in com.jivesoftware.community.event
A class for profile search index events.
ProfileSearchIndexEvent(int, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
ProfileSearchIndexEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for ProfileSearchIndexEvents.
ProfileSearchIndexListener - Interface in com.jivesoftware.community.event
A ProfileSearchIndexListener gets notified anytime a profile search index event is fired.
ProfileSearchManager - Interface in com.jivesoftware.community
Manages the search feature of Jive Expert User Search by defining properties of the search indexer.
ProfileSearchQuery - Class in com.jivesoftware.community
Contains the necessary information required to perform a user search.
ProfileSearchQuery(String) - Constructor for class com.jivesoftware.community.ProfileSearchQuery
Creates a new query that does not contain any filters and searches all available user fields.
ProfileSearchQuery(String, List<ProfileSearchFilter>, boolean, boolean, boolean, boolean, boolean) - Constructor for class com.jivesoftware.community.ProfileSearchQuery
Creates a new query, results sorted by relevance.
ProfileSearchQuery(String, List<ProfileSearchFilter>, Sort, boolean, boolean, boolean, boolean, boolean, Community) - Constructor for class com.jivesoftware.community.ProfileSearchQuery
Creates a new query, results sorted by the given sort.
ProfileSearchResult - Class in com.jivesoftware.community
Contains the necessary user information to be displayed during a user search.
ProfileSearchResult() - Constructor for class com.jivesoftware.community.ProfileSearchResult
 
ProfileSearchResult(User, Document, float, long) - Constructor for class com.jivesoftware.community.ProfileSearchResult
 
profileUpdated(ProfileEvent) - Method in interface com.jivesoftware.community.event.ProfileListener
Fired when a user's profile is updated.
PROPERTY_ABUSE_ENABLED - Static variable in interface com.jivesoftware.community.AbuseManager
 
PROPERTY_ABUSE_THRESHOLD - Static variable in interface com.jivesoftware.community.AbuseManager
 
PROPERTY_ADDED - Static variable in class com.jivesoftware.base.event.JivePropertyEvent
A new property was added
PROPERTY_BANNED_USER_ENABLE - Static variable in interface com.jivesoftware.community.BanManager
****** Ban Setting Properties ******
PROPERTY_EMAIL_ADDRESS - Static variable in interface com.jivesoftware.community.BanManager
 
PROPERTY_EMAIL_ADDRESS - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_EMAIL_BODY - Static variable in interface com.jivesoftware.community.BanManager
 
PROPERTY_EMAIL_BODY - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_EMAIL_BODY - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_EMAIL_ENABLED - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_EMAIL_NAME - Static variable in interface com.jivesoftware.community.BanManager
 
PROPERTY_EMAIL_NAME - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_EMAIL_NOTIFY_ENABLED - Static variable in interface com.jivesoftware.community.BanManager
 
PROPERTY_EMAIL_SUBJECT - Static variable in interface com.jivesoftware.community.BanManager
 
PROPERTY_EMAIL_SUBJECT - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_EMAIL_SUBJECT - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_HUMAN_VALIDATION_ENABLED - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_MESSAGE_TIME_APPROVED - Static variable in interface com.jivesoftware.community.ModerationManager
 
PROPERTY_MODIFIED - Static variable in class com.jivesoftware.base.event.JivePropertyEvent
A property was modified.
PROPERTY_MODIFIED - Static variable in class com.jivesoftware.community.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.
PROPERTY_TERMS_ENABLED - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_TERMS_URL - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_USER_VALIDATION_KEY - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_VALIDATION_ENABLED - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_WELCOME_EMAIL_BODY - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_WELCOME_EMAIL_SUBJECT - Static variable in interface com.jivesoftware.community.RegistrationManager
 
PROPERTY_WELCOME_ENABLED - Static variable in interface com.jivesoftware.community.RegistrationManager
 
propertyModified(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when an extended property of a question is added, modified, or deleted.
PropertyNames - Annotation Type in com.jivesoftware.community.annotations
Used to denote properties that can be set for configuration in the admin tool.
PUBLISH_DATE - Static variable in class com.jivesoftware.community.BlogPostResultFilter
Sort on the publish date.
publishWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Publishes the WidgetFrames for the specified parent JiveObject.
put(Object, Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
putAll(Map) - Method in class com.jivesoftware.community.cache.DefaultCache
 

Q

QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 
Question - Interface in com.jivesoftware.community
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.community
Type-safe enumeration for the state a question is in.
QUESTION_ADDED - Static variable in class com.jivesoftware.community.event.QuestionEvent
Question was added to the system.
QUESTION_DELETED - Static variable in class com.jivesoftware.community.event.QuestionEvent
Question was deleted.
QUESTION_STATE_MODIFIED - Static variable in class com.jivesoftware.community.event.QuestionEvent
The question resolution state was modified.
questionAdded(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when a question has been added to the system.
questionDeleted(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when a question is about to be deleted from the system.
QuestionEvent - Class in com.jivesoftware.community.event
A class for Question events.
QuestionEvent(int, Question, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.QuestionEvent
Creates a new question event.
QuestionEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for Question events.
QuestionFilter - Class in com.jivesoftware.community
Filters and sorts lists of questions from QuestionManager.
QuestionFilter() - Constructor for class com.jivesoftware.community.QuestionFilter
Constructs a new QuestionFilter.
QuestionFilter.SortField - Class in com.jivesoftware.community
Type-safe enumeration for field that be sorted on.
QuestionListener - Interface in com.jivesoftware.community.event
A QuestionListener gets notified anytime a question event is fired.
QuestionManager - Interface in com.jivesoftware.community
Manages questions.
questionStateModified(QuestionEvent) - Method in interface com.jivesoftware.community.event.QuestionListener
Fired when the resolution state of a question changes.

R

RACIAL - Static variable in class com.jivesoftware.community.AbuseType
Type representing a racial abuse report.
RATE_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to rate documents in a community
RATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to rate messages.
RATING - Static variable in class com.jivesoftware.community.JiveConstants
 
Rating - Interface in com.jivesoftware.community
A container object for Ratings.
RatingManager - Interface in com.jivesoftware.community
Provides optional rating of JiveContentObjects.
READ - Static variable in interface com.jivesoftware.community.ReadTracker
Status to indicate that the object has been read.
READ_BLOG - Static variable in class com.jivesoftware.community.Permissions
Permission to read blog a blog.
READ_COMMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to read a comment
READ_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to read a document
READ_STAT - Static variable in class com.jivesoftware.community.JiveConstants
 
READ_STAT_SESSION - Static variable in class com.jivesoftware.community.JiveConstants
 
readExternal(DataInput) - Method in class com.jivesoftware.community.Ban
 
readExternal(DataInput) - Method in class com.jivesoftware.community.DocumentFieldValue
 
readExternal(DataInput) - Method in class com.jivesoftware.community.EntityDescriptor
 
readExternal(DataInput) - Method in class com.jivesoftware.community.ProfileField
 
readExternal(DataInput) - Method in class com.jivesoftware.community.ProfileFieldOption
 
readExternal(DataInput) - Method in class com.jivesoftware.community.ProfileFieldValue
 
readmeExists - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
ReadTracker - Interface in com.jivesoftware.community
A way to track the read status of forum threads and messages.
REBUILD_COMPLETED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index rebuild is completed.
REBUILD_COMPLETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index rebuild is completed.
REBUILD_STARTED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index rebuild is started.
REBUILD_STARTED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index rebuild is started.
rebuildCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index rebuild is completed.
rebuildCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index rebuild is completed.
rebuildIndex() - Method in interface com.jivesoftware.community.ProfileSearchManager
Manually rebuild the entire index.
rebuildIndex() - Method in interface com.jivesoftware.community.SearchManager
Manually rebuild the entire index.
rebuildStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index rebuild is started.
rebuildStarted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index rebuild is started.
receive(ServiceEvent<T, O>) - Method in interface com.jivesoftware.spi.ServiceEventListener
Event dispatcher will call this method to send the event to the listener.
RECIPIENT_MAILBOX_FULL - Static variable in exception com.jivesoftware.community.PrivateMessageRejectedException
 
recursiveChildren(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns an Iterable for all child comments (and sub-children, etc) of the parent.
REGISTERED_USERS - Static variable in class com.jivesoftware.community.JiveConstants
 
registeredUserHasPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Returns true if registered users have a particular permission.
registerMacro(BaseMacro) - Method in class com.jivesoftware.base.plugin.PluginManager
Registers a plugin macro with the owner's render manager.
registerMacros(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerManager(Class<?>, JiveManager) - Method in class com.jivesoftware.community.lifecycle.JiveApplication.ManagerHandler
 
registerPlugin(Element, PluginClassLoader, Plugin<?>, File) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerPluginCSSURLs(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerPluginJavascriptURLs(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerSitemeshElements(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerURLMapper(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerWebServices(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
registerWidgets(PluginMetaData) - Method in class com.jivesoftware.base.plugin.PluginManager
 
RegistrationManager - Interface in com.jivesoftware.community
Manages validation settings and validating new user accounts.
reject(User) - Method in interface com.jivesoftware.community.Document
Marks this document as being rejected by the specified user.
reject(AuthToken, ForumMessage) - Method in interface com.jivesoftware.community.ModerationManager
Reject a moderated message
REJECTED_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
Messages rejected by a moderator will be marked with this value.
RejectedException - Exception in com.jivesoftware.community
Thrown by a JiveInterceptor when a jive object is prevented from being posted.
RejectedException() - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(String) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(String, JiveObject) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(Throwable, JiveObject) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(Throwable) - Constructor for exception com.jivesoftware.community.RejectedException
 
RELIGIOUS - Static variable in class com.jivesoftware.community.AbuseType
Type representing a religious abuse report.
remove(Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
remove(Object, boolean) - Method in class com.jivesoftware.community.cache.DefaultCache
 
remove() - Method in interface com.jivesoftware.community.JiveIterator
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.community.renderer.RenderManager
Removes all filters from the current context.
removeAllGroupPermissions(PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Revokes all group permissions.
removeAllListeners() - Method in class com.jivesoftware.base.event.JivePropertyEventDispatcher
Unregisters all listeners
removeAllowedType(String) - Method in interface com.jivesoftware.community.AttachmentManager
Removes a content type fromt he list of explicitly allowed types.
removeAllowedType(String) - Method in interface com.jivesoftware.community.BinaryBodyManager
Removes a content type fromt he list of explicitly allowed types.
removeAllowedType(String) - Method in interface com.jivesoftware.community.ImageManager
Removes a content type from the list of explicitly allowed types.
removeAllPermissions(int, long) - Method in interface com.jivesoftware.community.PermissionsManager
 
removeAllRatings(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Remove all ratings from the specified content object
removeAllTags(JiveObject) - Method in interface com.jivesoftware.community.TagManager
Disassociates this object with all tags.
removeAllUserPermissions(PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Removes all user permissions.
removeAnonymousUserPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Removes a permission of the specified PermissionType for anonymous users.
removeAnonymousVote(int, String) - Method in interface com.jivesoftware.community.Poll
Remove a guest vote.
removeApprover(User) - Method in interface com.jivesoftware.community.Document
Removes the user as a document approver on this document.
removeAuthor(User) - Method in interface com.jivesoftware.community.Document
Removes the supplied User as an author of this document.
removeBan(long) - Method in interface com.jivesoftware.community.BanManager
Removes a ban entry from the database
removeBlog(Blog) - Method in interface com.jivesoftware.community.Community
Disassociates the specified Blog from this community.
removeDisallowedType(String) - Method in interface com.jivesoftware.community.AttachmentManager
Removes a content type from the list of explicitly disallowed types.
removeDisallowedType(String) - Method in interface com.jivesoftware.community.BinaryBodyManager
Removes a content type from the list of explicitly disallowed types.
removeDisallowedType(String) - Method in interface com.jivesoftware.community.ImageManager
Removes a content type from the list of explicitly disallowed types.
removeDocumentApprover(User) - Method in interface com.jivesoftware.community.Community
Remove this user as a document approver for this community.
removeFilterRenderTypes(String, List<RenderType>) - Method in interface com.jivesoftware.community.renderer.RenderManager
Removes a set of render types from the given filter.
removeFromIndex(User) - Method in interface com.jivesoftware.community.ProfileSearchManager
Removes an individual user from the index.
removeFromIndex(Blog) - Method in interface com.jivesoftware.community.SearchManager
Removes a blog from the index.
removeFromIndex(BlogPost) - Method in interface com.jivesoftware.community.SearchManager
Removes an individual blog post from the index.
removeFromIndex(ForumMessage) - Method in interface com.jivesoftware.community.SearchManager
Removes an individual message from the index.
removeFromIndex(ForumThread) - Method in interface com.jivesoftware.community.SearchManager
Removes a thread from the index.
removeFromIndex(Document) - Method in interface com.jivesoftware.community.SearchManager
Removes an individual document from the index.
removeFromIndex(Comment) - Method in interface com.jivesoftware.community.SearchManager
Removes an individual comment from the index.
removeFromIndex(Attachment) - Method in interface com.jivesoftware.community.SearchManager
Removes an individual attachment from the index.
removeFromIndex(Community) - Method in interface com.jivesoftware.community.SearchManager
Removes a community from the index.
removeFromIndex(DocumentType) - Method in interface com.jivesoftware.community.SearchManager
Removes all documents of a given document type from the index.
removeGroupPermission(Group, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Removes a permission of the specified PermissionType for a group.
removeImporter(Importer) - Method in class com.jivesoftware.community.importer.ImporterFactory
Removes an importer from the list of available importers.
removeInterceptor(int) - Method in interface com.jivesoftware.community.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(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.community.event.AnnouncementEventDispatcher
 
removeListener(AttachmentListener) - Method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
removeListener(BlogListener) - Method in class com.jivesoftware.community.event.BlogEventDispatcher
 
removeListener(BlogPostListener) - Method in class com.jivesoftware.community.event.BlogPostEventDispatcher
 
removeListener(CommentListener) - Method in class com.jivesoftware.community.event.CommentEventDispatcher
 
removeListener(CommunityListener) - Method in class com.jivesoftware.community.event.CommunityEventDispatcher
 
removeListener(DocumentListener) - Method in class com.jivesoftware.community.event.DocumentEventDispatcher
 
removeListener(EmailListener) - Method in class com.jivesoftware.community.event.EmailEventDispatcher
 
removeListener(ImageListener) - Method in class com.jivesoftware.community.event.ImageEventDispatcher
 
removeListener(MessageListener) - Method in class com.jivesoftware.community.event.MessageEventDispatcher
 
removeListener(PollListener) - Method in class com.jivesoftware.community.event.PollEventDispatcher
Removes an event listener from the dispatcher.
removeListener(PrivateMessageListener) - Method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
 
removeListener(ProfileListener) - Method in class com.jivesoftware.community.event.ProfileEventDispatcher
 
removeListener(ProfileSearchIndexListener) - Method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
 
removeListener(QuestionListener) - Method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
removeListener(SearchIndexListener) - Method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
 
removeListener(StorageManagerListener) - Method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
 
removeListener(TagListener) - Method in class com.jivesoftware.community.event.TagEventDispatcher
 
removeListener(TagSetListener) - Method in class com.jivesoftware.community.event.TagSetEventDispatcher
 
removeListener(ThreadListener) - Method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
removeListener(TrackbackListener) - Method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
removeListener(ApplicationLifeCycle.Listener) - Method in interface com.jivesoftware.community.lifecycle.ApplicationLifeCycle
Removes an application life cycle listener.
removeListener(ServiceEventListener<T, O>) - Method in class com.jivesoftware.spi.ServiceEventDispatcher
Un-register a listener
removeListener(ServiceEventListener<T, O>) - Method in interface com.jivesoftware.spi.ServiceEventSource
Used to un-register listeners
removeMapListener(MapListener) - Method in class com.jivesoftware.community.cache.DefaultCache
Remove a map listener.
removeMapListener(MapListener, Object) - Method in class com.jivesoftware.community.cache.DefaultCache
 
removeMapListener(MapListener, Filter) - Method in class com.jivesoftware.community.cache.DefaultCache
 
removeMember(User) - Method in interface com.jivesoftware.base.Group
Removes a member from the group.
removePluginCSSURLs(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Remove CSS source urls specified by the plugin
removePluginJavaScriptURLs(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Remove javascript source urls specified by the plugin
removePluginListener(PluginListener) - Method in class com.jivesoftware.base.plugin.PluginManager
Unregisters a plugin applicationLifeCycleListener.
removeRating(Rating) - Method in interface com.jivesoftware.community.RatingManager
Remove the specified rating from the list of currently available ratings.
removeRating(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Removes a rating to the JiveContentObject.
removeRegisteredUserPermission(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Removes a permission of the specified PermissionType for registered users.
removeRenderFilter(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Removes the specified filter from the list of currently configured filters.
removeResolutionState(Question.State) - Method in class com.jivesoftware.community.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.community.ThreadResultFilter
Removes a resolution state from the set of states that will be included in filtered results.
removeReviewer(User) - Method in interface com.jivesoftware.community.Document
Removes the supplied User as a reviewer of this document.
removeSearchEngineByID(long) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Remove the search engine by its ID.
removeTag(ContentTag, JiveObject) - Method in interface com.jivesoftware.community.TagManager
Disassociates this object with the given tag.
removeTag(ContentTag) - Method in interface com.jivesoftware.community.TagSet
Removes the supplied ContentTag from this TagSet if it is a member.
removeTextExtractor(String) - Method in interface com.jivesoftware.community.SearchManager
Removes an existing text extractor from the list of current text extractors.
removeUser(User) - Method in interface com.jivesoftware.community.Blog
Removes a user from having permission to post to this blog.
removeUser(User, boolean) - Method in interface com.jivesoftware.community.Blog
Removes a user from having permission to post to this blog and optionally deletes posts by this user.
removeUser(User) - Method in interface com.jivesoftware.community.Roster
Remove a user from the roster.
removeUserPermission(User, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Removes a permission of the specified PermissionType for the specified user.
removeUserVote(int, User) - Method in interface com.jivesoftware.community.Poll
Remove a user vote.
removeWidget(long) - Method in interface com.jivesoftware.community.widget.WidgetManager
Removes a Widget from the system.
removeWidgetFrame(WidgetFrame) - Method in interface com.jivesoftware.community.widget.WidgetManager
Removes the specified WidgetFrame from the system.
removeXMPPListener(XMPPListener) - Method in class com.jivesoftware.community.xmpp.IMManager
Removes an XMPP listener.
render(String, Map<String, String>, MacroContext) - Method in interface com.jivesoftware.base.plugin.Macro
Render the macro.
render(String, RenderContext) - Method in interface com.jivesoftware.community.renderer.Renderer
Render the input string according to the RenderStrategy and RenderTarget specified by the given render context.
render(JiveObject, RenderType, String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Applies filters to the specified string.
render(JiveObject, RenderType, RenderStrategy, String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Applies filters to the specified string.
render(WidgetContext, Widget.ContainerSize) - Method in interface com.jivesoftware.community.widget.Widget
Renders the HTML content of the widget.
RENDER_ALL - Static variable in class com.jivesoftware.community.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.community.renderer.RenderStrategy
Use this render flag to render images.
RENDER_LINKS - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
Use this render flag to render links.
RENDER_LISTS - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
Use this render flag to render lists.
RENDER_MACROS - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
Use this render flag to render macros.
RENDER_TABLES - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
Use this render flag to render tables.
RENDER_TEXT_DECORATION - Static variable in class com.jivesoftware.community.renderer.RenderStrategy
Use this render flag to render text decorations.
RenderContext - Interface in com.jivesoftware.community.renderer
Encapsulates the context in which a piece of content is being rendered.
RenderedTextStore - Class in com.jivesoftware.community.renderer
A store for text snippets.
RenderedTextStore() - Constructor for class com.jivesoftware.community.renderer.RenderedTextStore
 
Renderer - Interface in com.jivesoftware.community.renderer
A Renderer is an object that allows for converting text markup to html and back again.
RendererFactory - Class in com.jivesoftware.community.renderer
A factory for creating Renderer's.
RenderFilter - Interface in com.jivesoftware.community.renderer
A filter is an object that performs filtering on Strings.
renderImages() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
renderLinks() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
renderLists() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
RenderMacro - Interface in com.jivesoftware.community.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.community.renderer.RenderStrategy
 
RenderManager - Interface in com.jivesoftware.community.renderer
A manager to manage filters to be used for render operations.
RenderPipe - Class in com.jivesoftware.community.renderer
A container to hold the filters that are to be used for rendering text.
RenderPipe(RenderFilter[]) - Constructor for class com.jivesoftware.community.renderer.RenderPipe
 
RenderStrategy - Class in com.jivesoftware.community.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.community.renderer.RenderStrategy
 
RenderStrategy(RenderTarget, long) - Constructor for class com.jivesoftware.community.renderer.RenderStrategy
 
renderTables() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
RenderTarget - Enum in com.jivesoftware.community.renderer
The target of a particular render operation.
renderTextDecoration() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
RenderType - Enum in com.jivesoftware.community.renderer
Defines render types used for jive objects.
RenderTypes - Annotation Type in com.jivesoftware.community.renderer.annotations
Returns the render types supported by a filter or macro.
Replaceable - Annotation Type in com.jivesoftware.community
Used to Mark a JiveManager as replaceable by the user and specifies the jive property key to find the manager implementation.
replaceTokens(String) - Method in class com.jivesoftware.community.renderer.RenderedTextStore
This method will replace all tokens in the provided string with their original text snippets.
reportAbuse(AbuseReport) - Method in interface com.jivesoftware.community.AbuseManager
Creates an abuse report entry in the database and marks the message for moderation
request - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
RequireModule - Annotation Type in com.jivesoftware.community.license.annotations
Used to mark a class as requiring a specific product and optionally an edition.
RequiresCleanInstall - Annotation Type in com.jivesoftware.community.importer
 
reset() - Method in class com.jivesoftware.community.xmpp.IMManager
Restarts the external component connection to Openfire.
resetLocalization() - Static method in class com.jivesoftware.community.JiveGlobals
Resets locale specific settings so they will be reread from properties.
resolution_date - Static variable in class com.jivesoftware.community.QuestionFilter.SortField
 
resolution_state - Static variable in class com.jivesoftware.community.QuestionFilter.SortField
 
resolveAbuseReport(AbuseReport) - Method in interface com.jivesoftware.community.AbuseManager
Resolves an abuse report
resolveAbuseReports(ForumMessage) - Method in interface com.jivesoftware.community.AbuseManager
REsolves all abuse reports for a particular message
resolved - Static variable in class com.jivesoftware.community.Question.State
The question is answered.
response - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
restartPlugin(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManager
Restarts the specified plugin.
restoreDocumentVersion(int, long) - Method in interface com.jivesoftware.community.VersionManager
Restores a document version by creating a copy of the version to restore as the newest document version and returning that document version.
ResultFilter - Class in com.jivesoftware.community
Abstract base class for Clearspace result filters.
ResultFilter() - Constructor for class com.jivesoftware.community.ResultFilter
 
RETURN_PATH - Static variable in interface com.jivesoftware.community.EmailManager
 
reverseActiveAvatarCache - Static variable in class com.jivesoftware.community.AvatarManagerFactory
 
ROSTER - Static variable in class com.jivesoftware.community.JiveConstants
 
Roster - Interface in com.jivesoftware.community
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.community.ThreadResultFilter
 
roundDate(long, int) - Static method in class com.jivesoftware.community.ThreadResultFilter
 
run() - Method in class com.jivesoftware.community.JiveGlobals.ResetLocalizationSettingsClusterTask
 
run() - Method in class com.jivesoftware.community.xmpp.IMManager.LocalRestartTask
 
runArchiver() - Method in interface com.jivesoftware.community.ArchiveManager
Manually runs the archiving process.

S

save() - Method in interface com.jivesoftware.community.Blog
Saves the state of this Blog to the database
save() - Method in interface com.jivesoftware.community.BlogPost
Saves the state of this BlogPost to the database
save() - Method in interface com.jivesoftware.community.Document
Changes to a document are not persisted until this method is called.
save() - Method in interface com.jivesoftware.community.DocumentField
Persists changes of this object to the database.
save() - Method in interface com.jivesoftware.community.DocumentPresenter
Saves the state of this DocuementPresenter to the database
save() - Method in interface com.jivesoftware.community.DocumentType
Persists changes to this DocumentType to the database
save() - Method in interface com.jivesoftware.community.renderer.RenderManager
Saves all filters to the persistent store.
save() - Method in interface com.jivesoftware.community.TagSet
Saves any changes made to this TagSet to the underlying data store
save() - Method in interface com.jivesoftware.community.Trackback
Saves the state of this trackback to the database
saveInterceptors() - Method in interface com.jivesoftware.community.InterceptorManager
Saves all interceptors to the persistent store.
saveMessageAsDraft(PrivateMessage) - Method in interface com.jivesoftware.community.PrivateMessageManager
Saves a message as a draft by storing it in the sender's Drafts folder.
saveSettings(User, WatchSettingsBean) - Method in interface com.jivesoftware.community.WatchManager
Save the watch settings for a user
SEARCH - Static variable in class com.jivesoftware.community.JiveConstants
 
search(ProfileSearchQuery) - Method in interface com.jivesoftware.community.ProfileSearchManager
Returns the hits that correspond to the search query.
SEARCH_ENGINE - Static variable in class com.jivesoftware.community.JiveConstants
 
SEARCH_QUERY - Static variable in class com.jivesoftware.community.JiveConstants
 
SearchEngine - Interface in com.jivesoftware.community.search.opensearch
A SearchEngine is an external source that can be searched.
SearchEngineManager - Interface in com.jivesoftware.community.search.opensearch
The SearchEngineManager is in charge of registering and managing the persistence of SearchEngines.
SearchEngineManagerStats - Class in com.jivesoftware.community.search.opensearch
Get a set of statistics about managed search engines.
SearchEngineManagerStats(Collection<SearchEngine>) - Constructor for class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
SearchEngineNotFoundException - Exception in com.jivesoftware.community.search.opensearch
A runtime exception thrown when a search engine cannot be retrieved by its ID.
SearchEngineNotFoundException(String) - Constructor for exception com.jivesoftware.community.search.opensearch.SearchEngineNotFoundException
 
SearchEngineNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.community.search.opensearch.SearchEngineNotFoundException
 
SearchIndexEvent - Class in com.jivesoftware.community.event
A class for search index events.
SearchIndexEvent(int, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.SearchIndexEvent
 
SearchIndexEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for SearchIndexEvents.
SearchIndexListener - Interface in com.jivesoftware.community.event
A SearchIndexListener gets notified anytime an search index event is fired.
SearchManager - Interface in com.jivesoftware.community
Manages the search feature of Clearspace by defining properties of the search indexer.
SearchQuery - Interface in com.jivesoftware.community
Encapsulates a search for message, document or blog post content.
SearchQueryCriteria - Interface in com.jivesoftware.community
Criteria for searching.
SearchQueryCriteria.SortOrder - Enum in com.jivesoftware.community
Represents the order in which search results will be returned
SearchQueryCriteria.SortType - Enum in com.jivesoftware.community
Represents how search results will be sorted
SearchQueryLogger - Interface in com.jivesoftware.community
This interface provides methods to retrieve query objects previously used for searching.
SearchQueryLoggerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of a SearchQueryLogger.
SearchQueryManager - Interface in com.jivesoftware.community
This manager provides methods to create query objects to be used for searching either the whole system or just in particular areas such as communities.
SearchQueryResult - Interface in com.jivesoftware.community
Encapsulates a search result resulting from a search using the SearchQuery class.
SearchQueryResult.ResultType - Enum in com.jivesoftware.community
Represents the different types of results that can be queried upon
SearchResult - Interface in com.jivesoftware.community.search.opensearch
A SearchResult is a result returned by a query performed against one or many SearchEngines.
SECOND - Static variable in class com.jivesoftware.community.JiveConstants
One second (in milliseconds).
send(EmailMessage) - Method in interface com.jivesoftware.community.EmailManager
Used to send an email message.
SENDER_MAILBOX_FULL - Static variable in exception com.jivesoftware.community.PrivateMessageRejectedException
 
sendMessage(PrivateMessage, User, boolean) - Method in interface com.jivesoftware.community.PrivateMessageManager
Sends a private message to another user.
sendPacket(Packet) - Method in class com.jivesoftware.community.xmpp.IMManager
Sends an XMPP packet to the Openfire server.
sendQuery(IQ, IQResultListener) - Method in class com.jivesoftware.community.xmpp.IMManager
 
sendWelcomeEmail(User) - Method in interface com.jivesoftware.community.RegistrationManager
Sends a welcome email to the given user.
ServiceEvent<T extends java.lang.Enum<?>,O> - Class in com.jivesoftware.spi
Base event class.
ServiceEvent(T, O, Map<?, ?>) - Constructor for class com.jivesoftware.spi.ServiceEvent
 
ServiceEventDispatcher<T extends java.lang.Enum<?>,O> - Class in com.jivesoftware.spi
Base class provides the basic event notification infrastucture.
ServiceEventDispatcher() - Constructor for class com.jivesoftware.spi.ServiceEventDispatcher
 
ServiceEventListener<T extends java.lang.Enum<?>,O> - Interface in com.jivesoftware.spi
API for receiving events from a event source.
ServiceEventSource<T extends java.lang.Enum<?>,O> - Interface in com.jivesoftware.spi
Basic event source api.
ServiceProvider - Interface in com.jivesoftware.spi
A basic lifecycle interface that all Service Provider implementation have to implement.
session - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
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.
SESSION_REFERRER_KEY - Static variable in class com.jivesoftware.community.action.JiveActionSupport
 
set(long, boolean) - Method in class com.jivesoftware.community.Permissions
Sets the permissions given by a bit mask to true or false.
setAbuseThreshold(int) - Method in interface com.jivesoftware.community.AbuseManager
Sets the number of abuse reports needed to automatically hide a message.
setAbuseType(AbuseType) - Method in class com.jivesoftware.community.AbuseReport
Sets the AbuseType for this abuse report.
setActiveAvatar(User, Avatar) - Method in interface com.jivesoftware.community.AvatarManager
Used to make a user use a global avatar, to set no active avatar pass null for the avatar value.
setAdmin(boolean) - Method in class com.jivesoftware.community.ProfileSearchQuery
True if the user performing the search is a system administrator, false otherwise.
setAdminID(long) - Method in class com.jivesoftware.community.Ban
Sets the admin user id that created this ban object.
setAdminID(long) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected admin ID that bans will be filtered on.
setAfterDate(Date) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Sets the earliest date for search results.
setAllowAllByDefault(boolean) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the default allowed content types mode.
setAllowAllByDefault(boolean) - Method in interface com.jivesoftware.community.BinaryBodyManager
Sets the default allowed content types mode.
setAllowAllByDefault(boolean) - Method in interface com.jivesoftware.community.ImageManager
Sets the default allowed content types mode.
setAllowImageResize(boolean) - Method in interface com.jivesoftware.community.AvatarManager
Used to set whether the system should attempt to resize images
setAllTagsRequired(boolean) - Method in class com.jivesoftware.community.ResultFilter
Sets whether or not the content must be tagged with every tag contained in getTags().
setAlterable(boolean) - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Sets whether the associated document field is alterable or not.
setApplicationLifeCycle(ApplicationLifeCycle) - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Method used internally by Jive to set the ApplicationLifeCycle.
setArchiveCommunity(Community, Community) - Method in interface com.jivesoftware.community.ArchiveManager
Sets the "archive community" for the specified community.
setArchiveDays(Community, int) - Method in interface com.jivesoftware.community.ArchiveManager
Sets the number of days that threads in community must be inactive before being archived.
setArchiveMode(Community, int) - Method in interface com.jivesoftware.community.ArchiveManager
Returns the archive mode for the community.
setArchivingEnabled(Community, boolean) - Method in interface com.jivesoftware.community.ArchiveManager
Enables or disables archiving for the specified community.
setAssumedResolved() - Method in interface com.jivesoftware.community.Question
Sets the state to Question.State.assumed_resolved
setAttachmentSearchEnabled(boolean) - Method in interface com.jivesoftware.community.SearchManager
Enables or disables the attachment search feature.
setAttachmentsEnabled(boolean) - Method in interface com.jivesoftware.community.AttachmentManager
Sets whether attachments are enabled, false otherwise.
setAuthor(User) - Method in interface com.jivesoftware.community.DocumentVersion
Returns the user that authored the document version.
setAuthorshipPolicy(int) - Method in interface com.jivesoftware.community.Document
Sets the authorship policy of this document, one of AUTHORSHIP_OPEN, AUTHORSHIP_SINGLE, or AUTHORSHIP_MULTIPLE.
setAuthToken(AuthToken) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setAutoArchiveEnabled(boolean) - Method in interface com.jivesoftware.community.ArchiveManager
Enables or disables auto-archiving.
setAutoArchiveInterval(int) - Method in interface com.jivesoftware.community.ArchiveManager
Sets the inverval between auto archive executions (in hours).
setAutoIndexEnabled(boolean) - Method in interface com.jivesoftware.community.ProfileSearchManager
Enables or disables auto indexing.
setAutoIndexEnabled(boolean) - Method in interface com.jivesoftware.community.SearchManager
Enables or disables auto indexing.
setAutoIndexInterval(int) - Method in interface com.jivesoftware.community.ProfileSearchManager
Sets the number of minutes that indexer should wait between updating the index.
setAutoIndexInterval(int) - Method in interface com.jivesoftware.community.SearchManager
Sets the amount of time that indexer should wait between updating the index.
setAutosaveEnabled(boolean) - Method in interface com.jivesoftware.community.DraftManager
Enables or disables autosave.
setAutosaveInterval(int) - Method in interface com.jivesoftware.community.DraftManager
Sets the amount of time (in seconds) that the browser should wait between updating the draft.
setAvatarsEnabled(boolean) - Static method in class com.jivesoftware.community.AvatarManagerFactory
 
setBanLevel(int) - Method in class com.jivesoftware.community.Ban
Sets the BanLevel for this ban.
setBanLevel(long) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected BanLevel that bans will be filtered on.
setBannedUserID(long) - Method in class com.jivesoftware.community.Ban
Sets the banned user.
setBannedUserID(long) - Method in class com.jivesoftware.community.BanFilter
Sets the ID of the user that bans will be filtered on.
setBanningEnabled(boolean) - Method in interface com.jivesoftware.community.BanManager
Enabled/Disabled Ban feature.
setBanType(int) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected ban type.
setBeforeDate(Date) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Sets the latest date for search results.
setBinaryBody(String, String, InputStream) - Method in interface com.jivesoftware.community.Document
Creates a new body object for the document.
setBinaryBodyEnabled(boolean) - Method in interface com.jivesoftware.community.BinaryBodyManager
Enables or disables binary document bodies.
setBinaryBodyMode(int) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets the mode that will be used to select results if binary body content types have been specified.
setBlogID(long) - Method in class com.jivesoftware.community.BlogPostResultFilter
Sets the blogID that results will be filtered on.
setBlogsEnabled(boolean) - Method in interface com.jivesoftware.community.BlogManager
Enables or disables the blogs feature.
setBody(String) - Method in interface com.jivesoftware.community.Announcement
Sets the body of this announcement.
setBody(String) - Method in interface com.jivesoftware.community.BlogPost
Sets the body of this post.
setBody(String) - Method in interface com.jivesoftware.community.Comment
Sets the comment body.
setBody(String) - Method in interface com.jivesoftware.community.Document
Sets the textual body of the document.
setBody(String) - Method in interface com.jivesoftware.community.Draft
Sets the body of the draft.
setBody(String) - Method in interface com.jivesoftware.community.ForumMessage
Sets the body of this message.
setBody(String) - Method in interface com.jivesoftware.community.PrivateMessage
Sets the body of the message.
setCachingDisabled(boolean) - Method in interface com.jivesoftware.community.renderer.RenderContext
Sets whether caching of generated output is disabled or not.
setCachingDisabled(boolean) - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
setCharacterEncoding(String) - Static method in class com.jivesoftware.community.JiveGlobals
Sets the character set that Jive uses for encoding.
setComment(String) - Method in class com.jivesoftware.community.AbuseReport
Sets a comment explaining this abuse report.
setComment(String) - Method in class com.jivesoftware.community.Ban
Sets a comment on this ban object.
setCommentAuthenticationStrategy(int) - Method in interface com.jivesoftware.community.Blog
Set the comment authentication strategy of this blog which may be any one of the following: Blog.COMMENT_AUTH_REQUIRED -- must register and login to comment Blog.COMMENT_AUTH_OPTIONAL_WITH_EMAIL -- must either register and login or provide an email address in the comment form.
setCommentModerationEnabled(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables comment moderation for this blog.
setCommentModerationEnabled(boolean) - Method in interface com.jivesoftware.community.ModerationManager
Sets whether comment moderation is enabled or not.
setCommentNotificationEnabled(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables comment notification for this blog.
setCommentsEnabled(boolean) - Method in interface com.jivesoftware.community.BlogManager
Enables or disables the comments feature system wide.
setCommentsEnabled(boolean) - Method in interface com.jivesoftware.community.DocumentManager
Enables or disables the comments feature system wide.
setCommentsIncludedInSearch(boolean) - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Sets whether to include comments in the search or not.
setCommentsIncludedInSearch(boolean) - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Sets whether to include comments in the search or not.
setCommentStatus(int) - Method in interface com.jivesoftware.community.BlogPost
Sets the comment status of this blog post which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now
setCommentStatus(int) - Method in interface com.jivesoftware.community.Document
Sets the comment status of this document which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now
setCommentStatus(int) - Method in interface com.jivesoftware.community.Poll
Sets the comment status of this poll which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now
setCommunity(Community) - Method in class com.jivesoftware.community.ProfileSearchQuery
Sets the community the user wants to find an expert in.
setCommunityBlog(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables the community aspects of this blog.
setCommunityID(long) - Method in class com.jivesoftware.community.CommentResultFilter
Sets the communityID to use to restrict results to be selected by the result filter.
setCommunityID(long) - Method in exception com.jivesoftware.community.CommunityNotFoundException
Sets the id of the community that was not found.
setCommunityIndex(Community, int) - Method in interface com.jivesoftware.community.Community
Sets the display order of a sub-community.
setConfigName(String) - Static method in class com.jivesoftware.community.JiveGlobals
Allows the name of the local config file name to be changed.
setContentTypes(ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.Community
Sets an array of ContentRetrieval.ContentTypes that are enabled for this community;
setContext(Map<String, Object>) - Method in class com.jivesoftware.community.EmailMessage
Sets the context map.
setContextParameter(String, Object) - Method in interface com.jivesoftware.community.renderer.RenderContext
Set a context parameter.
setCorrectAnswer(ForumMessage) - Method in interface com.jivesoftware.community.Question
Sets the specified message as the correct answer.
setCreated(Date) - Method in class com.jivesoftware.community.event.DocumentEvent
 
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 class com.jivesoftware.community.Ban
Sets the date this ban object was created.
setCreationDate(Date) - Method in interface com.jivesoftware.community.Blog
Sets the creation date of this blog.
setCreationDate(Date) - Method in interface com.jivesoftware.community.BlogPost
Sets the creation date of this post.
setCreationDate(Date) - Method in interface com.jivesoftware.community.Comment
Sets the creation date of the comment.
setCreationDate(Date) - Method in interface com.jivesoftware.community.Community
Sets the creation date of the community.
setCreationDate(Date) - Method in interface com.jivesoftware.community.ContentTag
Sets the creation date of this tag.
setCreationDate(Date) - Method in interface com.jivesoftware.community.Document
Sets the date the document was created.
setCreationDate(Date) - Method in interface com.jivesoftware.community.DocumentVersion
Sets the creation date of the document version.
setCreationDate(Date) - Method in interface com.jivesoftware.community.ForumMessage
Sets the creation date of this message.
setCreationDate(Date) - Method in interface com.jivesoftware.community.ForumThread
Sets the creation date of this thread.
setCreationDate(Date) - Method in interface com.jivesoftware.community.Trackback
Sets the creation date of this trackback.
setCreationDateRangeMax(Date) - Method in class com.jivesoftware.community.BanFilter
Sets a date that represents the upper boundry for bans to be selected by the ban filter.
setCreationDateRangeMax(Date) - Method in class com.jivesoftware.community.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.community.ResultFilter
Sets the date that represents the upper boundry for creation dates that will pass the result filter If this value is not set the result filter will be unbounded for the latest creation date selected.
setCreationDateRangeMin(Date) - Method in class com.jivesoftware.community.BanFilter
Sets the date that represents the lower boundary for bans to be selected by the ban filter.
setCreationDateRangeMin(Date) - Method in class com.jivesoftware.community.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.community.ResultFilter
Sets the date that represents the lower boundry for creation dates that will pass the result filter.
setCustomTitle(String) - Method in class com.jivesoftware.community.widget.BaseWidget
 
setCustomTitle(String) - Method in interface com.jivesoftware.community.widget.Widget
Sets a custom title that will override the default title when the widget is rendered.
setDatabaseModeEnabled(boolean) - Method in interface com.jivesoftware.community.StorageManager
Enables or disables storage of binary object data in the database.
setDataType(DocumentFieldType.DataType) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the XMPP data form type for this document field type.
setDebugEnabled(boolean) - Static method in class com.jivesoftware.base.Log
 
setDefault(boolean) - Method in interface com.jivesoftware.community.DocumentFieldOption
Set whether or not this option is a default option
setDefaultOption(boolean) - Method in class com.jivesoftware.community.ProfileFieldOption
Sets whether or not this option is to be selected by default.
setDefaultValue(String) - Method in interface com.jivesoftware.community.DocumentField
Sets the default value for the document field.
setDeleteDays(int) - Method in interface com.jivesoftware.community.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.community.Blog
Sets the description of the blog, max length of 255 characters.
setDescription(String) - Method in interface com.jivesoftware.community.Community
Sets the description of the community.
setDescription(String) - Method in interface com.jivesoftware.community.DocumentField
Sets the description of the document field.
setDescription(String) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the description for this document field type
setDescription(String) - Method in interface com.jivesoftware.community.DocumentType
Set the description of the document type.
setDescription(String) - Method in interface com.jivesoftware.community.Poll
Sets the description of the poll.
setDescription(String) - Method in class com.jivesoftware.community.ProfileField
Sets the description of this profile field.
setDescription(String) - Method in interface com.jivesoftware.community.StatusLevel
Sets the description of this status level
setDescription(String) - Method in interface com.jivesoftware.community.TagSet
Sets the description of this TagSet.
setDisplayName(String) - Method in interface com.jivesoftware.community.Blog
Sets the display name of the blog that is used as the URI.
setDisplayName(String) - Method in interface com.jivesoftware.community.Community
Sets the display name of the community that is used as the URI.
setDisplayName(String) - Method in interface com.jivesoftware.community.DocumentField
Sets the display name for this field.
setDisplayName(String) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the display friend name for this document field type.
setDocument(Document) - Method in class com.jivesoftware.community.ProfileSearchResult
Sets the search Document for this user.
setDocumentDeleted(boolean) - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
setDocumentElementIndex(DocumentTypeElement, int) - Method in interface com.jivesoftware.community.DocumentType
Sets the index where the specified DocumentTypeElement should appear
setDocumentElementIndex(DocumentTypeElement, int) - Method in interface com.jivesoftware.community.DocumentTypeSectionElement
Sets the index where the specified DocumentTypeElement should appear
setDocumentFieldMode(int) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets the mode that will be used to select results if multiple document field values have been specified.
setDocumentFieldValue(DocumentField, DocumentFieldValue) - Method in interface com.jivesoftware.community.Document
Sets the value of the document field.
setDocumentID(String) - Method in interface com.jivesoftware.community.Document
Sets the document ID corresponding to the document.
setDocumentPresenter(DocumentPresenter) - Method in interface com.jivesoftware.community.DocumentType
Sets the document presenter associated with the given name within the document type.
setDocumentState(DocumentState) - Method in interface com.jivesoftware.community.Document
Sets the state of the document.
setDocumentState(DocumentState) - Method in interface com.jivesoftware.community.DocumentVersion
Sets the document state for the version.
setDocumentTypeIndex(DocumentType, int) - Method in interface com.jivesoftware.community.DocumentTypeManager
Sets the index of the document type.
setEditable(boolean) - Method in class com.jivesoftware.community.ProfileField
Sets whether or not this profile field is editable by the user.
setEditAutoExpireTimeout(int) - Method in interface com.jivesoftware.community.DocumentManager
Sets the number of minutes that a document will be marked as being editted without any updates before the document will be remarked as not being editted.
setEmail(String) - Method in interface com.jivesoftware.base.User
Sets the user's email address.
setEmail(String) - Method in interface com.jivesoftware.community.Comment
Set the email address of the person who authored this comment.
setEmail(String) - Method in interface com.jivesoftware.spi.user.User
Set user's email address
setEmail(String) - Method in class com.jivesoftware.spi.user.UserTemplate
 
setEmailAlertEnabled(boolean) - Method in interface com.jivesoftware.community.ModerationManager
Enables or disables moderation email alerts.
setEmailNotifyEnabled(boolean) - Method in interface com.jivesoftware.community.BanManager
Sets the list of email addresses to notify when an attachment is blocked
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.community.ProfileSearchManager
Determines whether or not user email addresses are visible when performing a user search.
setEnabled(boolean) - Method in interface com.jivesoftware.base.User
If this field is set to false the user is disabled, meaning they cannot log in.
setEnabled(boolean) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
setEnabled(boolean) - Method in interface com.jivesoftware.community.renderer.RenderFilter
Sets whether the filter is enabled or disabled.
setEnabled(boolean) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Set whether or not this engine will appear in the view.
setEndDate(Date) - Method in interface com.jivesoftware.community.Announcement
Sets the date when the announcement should not longer be visible.
setEndDate(Date) - Method in interface com.jivesoftware.community.Poll
Sets the date the poll should end.
setExcerpt(String) - Method in interface com.jivesoftware.community.Trackback
Set the excerpt of the trackback.
setExcludeOwnerInUserFilter(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether the document owner should be excluded when filtering by user id.
setExpirable(boolean) - Method in interface com.jivesoftware.community.Watch
Sets whether this watch is expirable or not.
setExpirationDate(Date) - Method in class com.jivesoftware.community.Ban
Sets the date this ban object will expire, or null if it is a permanent ban object.
setExpirationDate(Date) - Method in interface com.jivesoftware.community.Document
Sets the date the document should expire on.
setExpirationDate(Date) - Method in interface com.jivesoftware.community.Poll
Sets the date the poll should expire.
setExpirationDateRangeMax(Date) - Method in class com.jivesoftware.community.BanFilter
Sets a date that represents the upper boundry for bans to be selected by the ban filter.
setExpirationDateRangeMax(Date) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets a date that represents the upper boundry for documents to be selected by the result filter.
setExpirationDateRangeMin(Date) - Method in class com.jivesoftware.community.BanFilter
Sets the date that represents the lower boundary for bans to be selected by the ban filter.
setExpirationDateRangeMin(Date) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets a date that represents the lower boundry for documents to be selected by the result filter.
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.community.event.ProfileEvent
Sets the exception that indicates why a listener failed to handle an event.
setFeedEnabled(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables feeds for this blog.
setFeedFullContent(boolean) - Method in interface com.jivesoftware.community.Blog
Enables or disables the publishing of the full blog post in feeds.
setFieldID(long) - Method in class com.jivesoftware.community.ProfileFieldOption
Sets the id of the ProfileField in which this option belongs.
setFieldID(long) - Method in class com.jivesoftware.community.ProfileSearchFilter
Sets the ID of the ProfileField used to filter the user results.
setFieldType(DocumentFieldType) - Method in interface com.jivesoftware.community.DocumentField
Associates a DocumentFieldType with this DocumentField.
setFileSystemCacheEnabled(boolean) - Method in interface com.jivesoftware.community.StorageManager
Enables or disables storage of cached binary object data on the file system when in database mode.
setFilterable(boolean) - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Sets the filterability of the associated document field.
setFilterable(boolean) - Method in class com.jivesoftware.community.ProfileField
Sets whether or not this profile field is filterable.
setFilterOnDocumentType(DocumentType) - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Restricts the query results to documents having the specified document type.
setFilterOnTagSets(Collection<TagSet>) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Restricts the query results to content objects containing any one of the specified TagSets.
setFilterOnThread(ForumThread) - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Restricts the query results to messages posted in a specific thread.
setFilters(List<ProfileSearchFilter>) - Method in class com.jivesoftware.community.ProfileSearchQuery
Sets a list of ProfileSearchFilters used to filter user results for this query.
setForceThumbnailsEnabled(boolean) - Method in interface com.jivesoftware.community.ImageManager
Sets the forcing of thumbnails for any images over a maximum image width/height.
setFormatter(DocumentFieldFormatter) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the formatter for this document field type.
setGroup(Group) - Method in interface com.jivesoftware.community.StatusLevel
The group this status level is associated with.
setGroupByCommunity(boolean) - Method in class com.jivesoftware.community.QuestionFilter
Sets whether to group results by community.
setGuestProperty(String, String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Sets a guest cookie.
setHelpfulAnswersPerThread(int) - Method in interface com.jivesoftware.community.QuestionManager
Sets the number of helpful answers allowed per question.
setHtmlBody(String) - Method in class com.jivesoftware.community.EmailMessage
Sets the text version of the body.
setHtmlBodyProperty(String) - Method in class com.jivesoftware.community.EmailMessage
 
setHttpBindEnabled(boolean) - Method in class com.jivesoftware.community.xmpp.IMManager
 
setHttpBindSecureUrl(String) - Method in class com.jivesoftware.community.xmpp.IMManager
 
setHttpBindUnsecureUrl(String) - Method in class com.jivesoftware.community.xmpp.IMManager
 
setHumanValidationEnabled(boolean) - Method in interface com.jivesoftware.community.RegistrationManager
Enables or disables the human input validation feature.
setID(long) - Method in class com.jivesoftware.community.AbuseReport
Sets the unique ID of this abuse report.
setId(long) - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
 
setID(long) - Method in class com.jivesoftware.community.ProfileField
Sets the id representing this profile field.
setID(long) - Method in class com.jivesoftware.community.widget.BaseWidget
 
setID(long) - Method in interface com.jivesoftware.community.widget.Widget
Sets the internal id of the widget
setId(String) - Method in interface com.jivesoftware.spi.user.User
Sets the user's unique id.
setId(String) - Method in class com.jivesoftware.spi.user.UserTemplate
 
setImageMaxHeight(int) - Method in interface com.jivesoftware.community.ImageManager
Sets the max height of images that will be displayed.
setImageMaxWidth(int) - Method in interface com.jivesoftware.community.ImageManager
Sets the max width of images that will be displayed.
setImagePath(String) - Method in interface com.jivesoftware.community.StatusLevel
Sets the path of the image used for this status level.
setImagePreviewEnabled(boolean) - Method in interface com.jivesoftware.community.AttachmentManager
Toggles whether image preview support is enabled.
setImagePreviewMaxSize(int) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
setImagePreviewMaxSize(int) - Method in interface com.jivesoftware.community.ImageManager
Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
setImagePreviewRatioEnabled(boolean) - Method in interface com.jivesoftware.community.AttachmentManager
Toggles whether the aspect ratio of thumbnails should be preserved.
setImages(List<Image>) - Method in interface com.jivesoftware.community.Draft
Sets a list of images for the draft.
setImagesEnabled(boolean) - Method in interface com.jivesoftware.community.ImageManager
Set to true if images should be enabled, false otherwise.
setIncludeAuthorsInUserFilter(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether users who have been added as authors to a document should be included when filtering by user.
setIncludeModerated(boolean) - Method in class com.jivesoftware.community.CommentResultFilter
Sets whether the result to be selected by the result filter should include moderated comments.
setIncludeModerated(boolean) - Method in class com.jivesoftware.community.FeedbackResultFilter
Sets whether the result to be selected by the result filter should include moderated comments.
setIncludeNonRecommendedDocuments(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether the result to be selected by the result filter should include documents with a recommended attribute set to false.
setIncludeRecommendedDocuments(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether the result to be selected by the result filter should include documents with a recommended attribute set to true.
setIncludeReviewersInUserFilter(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether users who have been added as reviewers to a document should be included when filtering by user.
setIncludeUnSearchableDocuments(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets whether the result to be selected by the result filter should include documents with a searchable attribute set to false.
setIndex(long) - Method in interface com.jivesoftware.community.JiveIterator
Sets the index for the iteration to the specified object ID.
setIndex(int) - Method in class com.jivesoftware.community.ProfileField
Sets the index of this profile field.
setIndex(ProfileField, int) - Method in interface com.jivesoftware.community.ProfileFieldManager
Sets the index of the profile field.
setIndex(int) - Method in class com.jivesoftware.community.ProfileFieldOption
Sets the index of this option which represents the order in which the options will appear in the list.
setIpAddress(String) - Method in class com.jivesoftware.community.Ban
Sets the IP address to ban.
setIpAddress(String) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected IP address that bans will be filtered on.
setIPAddress(String) - Method in interface com.jivesoftware.community.Comment
Set the IP address of the person who authored this comment.
setIPAddress(String) - Method in interface com.jivesoftware.community.Trackback
Set the IP address of the person who authored this trackback.
setJavaScriptUrls(Collection<String>) - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
setJIDNodeForUser(User, String) - Method in class com.jivesoftware.community.xmpp.IMManager
 
setJiveContext(JiveContext) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setJiveHome(String) - Static method in class com.jivesoftware.community.JiveGlobals
Sets the location of the jiveHome directory.
setJiveProperties(Map<String, String>) - Static method in class com.jivesoftware.community.JiveGlobals
Sets multiple Jive properties at once.
setJiveProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
Sets a Jive property.
setKeywords(String) - Method in class com.jivesoftware.community.ProfileSearchQuery
Sets the keywords for the user search.
setLanguage(String) - Method in interface com.jivesoftware.community.Document
Sets the language of the document.
setLanguages(Collection<String>) - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Sets the languages to restrict query results to.
setLargeImagePath(String) - Method in interface com.jivesoftware.community.StatusLevel
 
setLastLoggedIn(Date) - Method in interface com.jivesoftware.base.User
Sets the date the user last logged in.
setLastUpdateTime(Date) - Method in interface com.jivesoftware.community.Presence
Set the time when the presence was last updated (when the user last visited).
setLastUpdateTime(long) - Method in interface com.jivesoftware.community.Presence
Sets the time when the presence was last updated (when the user last visited).
setLocale(Locale) - Method in interface com.jivesoftware.community.Community
Sets the locale for this community.
setLocale(Locale) - Method in class com.jivesoftware.community.EmailMessage
Set the locale for the email message.
setLocale(Locale) - Static method in class com.jivesoftware.community.JiveGlobals
Sets the global locale used by Jive.
setLocalizedJiveProperty(String, String, Locale) - Static method in class com.jivesoftware.community.JiveGlobals
Sets a localized Jive property.
setLocalProperties(Map<String, String>) - Static method in class com.jivesoftware.community.JiveGlobals
Sets multiple local properties at once.
setLocalProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
Sets a local property.
setMaxAllowableHeight(int) - Method in interface com.jivesoftware.community.AvatarManager
Sets the maximum allowable height for an avatar image
setMaxAllowableWidth(int) - Method in interface com.jivesoftware.community.AvatarManager
Sets the maximum allowable width for an avatar image
setMaxAttachmentSize(int) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the maximum size of an individual attachment in kilobytes.
setMaxAttachmentsPerBlogPost(int) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the maximum number of attachments per blog post.
setMaxAttachmentsPerDocument(int) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the maximum number of attachments per document.
setMaxAttachmentsPerMessage(int) - Method in interface com.jivesoftware.community.AttachmentManager
Sets the maximum number of attachments per message.
setMaxBodySize(int) - Method in interface com.jivesoftware.community.BinaryBodyManager
Sets the maximum size of an individual binary document body in kilobytes.
setMaxCacheSize(int) - Method in class com.jivesoftware.community.cache.DefaultCache
 
setMaxFieldSize(int) - Method in interface com.jivesoftware.community.DocumentField
sets the maximum data size for the field.
setMaxFileSystemCacheSize(long) - Method in interface com.jivesoftware.community.StorageManager
Sets the maximum amount of storage (in bytes) that will be used by the file system cache when database binary object mode is enabled.
setMaxImageSize(int) - Method in interface com.jivesoftware.community.ImageManager
Sets the maximum size of an individual image in kilobytes.
setMaxImagesPerObject(int) - Method in interface com.jivesoftware.community.ImageManager
Sets the maximum number of images per document.
setMaxLifetime(long) - Method in class com.jivesoftware.community.cache.DefaultCache
 
setMaxMessagesPerUser(int) - Method in interface com.jivesoftware.community.PrivateMessageManager
Sets the max number of message is allowed to store in their mailbox.
setMaxResultCount(int) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
The maximum number of results you want returned from #performSearch.
setMaxUserAvatars(int) - Method in interface com.jivesoftware.community.AvatarManager
Sets the maximum number of avatars a user can have
setMaxValue(String) - Method in class com.jivesoftware.community.ProfileSearchFilter
Sets the maximum value that will be used to filter the user results.
setMessage(ForumMessage) - Method in class com.jivesoftware.community.AbuseReport
Sets the forum message that caused this abuse report.
setMinimum(int) - Method in class com.jivesoftware.community.TagResultFilter
Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
setMinorEdit(boolean) - Method in interface com.jivesoftware.community.Document
Set to true to cause the next call to Document.save() to result in a minor document version.
setMinorRevision(boolean) - Method in class com.jivesoftware.community.event.DocumentEvent
 
setMinValue(String) - Method in class com.jivesoftware.community.ProfileSearchFilter
Sets the minimum value that will be used to filter the user results.
setMode(long, boolean) - Method in interface com.jivesoftware.community.Poll
Sets a mode to be enabled or disabled for the poll.
setModerated(boolean) - Method in interface com.jivesoftware.community.Comment
Sets whether the comment is moderated or not.
setModerated(boolean) - Method in interface com.jivesoftware.community.Trackback
Sets whether the trackbacks is moderated or not.
setModerateUserAvatars(boolean) - Method in interface com.jivesoftware.community.AvatarManager
Sets whether or not user avatars will be moderated.
setModerationDefaultMessageValue(int) - Method in interface com.jivesoftware.community.Community
Sets the default number of moderation points for threads created in the community.
setModerationDefaultThreadValue(int) - Method in interface com.jivesoftware.community.Community
Sets the default number of moderation points for threads created in the community.
setModerationRangeMax(int) - Method in class com.jivesoftware.community.ModerationFilter
 
setModerationRangeMax(int) - Method in class com.jivesoftware.community.ThreadResultFilter
Sets the upper bound for the moderation value that will pass the result filter.
setModerationRangeMin(int) - Method in class com.jivesoftware.community.ModerationFilter
 
setModerationRangeMin(int) - Method in class com.jivesoftware.community.ThreadResultFilter
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.community.ForumMessage
Sets the number of moderation points this message has.
setModerationValue(int, AuthToken) - Method in interface com.jivesoftware.community.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.community.Blog
Sets the date this blog was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.BlogPost
Sets the date this post was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.Comment
Sets the date the comment was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.Community
Sets the date the community was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.Document
Sets the date the document was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.DocumentVersion
Sets the date the document was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.Draft
Sets the draft modification date.
setModificationDate(Date) - Method in interface com.jivesoftware.community.ForumMessage
Sets the date this message was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.ForumThread
Sets the date this thread was last modified.
setModificationDate(Date) - Method in interface com.jivesoftware.community.Trackback
Sets the date this trackback was last modified.
setModificationDateRangeMax(Date) - Method in class com.jivesoftware.community.ResultFilter
Sets the date that represents the upper boundry for modification dates that will pass the result filter.
setModificationDateRangeMin(Date) - Method in class com.jivesoftware.community.ResultFilter
Sets the date that represents the lower boundry for modification dates that will pass the result filter.
setModValue(int) - Method in interface com.jivesoftware.community.Avatar
Modifies the moderation value of this specific avatar
setModValueList(List<Integer>) - Method in class com.jivesoftware.community.ModerationFilter
Sets a list of moderation values that will be used to filter results.
setName(String) - Method in interface com.jivesoftware.base.Group
Sets the name of the group.
setName(String) - Method in interface com.jivesoftware.base.User
Sets the user's name.
setName(String) - Method in interface com.jivesoftware.community.Attachment
Sets the name of the attachment.
setName(String) - Method in interface com.jivesoftware.community.BinaryBody
Sets the name of the body object.
setName(String) - Method in interface com.jivesoftware.community.Blog
Sets the name of a blog.
setName(String) - Method in class com.jivesoftware.community.cache.DefaultCache
 
setName(String) - Method in interface com.jivesoftware.community.Comment
Set the name of the person who authored this comment.
setName(String) - Method in interface com.jivesoftware.community.Community
Sets the name of the community.
setName(String) - Method in interface com.jivesoftware.community.DocumentField
Sets the unique name of the document field.
setName(String) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the unique name of this document field type.
setName(String) - Method in interface com.jivesoftware.community.DocumentPresenter
Sets the identifying name of the document presenter.
setName(String) - Method in interface com.jivesoftware.community.DocumentType
Set the name of the document type
setName(String) - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
 
setName(String) - Method in interface com.jivesoftware.community.Image
Sets the name of the image.
setName(String) - Method in interface com.jivesoftware.community.Poll
Sets the name of the poll.
setName(String) - Method in interface com.jivesoftware.community.PrivateMessageFolder
Sets the name of the folder.
setName(String) - Method in class com.jivesoftware.community.ProfileField
 
setName(String) - Method in interface com.jivesoftware.community.StatusLevel
Sets the name of this status level
setName(String) - Method in interface com.jivesoftware.community.TagSet
Sets the name of this TagSet.
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.community.Community
Sets the NNTP name for the community, which is the name of the community used in the NNTP protocol (newsgroups).
setNumResults(int) - Method in class com.jivesoftware.community.QuestionFilter
Sets the limit on the number of results to be returned.
setNumResults(int) - Method in class com.jivesoftware.community.ResultFilter
Sets the limit on the number of results to be returned.
setOffline(Presence) - Method in interface com.jivesoftware.community.PresenceManager
Sets a presence to be offline which causes the presence to be removed from the system.
setOnlyDraft(boolean) - Method in class com.jivesoftware.community.BlogPostResultFilter
Sets whether the result to be selected by the result filter should include published blog posts.
setOnlyIncludeCollaborativeDocuments(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
Set to true to only include collaborative documents (documents having textual bodies instead of binary bodies) in the list of document to filter upon.
setOnlyPublished(boolean) - Method in class com.jivesoftware.community.BlogPostResultFilter
Sets whether the result to be selected by the result filter should include published blog posts.
setOpen() - Method in interface com.jivesoftware.community.Question
Sets the state to Question.State.open
setOption(int, String) - Method in interface com.jivesoftware.community.Poll
Sets the text of the option at the specified index.
setOptionIDs(LongList) - Method in class com.jivesoftware.community.DocumentFieldValue
 
setOptionIDs(LongList) - Method in class com.jivesoftware.community.ProfileFieldValue
Sets a list of selected optionIDs.
setOptionIndex(int, DocumentFieldOption) - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Sets a particular option at the given index.
setOptionIndex(int, int) - Method in interface com.jivesoftware.community.Poll
Moves the option's index.
setOptions(List<ProfileFieldOption>) - Method in class com.jivesoftware.community.ProfileField
Sets a list of ProfileFieldOption objects for this profile field.
setOverridePing(boolean) - Method in interface com.jivesoftware.community.Blog
Enables or disables the blog to override the ping settings in the system.
setParameters(Map<String, String>) - Method in class com.jivesoftware.community.renderer.BaseMacro
 
setParameters(Map<String, String>) - Method in interface com.jivesoftware.community.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.
setPassword(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Set a password for authenticated search feeds.
setPassword(char[]) - Method in interface com.jivesoftware.spi.user.User
Set the password
setPassword(char[]) - Method in class com.jivesoftware.spi.user.UserTemplate
 
setPasswordHash(String) - Method in interface com.jivesoftware.base.User
Sets the user's password in hashed form.
setPasswordHash(String) - Method in interface com.jivesoftware.spi.user.User
Set the password hash
setPasswordHash(String) - Method in class com.jivesoftware.spi.user.UserTemplate
 
setPerformDistinctCount(boolean) - Method in class com.jivesoftware.community.ResultFilter
Sets the mode so that if a count query is performed it will use a distinct count operation.
setPingsEnabled(boolean) - Method in interface com.jivesoftware.community.BlogManager
Enables or disables the pings feature system wide.
setPingServices(String) - Method in interface com.jivesoftware.community.Blog
A line break separated list of services that the user has chosen to ping.
setPingServices(String) - Method in interface com.jivesoftware.community.BlogManager
Sets the comma delimited list of available ping services for the system.
setPingsOverrideEnabled(boolean) - Method in interface com.jivesoftware.community.BlogManager
Configures the system to allow users to override the ping URIs configured for all blogs.
setPointRange(int, int) - Method in interface com.jivesoftware.community.StatusLevel
Sets a point range for this status level, if this status level was group based before it will now be point based.
setPoints(int) - Method in class com.jivesoftware.community.ProfileSearchResult
Sets the StatusLevel points for this user.
setPossiblyResolved() - Method in interface com.jivesoftware.community.Question
Sets the state to Question.State.possibly_resolved
setPresencesEnabled(boolean) - Method in interface com.jivesoftware.community.PresenceManager
Sets whether presences are enabled on a global basis or not.
setPrivateMessageNotificationEnabled(boolean) - Method in interface com.jivesoftware.community.PrivateMessageManager
Enables or disables the private message notification feature.
setPrivateMessagesEnabled(boolean) - Method in interface com.jivesoftware.community.PrivateMessageManager
Enables or disables the private message feature.
setProfile(User, List<UserProfile>) - Method in interface com.jivesoftware.community.ProfileManager
Sets a list of profile values for a particular user.
setProfileImage(User, String, InputStream) - Method in interface com.jivesoftware.community.ProfileManager
Set a new profile page image for the specified user.
setProperties(Map<String, String>) - Method in interface com.jivesoftware.community.Draft
Sets the properties associated with this draft.
setPropertyMode(int) - Method in class com.jivesoftware.community.ResultFilter
Sets the mode that will be used to select results if multiple properties have been specified.
setPublishDate(Date) - Method in interface com.jivesoftware.community.BlogPost
Sets the publish date of this post.
setPublishDateRangeMax(Date) - Method in class com.jivesoftware.community.BlogPostResultFilter
Sets a date that represents the upper boundry for blog posts to be selected by the result filter.
setPublishDateRangeMax(Date) - Method in class com.jivesoftware.community.BlogTagResultFilter
Sets a date that represents the upper boundry for tags to be selected by the result filter.
setPublishDateRangeMin(Date) - Method in class com.jivesoftware.community.BlogPostResultFilter
Sets the date that represents the lower boundary for blog posts to be selected by the result filter.
setPublishDateRangeMin(Date) - Method in class com.jivesoftware.community.BlogTagResultFilter
Sets the date that represents the lower boundary for blog posts to be selected by the result filter.
setQueryTestTerm(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Set the test term that is used for performing the test query.
setRatingsEnabled(boolean) - Method in interface com.jivesoftware.community.RatingManager
Enables or disables the ratings feature.
setRead(boolean) - Method in interface com.jivesoftware.community.PrivateMessage
Marks this message as read or unread.
setReadTrackingEnabled(boolean) - Method in interface com.jivesoftware.community.ReadTracker
Enables or disables the read tracking feature.
setRecommended(boolean) - Method in interface com.jivesoftware.community.DocumentAttributes
 
setRecursive(boolean) - Method in class com.jivesoftware.community.ResultFilter
Sets the recursive value of queries.
setRelativeJavascriptUrl(String) - Method in class com.jivesoftware.community.xmpp.IMManager
 
setRelevance(float) - Method in class com.jivesoftware.community.ProfileSearchResult
Sets the search relevance for this user, a floating point number between 0.0 and 1.0.
setRenderPipe(RenderPipe) - Method in interface com.jivesoftware.community.renderer.RenderContext
Sets the render pipe that will be used for rendering.
setRenderStrategy(RenderStrategy) - Method in interface com.jivesoftware.community.renderer.RenderContext
Sets the render strategy that will be used for rendering.
setReportAbuseEnabled(boolean) - Method in interface com.jivesoftware.community.AbuseManager
Enables or disables the report abuse feature.
setReportDate(Date) - Method in class com.jivesoftware.community.AbuseReport
Sets the date that this abuse report was created.
setRequired(boolean) - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Sets whether the associated document field is required or not.
setRequired(boolean) - Method in class com.jivesoftware.community.ProfileField
Sets whether or not this profile field is a required field.
setResolutionDateRangeMax(Date) - Method in class com.jivesoftware.community.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.community.ThreadResultFilter
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.community.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.community.ThreadResultFilter
Sets a date that represents the lower boundary for messages or threads to be selected by the result filter.
setResolved() - Method in interface com.jivesoftware.community.Question
Sets the state to Question.State.resolved
setRestrictToLatestVersion(boolean) - Method in class com.jivesoftware.community.DocumentResultFilter
By default, all versions of a document will be tested when filtering on document state.
setSearchable(boolean) - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Sets whether the associated document field can be searched.
setSearchable(boolean) - Method in class com.jivesoftware.community.ProfileField
Sets whether or not this profile field is searchable.
setSearchEmail(boolean) - Method in class com.jivesoftware.community.ProfileSearchQuery
True if the user's email field is to be searched, false otherwise.
setSearchEnabled(boolean) - Method in interface com.jivesoftware.community.ProfileSearchManager
Enables or disables the profile search feature.
setSearchEnabled(boolean) - Method in interface com.jivesoftware.community.SearchManager
Enables or disables the search feature.
setSearchName(boolean) - Method in class com.jivesoftware.community.ProfileSearchQuery
True if the user's name field is to be searched, false otherwise.
setSearchProfile(boolean) - Method in class com.jivesoftware.community.ProfileSearchQuery
True if the user's profile field values are to be searched, false otherwise.
setSearchUsername(boolean) - Method in class com.jivesoftware.community.ProfileSearchQuery
True if the user's username field is to be searched, false otherwise.
setSender(String, String) - Method in class com.jivesoftware.community.EmailMessage
Sets the address the email is sent from.
setSender(EmailMessage.EmailAddress) - Method in class com.jivesoftware.community.EmailMessage
Sets the address the email is sent from.
setSenderName(String) - Method in interface com.jivesoftware.community.Trackback
Set the sender name of the trackback.
setServletRequest(HttpServletRequest) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setServletResponse(HttpServletResponse) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setSession(Map) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setSingleResultPerThread(boolean) - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Sets whether message search results are limited to a single result per thread or not.
setSort(Sort) - Method in class com.jivesoftware.community.ProfileSearchQuery
Sets the Sort used for this query.
setSortDocumentField(DocumentField) - Method in class com.jivesoftware.community.DocumentResultFilter
Sets the document field to sort on.
setSortField(int) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected sort field.
setSortField(QuestionFilter.SortField) - Method in class com.jivesoftware.community.QuestionFilter
Sets the sort field to use.
setSortField(int) - Method in class com.jivesoftware.community.ResultFilter
Sets the sort field to use.
setSortField(int) - Method in class com.jivesoftware.community.ThreadResultFilter
Sets the sort field to use.
setSortOrder(int) - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected sort order.
setSortOrder(int) - Method in class com.jivesoftware.community.QuestionFilter
Sets the sort type.
setSortOrder(int) - Method in class com.jivesoftware.community.ResultFilter
Sets the sort type.
setSortOrder(SearchQueryCriteria.SortOrder) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Sets the sort type.
setSortPropertyName(String) - Method in class com.jivesoftware.community.QuestionFilter
Sets the property name to sort on.
setSortPropertyName(String) - Method in class com.jivesoftware.community.ResultFilter
Sets the property name to sort on.
setSortType(BlogPostSearchQueryCriteria.BlogPostSortType) - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Sets the sort type to use to sort search results.
setSortType(DocumentSearchQueryCriteria.DocumentSortType) - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Sets the sort type to use to sort search results.
setSortType(MessageSearchQueryCriteria.MessageSortType) - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Sets the sort type to use to sort search results.
setSortType(SearchQueryCriteria.SortType) - Method in interface com.jivesoftware.community.SearchQueryCriteria
Sets the sort type to use to sort search results.
setSpiProperties(String, Map<String, String>) - Static method in class com.jivesoftware.community.JiveGlobals
 
setSpiProperty(String, String, String) - Static method in class com.jivesoftware.community.JiveGlobals
 
setStartDate(Date) - Method in interface com.jivesoftware.community.Announcement
Sets the start date for when the announcement should first be visible.
setStartDate(Date) - Method in interface com.jivesoftware.community.Poll
Sets the date voting for the poll should start.
setStartIndex(int) - Method in class com.jivesoftware.community.QuestionFilter
Sets the index of the first result to return.
setStartIndex(int) - Method in class com.jivesoftware.community.ResultFilter
Sets the index of the first result to return.
setState(Question.State) - Method in interface com.jivesoftware.community.Question
Sets the resolution state of this question.
setStatus(int) - Method in interface com.jivesoftware.community.BlogPost
Sets the publishing status of this blog post which may be any one of the following: PENDING_APPROVAL -- post has status of unpublished PUBLISH -- post has status of published.
setStatus(int) - Method in interface com.jivesoftware.community.Presence
Sets the status of the user.
setStatusLevelsEnabled(boolean) - Method in interface com.jivesoftware.community.StatusLevelManager
Sets whether status levels should be enabled in the system.
setStringValue(String) - Method in class com.jivesoftware.community.DocumentFieldValue
 
setStringValue(String) - Method in class com.jivesoftware.community.ProfileFieldValue
Sets the value for this field.
setSubject(String) - Method in interface com.jivesoftware.community.Announcement
Sets the announcement subject.
setSubject(String) - Method in interface com.jivesoftware.community.BlogPost
Sets the subject of this blog post.
setSubject(String) - Method in interface com.jivesoftware.community.Document
Sets the subject of the document.
setSubject(String) - Method in interface com.jivesoftware.community.Draft
Set the subject of the draft.
setSubject(String) - Method in class com.jivesoftware.community.EmailMessage
Sets the subject of the email.
setSubject(String) - Method in interface com.jivesoftware.community.ForumMessage
Sets the subject of this message.
setSubject(String) - Method in interface com.jivesoftware.community.PrivateMessage
Sets the subject of the message.
setSubjectProperty(String) - Method in class com.jivesoftware.community.EmailMessage
Sets the email's subject property name
setSummary(String) - Method in interface com.jivesoftware.community.Document
Sets the summary of the document.
setTags(Collection<ContentTag>) - Method in class com.jivesoftware.community.ResultFilter
Sets the ContentTags to filter on.
setTags(Collection<ContentTag>) - Method in interface com.jivesoftware.community.TagSet
Sets all the tags associated with this TagSet.
setTagsFromTagNames(Collection<String>) - Method in interface com.jivesoftware.community.TagSet
Sets all the tags associated with this TagSet using the supplied tag names.
setTarget(RenderTarget) - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
setTemplate(String) - Method in interface com.jivesoftware.community.DocumentPresenter
Sets the template for this presenter.
setTermsEnabled(boolean) - Method in interface com.jivesoftware.community.RegistrationManager
Sets terms and conditions to be enabled / disabled
setTermsURL(String) - Method in interface com.jivesoftware.community.RegistrationManager
Sets the string url representing the terms and conditions page
setTestContext(JiveContext) - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
For testing purposes only.
setTextBody(String) - Method in class com.jivesoftware.community.EmailMessage
Sets the text version of the body.
setTextBodyProperty(String) - Method in class com.jivesoftware.community.EmailMessage
Set the property name for the html version of the email body
setTimeZone(TimeZone) - Static method in class com.jivesoftware.community.JiveGlobals
Sets the global time zone used by Jive.
setTitle(String) - Method in interface com.jivesoftware.community.Trackback
Set the title of the trackback.
setTrackbackModerationEnabled(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables trackback moderation for this blog.
setTrackbackNotificationEnabled(boolean) - Method in interface com.jivesoftware.community.Blog
Enables and disables trackback notification for this blog.
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.BlogManager
Enables or disables the trackbacks feature system wide.
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.BlogPost
Enables and disables trackbacks for this blog post.
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.Document
Enables and disables trackbacks for this blog post.
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.DocumentManager
Enables or disables the trackbacks feature system wide.
setTypeID(int) - Method in class com.jivesoftware.community.ProfileField
Sets the id of the ProfileField.Type of this profile field.
setupProperties - Static variable in class com.jivesoftware.community.JiveGlobals
Local Jive properties (from jive_startup.xml).
setURL(String) - Method in interface com.jivesoftware.community.Comment
Set the URL / homepage of the person who authored this comment.
setURL(String) - Method in interface com.jivesoftware.community.Trackback
Set the URL of the trackback.
setUser(User) - Method in class com.jivesoftware.community.AbuseReport
Sets the user that created this abuse report.
setUser(User) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
setUser(User) - Method in interface com.jivesoftware.community.Document
Returns the user that authored the document.
setUser(User) - Method in class com.jivesoftware.community.ProfileSearchResult
Set the user that this search result represents.
setUserAvatarsEnabled(boolean) - Method in interface com.jivesoftware.community.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.community.QuestionFilter
Sets the creator of questions that results will be filtered on.
setUserID(long) - Method in class com.jivesoftware.community.ResultFilter
Sets the userID that results will be filtered on.
setUsername(String) - Method in interface com.jivesoftware.base.User
Sets the user's name.
setUsername(String) - Method in exception com.jivesoftware.base.UserNotFoundException
 
setUsername(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Set a username for authenticated search feeds.
setUsername(String) - Method in interface com.jivesoftware.spi.user.User
Sets the username.
setUsername(String) - Method in class com.jivesoftware.spi.user.UserTemplate
 
setValidationEnabled(boolean) - Method in interface com.jivesoftware.community.RegistrationManager
Enables or disables the validation feature.
setValidator(DocumentFieldValidator) - Method in interface com.jivesoftware.community.DocumentFieldType
Sets the validator for the document field type.
setValidator(DocumentTypeValidator) - Method in interface com.jivesoftware.community.DocumentType
Sets the validator for the document type.
setValue(String) - Method in interface com.jivesoftware.community.DocumentFieldOption
Sets the value of the option.
setValue(String) - Method in class com.jivesoftware.community.ProfileFieldOption
Sets the value of this option.
setValue(String) - Method in class com.jivesoftware.community.ProfileSearchFilter
Sets the value that will be used to filter the user results.
setVisible(boolean) - Method in interface com.jivesoftware.community.DocumentFieldAttributes
Sets the visibility of the associated document field.
setVisible(boolean) - Method in class com.jivesoftware.community.ProfileField
Sets whether or not this profile field is visible by the public.
setWatchType(int) - Method in interface com.jivesoftware.community.Watch
Sets the watch type.
setWelcomeEnabled(boolean) - Method in interface com.jivesoftware.community.RegistrationManager
Sets welcome email to be enabled / disabled
setWildcardIgnored(boolean) - Method in interface com.jivesoftware.community.SearchManager
Turns on or off wildcarding.
SingleTagMacro - Annotation Type in com.jivesoftware.community.renderer.annotations
This annotation can change whether a macro is handled a single or multi tagged macro.
size() - Method in class com.jivesoftware.community.cache.DefaultCache
 
skipElement() - Method in interface com.jivesoftware.community.JiveIterator
Skip over an element in the iteration.
SLANDER - Static variable in class com.jivesoftware.community.AbuseType
Type representing a slander abuse report.
smallLogoExists - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
SORT_ACTIVITY - Static variable in interface com.jivesoftware.community.Blog
 
SORT_BLOGID - Static variable in interface com.jivesoftware.community.Blog
 
SORT_DATE - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
SORT_DISPLAYNAME - Static variable in interface com.jivesoftware.community.Blog
 
SORT_NAME - Static variable in interface com.jivesoftware.community.Blog
 
SORT_ONLINE_TIME - Static variable in interface com.jivesoftware.community.PresenceManager
Sort by online time.
SORT_SENDER - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
SORT_SUBJECT - Static variable in interface com.jivesoftware.community.PrivateMessageFolder
 
SORT_TAGCOUNT - Static variable in interface com.jivesoftware.community.ContentTag
Sort field: sort by tag count.
SORT_TAGNAME - Static variable in interface com.jivesoftware.community.ContentTag
Sort field: sort by tag name.
SORT_USERNAME - Static variable in interface com.jivesoftware.community.PresenceManager
Sort by username.
SPAM - Static variable in class com.jivesoftware.community.AbuseType
Type representing a spam abuse report.
startEdit(User) - Method in interface com.jivesoftware.community.Document
Sets the editing user for the document.
startEdit(String) - Method in interface com.jivesoftware.community.Document
Sets the sessionID of the editing guest user for the document.
STATUS_AWAY - Static variable in interface com.jivesoftware.community.Presence
 
STATUS_DEFAULT - Static variable in interface com.jivesoftware.community.BlogPost
The default public status for a blog post.
STATUS_DRAFT - Static variable in interface com.jivesoftware.community.BlogPost
Status value for blog posts that have been saved to the system but haven't been published and shouldn't be viewable to the public.
STATUS_IDLE - Static variable in interface com.jivesoftware.community.Presence
 
STATUS_INVISIBLE - Static variable in interface com.jivesoftware.community.Presence
 
STATUS_LEVEL - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_LEVEL_BLOCK_GROUP_LEADERS - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
STATUS_LEVEL_CALCULATOR_PROPERTY - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
STATUS_LEVEL_ENABLE_PROPERTY - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
STATUS_LEVEL_MANAGER_PROPERTY - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
STATUS_LEVEL_POINT - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_LEVEL_SCENARIO - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_ONLINE - Static variable in interface com.jivesoftware.community.Presence
 
STATUS_PUBLISH - Static variable in interface com.jivesoftware.community.BlogPost
Status value for blog posts that have been published to the system and should be viewable to the public.
STATUS_SCHEDULED - Static variable in interface com.jivesoftware.community.BlogPost
Status value for blog posts that have been scheduled for publication in the future and shouldn't be viewable to the public.
StatusLevel - Interface in com.jivesoftware.community
Represents a status Level in the system.
StatusLevelAlreadyExistsException - Exception in com.jivesoftware.community
Thrown when attempting to create a StatusLevel that already exists in the system
StatusLevelAlreadyExistsException() - Constructor for exception com.jivesoftware.community.StatusLevelAlreadyExistsException
 
StatusLevelAlreadyExistsException(String) - Constructor for exception com.jivesoftware.community.StatusLevelAlreadyExistsException
 
statusLevelCache - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
StatusLevelCalculator - Interface in com.jivesoftware.community
Defines methods need to calculate status levels and leaders.
StatusLevelException - Exception in com.jivesoftware.community
The StatusLevelException is thrown by the StatusLevel class.
StatusLevelException(String) - Constructor for exception com.jivesoftware.community.StatusLevelException
 
StatusLevelException() - Constructor for exception com.jivesoftware.community.StatusLevelException
 
statusLevelIDCache - Static variable in class com.jivesoftware.community.StatusLevelManagerFactory
 
StatusLevelManager - Interface in com.jivesoftware.community
Manages status level feature.
StatusLevelManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of StatusLevelManager
StatusLevelManagerFactory.StatusCalculatorPropertyListener - Class in com.jivesoftware.community
Checks to see if the calculator implementation has changes and reinitializes it if it has been
StatusLevelManagerFactory.StatusCalculatorPropertyListener() - Constructor for class com.jivesoftware.community.StatusLevelManagerFactory.StatusCalculatorPropertyListener
 
StatusLevelNotFoundException - Exception in com.jivesoftware.community
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.community.StatusLevelNotFoundException
 
StatusLevelNotFoundException(String) - Constructor for exception com.jivesoftware.community.StatusLevelNotFoundException
 
StatusResultFilter - Class in com.jivesoftware.community
Filters and sorts user status.
StatusResultFilter() - Constructor for class com.jivesoftware.community.StatusResultFilter
 
stopEdit(User) - Method in interface com.jivesoftware.community.Document
Set the user as no longer editing the document.
stopEdit(String) - Method in interface com.jivesoftware.community.Document
Set the guest user with the given sessionID as no longer editing the document.
STORAGE_MODE_CHANGED - Static variable in class com.jivesoftware.community.event.StorageManagerEvent
Event type for whenever the storage mode is changed
StorageManager - Interface in com.jivesoftware.community
Manages the storage of binary objects and determines whether binary object data is stored on the file system or in the database.
StorageManagerEvent - Class in com.jivesoftware.community.event
A class for storage manager events.
StorageManagerEvent(int) - Constructor for class com.jivesoftware.community.event.StorageManagerEvent
 
StorageManagerEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for StorageManagerEvents.
StorageManagerListener - Interface in com.jivesoftware.community.event
A StorageManagerListener gets notified anytime a storage event is fired.
storageModeChanged(StorageManagerEvent) - Method in interface com.jivesoftware.community.event.StorageManagerListener
Fired when the storage mode is changed.
stripHTMLTags(String) - Method in class com.jivesoftware.community.widget.BaseWidget
 
SUBJECT_FIELD - Static variable in interface com.jivesoftware.community.JiveContentObject
Constant used to indicate a subject field.
supportsPagination() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns true if this provider supports pagination.
supportsUpdate() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns true if this provider supports create and delete operations.
SYSTEM - Static variable in class com.jivesoftware.community.JiveConstants
 
SYSTEM_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer the entire sytem.
SYSTEM_QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 

T

TAG - Static variable in class com.jivesoftware.community.JiveConstants
 
TAG_ADDED - Static variable in class com.jivesoftware.community.event.TagEvent
A tag was added to an object.
TAG_CREATED - Static variable in class com.jivesoftware.community.event.TagEvent
Tag was added to the system.
TAG_REMOVED - Static variable in class com.jivesoftware.community.event.TagEvent
A tag was removed from an object.
TAG_SET - Static variable in class com.jivesoftware.community.JiveConstants
 
TAG_SET_CREATED - Static variable in class com.jivesoftware.community.event.TagSetEvent
Tag set was added to the system.
TAG_SET_DELETED - Static variable in class com.jivesoftware.community.event.TagSetEvent
Tag set was removed from the system
TAG_SET_MODIFIED - Static variable in class com.jivesoftware.community.event.TagSetEvent
Tag set was modified
tagAdded(TagEvent) - Method in interface com.jivesoftware.community.event.TagListener
Fired when a tag has been added to an object in the system.
tagBelongsToOtherSet(ContentTag, TagSet) - Method in interface com.jivesoftware.community.TagSetManager
Returns true if the supplied ContentTag is associated with a TagSet other than the supplied TagSet in the Community in which the supplied TagSet belongs.
tagCache - Static variable in class com.jivesoftware.community.TagManagerFactory
A cache for tag objects.
tagContentCache - Static variable in class com.jivesoftware.community.TagManagerFactory
A cache for content object to tagID list
tagCreated(TagEvent) - Method in interface com.jivesoftware.community.event.TagListener
Fired when a tag has been added to the system.
TagEvent - Class in com.jivesoftware.community.event
A class for ContentTag events.
TagEvent(int, ContentTag, Map<String, ? extends Object>, long, int) - Constructor for class com.jivesoftware.community.event.TagEvent
Creates a new tag event.
TagEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for TagEvents.
Taggable - Interface in com.jivesoftware.community
Deprecated.  
tagIDCache - Static variable in class com.jivesoftware.community.TagManagerFactory
A cache that maps tag names to ID's.
TagListener - Interface in com.jivesoftware.community.event
A TagListener gets notified anytime a tag event is fired.
TagManager - Interface in com.jivesoftware.community
Provides a manager to create, retrieve and delete tags.
TagManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of a TagManager
tagRemoved(TagEvent) - Method in interface com.jivesoftware.community.event.TagListener
Fired when a tag has been removed from an object in the system.
TagResultFilter - Class in com.jivesoftware.community
Filters and sorts JiveContentObjects based on ContentTags.
TagResultFilter() - Constructor for class com.jivesoftware.community.TagResultFilter
 
TagSet - Interface in com.jivesoftware.community
A TagSet is a named collection of ContentTags used to build filtered content views.
tagSetCreated(TagSetEvent) - Method in interface com.jivesoftware.community.event.TagSetListener
Fired when a tag set has been added to the system.
tagSetDeleted(TagSetEvent) - Method in interface com.jivesoftware.community.event.TagSetListener
Fired when a tag set has been removed from the system.
TagSetEvent - Class in com.jivesoftware.community.event
A class for TagSet events.
TagSetEvent(int, TagSet, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.TagSetEvent
Creates a new tag set event.
TagSetEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for TagSetEvents.
TagSetListener - Interface in com.jivesoftware.community.event
A TagSetListener gets notified anytime a tag set event is fired.
TagSetManager - Interface in com.jivesoftware.community
Manages the creation, deletion and lookup of TagSets.
tagSetModified(TagSetEvent) - Method in interface com.jivesoftware.community.event.TagSetListener
Fired when a tag set has been modified.
TEMPORARY_DOCUMENT_ID - Static variable in class com.jivesoftware.community.JiveConstants
 
testComponent(String, int, String) - Method in class com.jivesoftware.community.xmpp.IMManager
Tests an external component connection to the Openfire server.
testSearchEngineByID(long) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Test the search engine by its ID.
THREAD - Static variable in class com.jivesoftware.community.JiveConstants
 
THREAD_ADDED - Static variable in class com.jivesoftware.community.event.ThreadEvent
Thread was added to the system.
THREAD_DELETING - Static variable in class com.jivesoftware.community.event.ThreadEvent
Thread is about to be deleted.
THREAD_MODERATION_MODIFIED - Static variable in class com.jivesoftware.community.event.ThreadEvent
The moderation value of the thread was changed.
THREAD_MOVED - Static variable in class com.jivesoftware.community.event.ThreadEvent
Thread was moved to another community.
THREAD_NAME - Static variable in class com.jivesoftware.community.JiveConstants
 
THREAD_RATED - Static variable in class com.jivesoftware.community.event.ThreadEvent
The thread was rated.
THREAD_VIEWED - Static variable in class com.jivesoftware.community.event.ThreadEvent
The thread was viewed.
threadAdded(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when a thread has been added to the system.
threadAdded(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
threadDeleted(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when a thread is about to be deleted from the system.
threadDeleted(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
ThreadEvent - Class in com.jivesoftware.community.event
A class for ForumThread events.
ThreadEvent(int, ForumThread, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.ThreadEvent
Creates a new thread event.
ThreadEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for ThreadEvents.
ThreadListener - Interface in com.jivesoftware.community.event
A ThreadListener gets notified anytime a thread event is fired.
threadModerationModified(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when the moderation value of a thread has been changed.
threadModerationModified(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
threadMoved(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when a thread is moved from one foru to another.
threadMoved(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
threadRated(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when the thread has been rated.
threadRated(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
ThreadResultFilter - Class in com.jivesoftware.community
Filters and sorts lists of ForumThreads and ForumMessages.
ThreadResultFilter() - Constructor for class com.jivesoftware.community.ThreadResultFilter
 
threadViewed(ThreadEvent) - Method in interface com.jivesoftware.community.event.ThreadListener
Fired when the thread has been viewed.
threadViewed(ThreadEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
TOO_LARGE - Static variable in exception com.jivesoftware.community.AttachmentException
 
TOO_LARGE - Static variable in exception com.jivesoftware.community.BinaryBodyException
 
TOO_LARGE - Static variable in exception com.jivesoftware.community.ImageException
 
TOO_MANY_ATTACHMENTS - Static variable in exception com.jivesoftware.community.AttachmentException
 
TOO_MANY_IMAGES - Static variable in exception com.jivesoftware.community.ImageException
 
topLevelComments() - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns an iterator of top level comments.
toString() - Method in class com.jivesoftware.community.ApprovalStatus
 
toString() - Method in class com.jivesoftware.community.Ban
 
toString() - Method in class com.jivesoftware.community.BanManagerFactory.BanCacheKey
 
toString() - Method in enum com.jivesoftware.community.DocumentFieldType.DataType
Simply returns the name (via DocumentFieldType.DataType.getName()) since that is unique.
toString() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
 
toString() - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
toString() - Method in class com.jivesoftware.community.EmailMessage
 
toString() - Method in class com.jivesoftware.community.EntityDescriptor
 
toString() - Method in class com.jivesoftware.community.Permissions
 
toString() - Method in class com.jivesoftware.community.PermissionType
 
toString() - Method in class com.jivesoftware.community.ProfileField
Returns a String representation of the ProfileField object using the field name.
toString() - Method in class com.jivesoftware.community.Question.State
 
toString() - Method in class com.jivesoftware.community.QuestionFilter.SortField
 
toString() - Method in enum com.jivesoftware.community.renderer.RenderTarget
 
toString() - Method in class com.jivesoftware.spi.ServiceEvent
 
toString() - Method in class com.jivesoftware.spi.user.UserTemplate
 
TRACKBACK - Static variable in class com.jivesoftware.community.JiveConstants
 
Trackback - Interface in com.jivesoftware.community
A container for jive trackback data.
TRACKBACK_CREATED - Static variable in class com.jivesoftware.community.event.TrackbackEvent
Trackback was added to the system.
TRACKBACK_DELETED - Static variable in class com.jivesoftware.community.event.TrackbackEvent
Trackback was deleted.
TRACKBACK_MODIFIED - Static variable in class com.jivesoftware.community.event.TrackbackEvent
Trackback was modified.
trackbackCache - Static variable in class com.jivesoftware.community.TrackbackManagerFactory
A cache for user objects.
trackbackCreated(TrackbackEvent) - Method in interface com.jivesoftware.community.event.TrackbackListener
Fired when a trackback has been added to the system.
trackbackDeleted(TrackbackEvent) - Method in interface com.jivesoftware.community.event.TrackbackListener
Fired when a trackback is about to be deleted from the system.
TrackbackEvent - Class in com.jivesoftware.community.event
A class for Trackback events.
TrackbackEvent(int, Trackback, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.TrackbackEvent
Creates a new trackback event.
TrackbackEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for TrackbackEvents.
TrackbackListener - Interface in com.jivesoftware.community.event
A TrackbackListener gets notified anytime a trackback event is fired.
TrackbackManager - Interface in com.jivesoftware.community
Manages the trackback feature within Clearspace
TrackbackManagerFactory - Class in com.jivesoftware.community
A factory that returns a concrete instance of a TrackbackManager
trackbackModified(TrackbackEvent) - Method in interface com.jivesoftware.community.event.TrackbackListener
Fired when a trackback has been modified in the system.
TRACKBACKS_DEFAULT - Static variable in interface com.jivesoftware.community.BlogPost
The default trackback status for a blog post.
TRACKBACKS_DEFAULT - Static variable in interface com.jivesoftware.community.Document
The default trackback status for a document.
TreeWalker - Interface in com.jivesoftware.community
Allows hierarchical navigation of a Thread.
TYPE_BAN_IP - Static variable in interface com.jivesoftware.community.BanManager
Ban By IP Address
TYPE_BAN_USER - Static variable in interface com.jivesoftware.community.BanManager
Ban by user account

U

UNAUTHORIZED - Static variable in class com.jivesoftware.community.action.JiveActionSupport
An action return type that indicates the user is not authorized to what they requested.
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
 
unloadPlugin(String) - Method in class com.jivesoftware.base.plugin.PluginManager
Unloads a plugin.
UNREAD - Static variable in interface com.jivesoftware.community.ReadTracker
Status to indicate that the object has never been read.
UPDATE_COMPLETED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index update is completed.
UPDATE_COMPLETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index update is completed.
UPDATE_STARTED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an index update is started.
UPDATE_STARTED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever an index update is started.
updateBan(Ban) - Method in interface com.jivesoftware.community.BanManager
Updates a ban entry in the database
updateComment(JiveObject, Comment) - Method in interface com.jivesoftware.community.CommentManager
Updates an existing comment.
updateCompleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index update is completed.
updateCompleted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index update is completed.
UPDATED - Static variable in interface com.jivesoftware.community.ReadTracker
Status to indicate the object has been updated since the last time a read was done.
updateDraft(Draft) - Method in interface com.jivesoftware.community.DraftManager
Update an existing draft.
updateIndex() - Method in interface com.jivesoftware.community.ProfileSearchManager
Manually update the index to include all new objects since the last update.
updateIndex() - Method in interface com.jivesoftware.community.SearchManager
Manually update the index to include all new and updated content objects since the last update.
updateIndex(Blog) - Method in interface com.jivesoftware.community.SearchManager
Update an individual blog in the index.
updateIndex(BlogPost) - Method in interface com.jivesoftware.community.SearchManager
Update an individual blog post in the index.
updateIndex(ForumMessage) - Method in interface com.jivesoftware.community.SearchManager
Update an individual message in the index.
updateIndex(Document) - Method in interface com.jivesoftware.community.SearchManager
Update an individual document in the index.
updateIndex(Comment) - Method in interface com.jivesoftware.community.SearchManager
Updates an individual comment in the index.
updateIndex(Attachment) - Method in interface com.jivesoftware.community.SearchManager
Updates an individual attachment in the index.
updateIndex(Community) - Method in interface com.jivesoftware.community.SearchManager
Update an individual community in the index.
updateLinks(JiveObject, List<Link>) - Method in interface com.jivesoftware.community.LinkManager
Updates all stored link for the provided source object.
updateLoginTimestamp(AuthToken) - Method in class com.jivesoftware.base.AuthFactory
 
updateSearchEngine(SearchEngine) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Update the managed search engine.
updateStarted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when an index update is started.
updateStarted(SearchIndexEvent) - Method in interface com.jivesoftware.community.event.SearchIndexListener
Fired when an index update is started.
updateStatusLevelScenario(StatusLevelScenario) - Method in interface com.jivesoftware.community.StatusLevelManager
Update the points and whether or not this scenario is included in status level results.
updateWidgetFrameProperties(WidgetFrame) - Method in interface com.jivesoftware.community.widget.WidgetManager
Updates the properties for the specified WidgetFrame.
updateWidgetFrames(JiveObject, List<WidgetFrame>) - Method in interface com.jivesoftware.community.widget.WidgetManager
Updates the list of WidgetFrames.
user - Variable in class com.jivesoftware.base.plugin.MacroContext
 
User - Interface in com.jivesoftware.base
The User interface provides information about and services for users of the system.
user - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
USER - Static variable in class com.jivesoftware.community.JiveConstants
 
User - Interface in com.jivesoftware.spi.user
The interface User is used to identify a user and provide authentication.
USER_ADDED - Static variable in class com.jivesoftware.community.event.ProfileSearchIndexEvent
Event type for whenever an user is added to the search index.
USER_ADMIN - Static variable in class com.jivesoftware.community.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.community.event.ProfileSearchIndexEvent
Event type for whenever an user is removed from the search index.
USER_LOCALE_PROP_NAME - Static variable in class com.jivesoftware.community.JiveConstants
The name of the extended user property used to store the user's locale code.
USER_LOGGED_IN - Static variable in class com.jivesoftware.base.event.UserEvent
Event type for whenever a user logs in
USER_MANAGER_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
USER_MODIFIED - Static variable in class com.jivesoftware.base.event.UserEvent
Event type for whenever a user is modified.
USER_STATUS - Static variable in class com.jivesoftware.community.JiveConstants
 
USER_TIMEZONE_PROP_NAME - Static variable in class com.jivesoftware.community.JiveConstants
The name of the extended user property used to store the user's time zone code.
userAdded(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.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.
userCreated(UserEvent) - Method in class com.jivesoftware.community.xmpp.IMManager
 
userDeleted(UserEvent) - Method in interface com.jivesoftware.base.event.UserListener
Fired when a user is deleted.
userDeleted(ProfileSearchIndexEvent) - Method in interface com.jivesoftware.community.event.ProfileSearchIndexListener
Fired when a user is deleted from the search index.
userDeleted(UserEvent) - Method in class com.jivesoftware.community.xmpp.IMManager
 
userEmailCache - Static variable in class com.jivesoftware.base.UserManagerFactory
A cache the maps email addresses to user ids.
UserEvent - Class in com.jivesoftware.base.event
A class for user events.
UserEvent(int, User, Map<String, ?>) - 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.
userLoggedIn(UserEvent) - Method in interface com.jivesoftware.base.event.UserListener
This method is called whenever a user logs in.
userLoggedIn(UserEvent) - Method in class com.jivesoftware.community.xmpp.IMManager
 
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.
userModified(UserEvent) - Method in class com.jivesoftware.community.xmpp.IMManager
 
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
 
UserNotificationEvent - Enum in com.jivesoftware.spi.user
 
UserProvider - Interface in com.jivesoftware.spi.user
Service for querying users and notifying listeners when operations that modify users occur.
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.community.PermissionsManager
Returns all the userID's of users with a particular permission.
usersWithPermissionCount(PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Returns a count of the users that have a particular permission.
UserTemplate - Class in com.jivesoftware.spi.user
 
UserTemplate() - Constructor for class com.jivesoftware.spi.user.UserTemplate
 
UserTemplate(String, String, String) - Constructor for class com.jivesoftware.spi.user.UserTemplate
 
UserTemplate(String, String, char[], String) - Constructor for class com.jivesoftware.spi.user.UserTemplate
 

V

validate(String, User) - Method in interface com.jivesoftware.community.DocumentFieldValidator
Performs field validation on user supplied input.
validate(Map<String, ?>, User) - Method in interface com.jivesoftware.community.DocumentTypeValidator
Performs cross field validation on user supplied input.
validateAccount(long, String) - Method in interface com.jivesoftware.community.RegistrationManager
Validates a user account using a unique validation key and sends a welcome email if welcome email is enabled.
validateConfiguration() - Method in interface com.jivesoftware.community.importer.Importer
Returns a map of errors (field name -> error string) or an empty map if the configuration is deemed valid
value() - Method in class com.jivesoftware.community.Permissions
Returns the long value (bitmask) of the permissions that are set.
valueOf(String) - Static method in enum com.jivesoftware.community.Activity.Type
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum com.jivesoftware.community.Activity.Type
 
valueOf(String) - Static method in enum com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.ContentRetrieval.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.DocumentFieldType.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.DocumentState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.JiveInterceptor.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.ProfileField.Type
Returns the enum constant of this type with the specified name.
valueOf(int) - Static method in enum com.jivesoftware.community.ProfileField.Type
Gets an Type object from an typeID
valueOf(String) - Static method in class com.jivesoftware.community.Question.State
Returns the State associated with the specified String value.
valueOf(int) - Static method in class com.jivesoftware.community.Question.State
Returns the State associated with the specified integer code.
valueOf(String) - Static method in enum com.jivesoftware.community.renderer.RenderTarget
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.renderer.RenderType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.SearchQueryResult.ResultType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.community.widget.Widget.ContainerSize
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jivesoftware.spi.user.UserNotificationEvent
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.jivesoftware.community.Activity.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Method in class com.jivesoftware.community.cache.DefaultCache
 
values() - Static method in enum com.jivesoftware.community.ContentRetrieval.ContentType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.DocumentFieldType.DataType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.DocumentState
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.JiveInterceptor.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.ProfileField.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.renderer.RenderTarget
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.renderer.RenderType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.SearchQueryResult.ResultType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.community.widget.Widget.ContainerSize
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.jivesoftware.spi.user.UserNotificationEvent
Returns an array containing the constants of this enum type, in the order they're declared.
version - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
VERSION_ADDED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for when a version is added
VERSION_DELETING - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for when a version is about to be deleted
VERSION_MODIFIED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for when a version is modified
versionAdded(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fied when a new version is added to a document.
versionAdded(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
VersionComment - Interface in com.jivesoftware.community
Encapsulates a comment on a document version.
versionDeleting(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fied when a version is about to be deleted from a document.
versionDeleting(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
VersionManager - Interface in com.jivesoftware.community
Manages document versions.
versionModified(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fied when a version is modified.
versionModified(DocumentEvent) - Method in class com.jivesoftware.community.TagManagerFactory
 
VIEW_COMMUNITY - Static variable in class com.jivesoftware.community.Permissions
Permission to read object.
VIEW_ONLINE_STATUS - Static variable in class com.jivesoftware.community.Permissions
Permission to see the online status of a particular user.
VOTE_ADDED - Static variable in class com.jivesoftware.community.event.PollEvent
A vote was added to the poll.
VOTE_IN_POLL - Static variable in class com.jivesoftware.community.Permissions
Permission to vote in polls.
VOTE_MODIFIED - Static variable in class com.jivesoftware.community.event.PollEvent
A vote was modified.
VOTE_REMOVED - Static variable in class com.jivesoftware.community.event.PollEvent
A vote was removed.
voteAdded(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when a vote is added to a poll.
voteCache - Static variable in class com.jivesoftware.community.PollManagerFactory
 
voteModified(PollEvent) - Method in interface com.jivesoftware.community.event.PollListener
Fired when a poll vote is modified.
voteRemoved(PollEvent) - Method in interface com.jivesoftware.community.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.community
A watch is a way for a user to track updates to an object.
WATCH_SETTINGS - Static variable in class com.jivesoftware.community.JiveConstants
 
Watchable - Interface in com.jivesoftware.community
Deprecated.  
WATCHABLE_OBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
WatchManager - Interface in com.jivesoftware.community
Manages watches on communities, forums, and threads.
webServiceClasses - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
WEEK - Static variable in class com.jivesoftware.community.JiveConstants
One week (in milliseconds).
WIDGET - Static variable in class com.jivesoftware.community.JiveConstants
 
Widget - Interface in com.jivesoftware.community.widget
All Widgets must implement this interface, which exposes the Widget.render(WidgetContext, com.jivesoftware.community.widget.Widget.ContainerSize) method.
Widget.ContainerSize - Enum in com.jivesoftware.community.widget
Enumeration of the size of the parent container.
WIDGET_FRAME - Static variable in class com.jivesoftware.community.JiveConstants
 
WidgetAlreadyExistsException - Exception in com.jivesoftware.community.widget
Thrown when attempting to install a Widget that already exists.
WidgetAlreadyExistsException() - Constructor for exception com.jivesoftware.community.widget.WidgetAlreadyExistsException
 
WidgetAlreadyExistsException(String) - Constructor for exception com.jivesoftware.community.widget.WidgetAlreadyExistsException
 
WidgetAlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.community.widget.WidgetAlreadyExistsException
 
WidgetAlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.community.widget.WidgetAlreadyExistsException
 
widgetClasses - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
WidgetContext - Class in com.jivesoftware.community.widget
The widget context is passed to all Widgets when the render method is invoked.
WidgetContext(JiveContext, User, AuthToken, HttpServletRequest, HttpServletResponse) - Constructor for class com.jivesoftware.community.widget.WidgetContext
Creates a WidgetContext with all the necessary information for a widget author to render their widget.
WidgetContext(JiveContext, User, AuthToken, HttpServletRequest, HttpServletResponse, Community) - Constructor for class com.jivesoftware.community.widget.WidgetContext
Creates a WidgetContext with all the necessary information for a widget author to render their widget, as well as the parent community of the widget.
WidgetContext(JiveContext, User, AuthToken, HttpServletRequest, HttpServletResponse, Community, boolean) - Constructor for class com.jivesoftware.community.widget.WidgetContext
Creates a WidgetContext with all the necessary information for a widget author to render their widget, as well as the parent community of the widget.
WidgetDAOFactory - Class in com.jivesoftware.community.widget
A factory that returns a concrete instance of a WidgetDAO.
WidgetManager - Interface in com.jivesoftware.community.widget
Centralized management of widgets in the Jive system including creating, retrieving, and deleting Widget objects.
WORKGROUP_AGENT - Static variable in class com.jivesoftware.community.JiveConstants
 
WORKGROUP_GROUP - Static variable in class com.jivesoftware.community.JiveConstants
 
WORKGROUP_QUEUE - Static variable in class com.jivesoftware.community.JiveConstants
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.Ban
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.DocumentFieldValue
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.EntityDescriptor
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.ProfileField
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.ProfileFieldOption
 
writeExternal(DataOutput) - Method in class com.jivesoftware.community.ProfileFieldValue
 

X

XMPPListener - Interface in com.jivesoftware.community.event
A XMPPListener gets notified anytime a XMPP event is fired.

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

Copyright © 1999-2007 Jive Software.