Clearspace API (1.10.16) 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.