Clearspace API (2.5.18) Core Javadocs
A B C D E F G H I J 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
acceptableParameterName(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
[CSSEC-38] Do not allow parameters that could access methods, such as ?
ACROBAT - Static variable in class com.jivesoftware.community.util.SkinUtils.FileType
 
ACTIVE_AVATAR_MODIFIED - Static variable in class com.jivesoftware.community.event.AvatarEvent
The active Avatar of a user was modified.
activeAvatarModified(AvatarEvent) - Method in interface com.jivesoftware.community.event.AvatarListener
Fired when the active avatar of a user has been changed.
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.
ActivityManager - Interface in com.jivesoftware.community
This manager provides methods to retrieve recent activities and popular threads, documents and blog posts.
addActivity(JiveObject, JiveObject, User, Activity.Type) - Method in interface com.jivesoftware.community.ActivityManager
Adds a new activity to the ActivityManager
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.
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(CommentContentResource, Comment) - Method in interface com.jivesoftware.community.CommentManager
Adds a new comment (no parent) to the object.
addComment(CommentContentResource, Comment, Comment) - Method in interface com.jivesoftware.community.CommentManager
Adds a new comment having a parent comment to the object.
addCommonFileExtensionName(String, String) - Static method in class com.jivesoftware.community.util.SkinUtils
Add a mapping for a file extension to a particular type of file.
addContainerApprover(int, long, long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Adds a user as a document approver for an entire container.
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(JiveContainer, Document, Map) - Method in interface com.jivesoftware.community.DocumentManager
Add a document as a child of a container.
addDocument(JiveContainer, Document, PermissionsBundle, Map) - Method in interface com.jivesoftware.community.DocumentManager
Add a document as a child of the container with permissions defined by the provided permission bundle.
addDocumentApprover(JiveContainer, User) - Method in interface com.jivesoftware.community.DocumentManager
Add the user as a document approver for this entire container.
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.
addError(Map<String, Object>, String) - Method in class com.jivesoftware.community.widget.BaseWidget
 
addGroupPermission(Group, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
Grants a group a particular permission.
addGroupPermission(int, long, Group, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
 
addHelpfulAnswer(ForumMessage) - Method in interface com.jivesoftware.community.Question
Marks the specified message as a helpful answer to this question.
addI18nEditionKeys(Map<String, String>) - Static method in class com.jivesoftware.community.action.JiveActionSupport
Allows additional i18n edition keys to be added after initialization (eg. when the chat plugin is loaded).
addIconGenerator(int, IconGenerator) - Static method in class com.jivesoftware.community.util.SkinUtils
Add a new or override an existing icon generator for the given object type.
addImage(Image) - Method in interface com.jivesoftware.community.ImageContentResource
Adds an already existing (temporary) image to the object.
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(AnnouncementListener) - Method in class com.jivesoftware.community.event.AnnouncementEventDispatcher
 
addListener(AttachmentListener) - Method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
addListener(AvatarListener) - Method in class com.jivesoftware.community.event.AvatarEventDispatcher
 
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(ProjectListener) - Method in class com.jivesoftware.community.event.ProjectEventDispatcher
 
addListener(QuestionListener) - Method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
addListener(ScheduledTaskEventListener) - Method in class com.jivesoftware.community.event.ScheduledTaskEventDispatcher
 
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(TaskListener) - Method in class com.jivesoftware.community.event.TaskEventDispatcher
 
addListener(ThreadListener) - Method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
addListener(TrackbackListener) - Method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
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
addMember(User) - Method in interface com.jivesoftware.base.Group
Adds a member to the group.
addMember(SocialGroup, User, SocialGroupMember.Type) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Adds a user to a social group
addMessage(ForumThread, ForumMessage, ForumMessage) - Method in interface com.jivesoftware.community.ForumManager
Adds a new message to a given thread.
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.
addPluginListener(PluginListener) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Registers a plugin applicationLifeCycleListener.
addPoints(User, JiveContainer, JiveObject, long, String) - Method in interface com.jivesoftware.community.StatusLevelManager
Rewards points to a user.
addPoints(User, JiveContainer, JiveObject, String) - Method in interface com.jivesoftware.community.StatusLevelManager
Give points to a user using the specified scenerio code.
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.
addRenderPlugin(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Installs a new class into the list of render pugins for the system.
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.
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(long) - 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(JiveContainer, ForumThread) - Method in interface com.jivesoftware.community.ForumManager
Adds a new thread to the container.
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.
addToIndex(Project) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual project to the index.
addToIndex(SocialGroup) - Method in interface com.jivesoftware.community.SearchManager
Adds an individual socialGroup to the index.
addToIndex(User) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Adds an individual user to the index.
addTrackback(Trackback, int, long) - 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.
addUserPermission(int, long, User, PermissionType, long) - Method in interface com.jivesoftware.community.PermissionsManager
 
addUsers(List<User>) - Method in interface com.jivesoftware.community.Blog
Gives a list of users permissions to post to this blog.
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.
addWidgetLayout(String) - Method in interface com.jivesoftware.community.widget.WidgetManager
Installs a new class into the list of WidgetLayouts for the system.
addWidgetLayout(JiveObject, WidgetLayout) - Method in interface com.jivesoftware.community.widget.WidgetManager
Creates a new draft WidgetLayout for the specified JiveObject.
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
 
afterInitialization() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Do necessary cleanup after initialization.
ALL_TYPES - Static variable in interface com.jivesoftware.community.SearchQueryResult
An array of all SearchQueryResult.ResultTypes
ALL_WATCH_TYPES - Static variable in interface com.jivesoftware.community.Watch
 
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
 
AnnouncementNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.community.AnnouncementNotFoundException
 
ANONYMOUS - Static variable in class com.jivesoftware.community.JiveConstants
 
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
 
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(Configuration, Map<String, Object>, String) - Static method in class com.jivesoftware.community.renderer.BaseMacro
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.
approvalCallback(Long, JiveObject, User, String) - Method in interface com.jivesoftware.community.moderation.ModerationStrategy
Handles the approval callback.
ApprovalDAO - Interface in com.jivesoftware.community.impl.dao
Handles database interactions for relationship approval workflow related functionality.
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(Comment, AuthToken) - Method in interface com.jivesoftware.community.CommentManager
 
approve(User) - Method in interface com.jivesoftware.community.Document
Marks this document as being approved by the specified user.
approve(Long, JiveObject, User, String) - Method in interface com.jivesoftware.community.moderation.JiveObjectModerator
Approves the workflow for the given workflow ID and JiveObject.
approve(Long, JiveObject, User, String) - Method in interface com.jivesoftware.community.moderation.ModerationStrategy
Approves the workflow for the given workflow ID and JiveObject.
approve(ForumMessage) - Method in interface com.jivesoftware.community.OldModerationManager
Approve a moderated message
approveRelationship(UserRelationship, String) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
 
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...).
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 marker interface to denote objects that support attachments.
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, AttachmentContentResource, Attachment, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.AttachmentEvent
 
AttachmentEvent(int, AttachmentContentResource, Attachment, Map<String, ? extends Object>, File) - Constructor for class com.jivesoftware.community.event.AttachmentEvent
 
AttachmentEvent(int, AttachmentContentResource, 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(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
 
Audit - Annotation Type in com.jivesoftware.community.audit.aop
 
AUDIT_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
AUTH_FACTORY_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
AUTHN_REDIRECT_KEY - Static variable in class com.jivesoftware.community.JiveConstants
Used to redirect a successful auth to a different page if they previously failed.
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.
authProvider - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
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_CREATED - Static variable in class com.jivesoftware.community.event.AvatarEvent
Avatar was added to the system.
AVATAR_DELETED - Static variable in class com.jivesoftware.community.event.AvatarEvent
Avatar was deleted.
avatarCreated(AvatarEvent) - Method in interface com.jivesoftware.community.event.AvatarListener
Fired when an avatar has been added to the system.
avatarDeleted(AvatarEvent) - Method in interface com.jivesoftware.community.event.AvatarListener
Fired when an avatar is about to be deleted from the system.
AvatarEvent - Class in com.jivesoftware.community.event
A class for Avatar events.
AvatarEvent(int, Avatar, Map<String, ? extends Object>) - Constructor for class com.jivesoftware.community.event.AvatarEvent
Creates a new avatar event.
AvatarEventDispatcher - Class in com.jivesoftware.community.event
Dispatcher for AvatarEvents.
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
 
AvatarListener - Interface in com.jivesoftware.community.event
An AvatarListener gets notified anytime an avatar event is fired.
AvatarManager - Interface in com.jivesoftware.community
Manages the avatar feature.
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
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 - Variable in class com.jivesoftware.community.action.JiveActionSupport
 
BanManager - Interface in com.jivesoftware.community
Manages the banning of User Accounts and IP Addresses.
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
 
BaseWidgetContext - Class in com.jivesoftware.community.widget
The widget context is passed to all Widgets when the render method is invoked.
BaseWidgetContext(WidgetTypeDescriptor, User, AuthToken, HttpServletRequest, HttpServletResponse, boolean) - Constructor for class com.jivesoftware.community.widget.BaseWidgetContext
Creates a BaseWidgetContext of a given type with all the necessary information for a widget author to render their widget.
BaseWidgetContext(User, AuthToken, HttpServletRequest, HttpServletResponse) - Constructor for class com.jivesoftware.community.widget.BaseWidgetContext
Creates a BaseWidgetContext whose type is WidgetType.COMMUNITY with all the necessary information for a widget author to render their widget.
BATCH_EMAIL_WATCH - Static variable in interface com.jivesoftware.community.Watch
Batch email watch type.
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
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.
BLOCKED - Static variable in interface com.jivesoftware.community.Attachment
 
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_MOVED - Static variable in class com.jivesoftware.community.event.BlogEvent
Blog was moved
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.
blogMoved(BlogEvent) - Method in interface com.jivesoftware.community.event.BlogListener
Fired when a blog has been moved 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).
brokenPlugins - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 
bundleCache - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 

C

CANCEL - Static variable in class com.jivesoftware.community.action.JiveActionSupport
An action return type that indicates the user wants to cancel the current process.
cancel() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
canRate(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns whether the user can rate the JiveContentObject or not.
canViewRelationshipLists(User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
 
changeAnonymousVote(int, int, String) - Method in interface com.jivesoftware.community.Poll
Change a guest vote.
changelogExists - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
changeSharedSecret(String) - Method in class com.jivesoftware.community.xmpp.IMManager
Changes the shared secret and reset the component connection.
changeUserVote(int, int, User) - Method in interface com.jivesoftware.community.Poll
Change a user vote.
CHECKPOINT - Static variable in class com.jivesoftware.community.JiveConstants
 
CheckPoint - Class in com.jivesoftware.community.project
 
CheckPoint() - Constructor for class com.jivesoftware.community.project.CheckPoint
 
children(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns an Iterable for all the child comments of the parent.
classloaders - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 
cleanupUserTasks(User) - Method in interface com.jivesoftware.community.project.TaskManager
Deletes or disassociates tasks for the given user.
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.
clearTestContext() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
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.audit.aop - package com.jivesoftware.community.audit.aop
 
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.impl.dao - package com.jivesoftware.community.impl.dao
Data access objects for core Clearspace objects.
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.moderation - package com.jivesoftware.community.moderation
 
com.jivesoftware.community.project - package com.jivesoftware.community.project
 
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.socialgroup - package com.jivesoftware.community.socialgroup
 
com.jivesoftware.community.user.profile - package com.jivesoftware.community.user.profile
 
com.jivesoftware.community.user.relationships - package com.jivesoftware.community.user.relationships
 
com.jivesoftware.community.util - package com.jivesoftware.community.util
Clearspace utility classes.
com.jivesoftware.community.web.struts - package com.jivesoftware.community.web.struts
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_ADDED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a comment is added to the search index
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_DELETED - Static variable in class com.jivesoftware.community.event.SearchIndexEvent
Event type for whenever a comment is removed to the search index
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_MODERATED - Static variable in interface com.jivesoftware.community.CommentManager
Comments must be approved by the owner
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.
CommunityWidgetContext - Class in com.jivesoftware.community.widget
A widget context specifically for community widgets.
CommunityWidgetContext(User, AuthToken, HttpServletRequest, HttpServletResponse, Community) - Constructor for class com.jivesoftware.community.widget.CommunityWidgetContext
Creates a CommunityWidgetContext with all the necessary information for a widget author to render their widget.
CommunityWidgetContext(User, AuthToken, HttpServletRequest, HttpServletResponse, Community, boolean) - Constructor for class com.jivesoftware.community.widget.CommunityWidgetContext
Creates a CommunityWidgetContext of a given type with all the necessary information for a widget author to render their widget.
compareTo(Question.State) - Method in class com.jivesoftware.community.Question.State
 
compareTo(Object) - Method in class com.jivesoftware.community.user.profile.ProfileField
 
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.
COMPRESSED - Static variable in class com.jivesoftware.community.util.SkinUtils.FileType
 
config - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
configurators - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 
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
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, blog posts and task - 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.
convertDueDate(Date) - Static method in class com.jivesoftware.community.project.CheckPoint
 
convertToOriginalWikiText(Element) - Method in class com.jivesoftware.community.renderer.BaseMacro
 
convertToWikiSyntax(JiveContentObject) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
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.
countTimesAwarded(User, JiveObject) - Method in interface com.jivesoftware.community.StatusLevelManager
Counts the number of times a user has been awarded against a particular object.
create(JiveContainer, String, String, User, List<CheckPoint>, Date) - Method in interface com.jivesoftware.community.project.ProjectManager
Creates a new project as a child of the parent container
create(Project, User, User, String, String, Date) - Method in interface com.jivesoftware.community.project.TaskManager
Creates a new task within the provided project.
create(User, String, String, Date) - Method in interface com.jivesoftware.community.project.TaskManager
Creates a new personal task.
create(User, Project, List<Task>) - Method in interface com.jivesoftware.community.project.TaskManager
Creates new tasks in a batch.
create(String, SocialGroup.Type, String, User, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Creates a new Social Group
create(String, String, SocialGroup.Type, String, User, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Creates a new Social Group
create(User) - Method in interface com.jivesoftware.spi.user.UserProvider
Creates a user based on the data passed in the 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_BLOG_POST - Static variable in class com.jivesoftware.community.Permissions
Place-holder for permission to create a blog post.
CREATE_CHAT_EVENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a chat event.
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_PROJECT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a project.
CREATE_SOCIAL_GROUP - Static variable in class com.jivesoftware.community.Permissions
Permission to create a social group.
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, JiveContainer) - Method in interface com.jivesoftware.community.AnnouncementManager
Creates a new community announcement.
createApplicationUser(User) - Method in interface com.jivesoftware.base.UserManager
Creates a Clearspace-only user representation.
createAttachment(AttachmentContentResource, String, String, InputStream, File) - Method in interface com.jivesoftware.community.AttachmentManager
Creates a new attachment for the object.
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(JiveContainer) - Method in interface com.jivesoftware.community.BlogManager
Creates a new blog.
createBlog(User) - Method in interface com.jivesoftware.community.BlogManager
Creates a blog for a user.
createBlogPost(User) - Method in interface com.jivesoftware.community.Blog
Creates a new blog post.
createComment(CommentContentResource, User, String) - Method in interface com.jivesoftware.community.CommentManager
Create a new comment.
createComment(CommentContentResource, User, Document) - Method in interface com.jivesoftware.community.CommentManager
Create a new comment.
createCommunity(String, String, String) - Method in interface com.jivesoftware.community.CommunityManager
Creates a new Community as a sub-community of the root community using the name and description.
createCommunity(Community, String, String, String) - Method in interface com.jivesoftware.community.CommunityManager
Creates a new Community as a sub-community of a specified 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.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.
createDocument(User, DocumentType, String, String, Document) - 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(Comment, String, String, InputStream) - Method in interface com.jivesoftware.community.CommentManager
 
createImage(String, String, InputStream) - Method in interface com.jivesoftware.community.ImageContentResource
Creates a new image for the object.
createLocalCache(PluginDbBean) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Pulls the plugin jar file from the database outputs it to the pluginDirectory and expands the jar file.
createMessage(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Factory method to create a message with an anonymous author.
createMessage(JiveContainer, User) - Method in interface com.jivesoftware.community.ForumManager
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.
createNewWorkflow(long, long, long, Collection<Long>, String, String, JiveObjectModerator.Type) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Creates entries in the jiveWorkflowApproval table for a new workflow.
createPluginCacheDirectories(List<PluginDbBean>) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Checks the existing plugins to see if there are any plugins that need to be installed.
createPluginChainingClassloader() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Creates a classloader that will also look for classes under the plugin directories.
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.user.profile.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.
createRelationship(long, long, int, long, String) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Create a relationship between two users.
createRelationship(User, User, UserRelationshipGraph, String) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Create a relationship between two users.
createRelationshipGraph(String, UserRelationshipGraph.GraphType) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Create a new relationship graph with a given name and persist it.
createRelationshipList(String, String, User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Create a new UserRelationshipList.
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 other items 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(Project) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for projects that are deemed similar to the provided work space.
createSearchQueryCriteria(SocialGroup) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for social groups that are deemed similar to the provided group.
createSearchQueryCriteria(BlogPost) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for other items 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 other items 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 other searchable items that are deemed similar to the provided message.
createSearchQueryCriteria(Comment) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a SearchQueryCriteria that can be used to query for other searchable items that are deemed similar to the provided comment.
createStatus(Project, User, ProjectStatus.Type, String) - Method in interface com.jivesoftware.community.project.ProjectManager
Creates a project status for the given project.
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, LongList, JiveContainer) - Method in interface com.jivesoftware.community.TagSetManager
Creates a new TagSet with the supplied name, description, and tags.
createThread(JiveContainer, ForumMessage) - Method in interface com.jivesoftware.community.ForumManager
Factory method to create a new thread.
createTrackback(int, long) - Method in interface com.jivesoftware.community.TrackbackManager
Factory method to create a trackback .
createTrackedProject(User, Project) - Method in interface com.jivesoftware.community.project.ProjectManager
Creates a new tracked project.
createUser(User) - 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.
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
 
customURLMapperList - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 

D

databaseKey - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
databaseVersion - Variable in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
dateToText(HttpServletRequest, User, Date) - Static method in class com.jivesoftware.community.util.SkinUtils
Deprecated. Replaced to com.jivesoftware.util.DateUtils#displayFriendly(long)
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.
DEFAULT - Static variable in exception com.jivesoftware.community.AvatarException
 
DEFAULT_ABUSE_THRESHOLD - Static variable in interface com.jivesoftware.community.AbuseManager
 
DEFAULT_COMPRESSED_TYPES - Static variable in class com.jivesoftware.community.util.SkinUtils
 
DEFAULT_DOC_TYPES - Static variable in class com.jivesoftware.community.util.SkinUtils
 
DEFAULT_PRESENTATION_TYPES - Static variable in class com.jivesoftware.community.util.SkinUtils
 
DEFAULT_SPREADSHEET_TYPES - Static variable in class com.jivesoftware.community.util.SkinUtils
 
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.
DefaultImplementation - Annotation Type in com.jivesoftware.community
Used to specify what the default implementation is on an interface of a JiveManager
delete(Project) - Method in interface com.jivesoftware.community.project.ProjectManager
Deletes a project and all of its content.
delete(Task) - Method in interface com.jivesoftware.community.project.TaskManager
Delete a task.
delete(SocialGroup) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Deletes the passed social group
delete(User) - Method in interface com.jivesoftware.spi.user.UserProvider
Deletes a user in the underlying provider store.
DELETE_THREADS - Static variable in interface com.jivesoftware.community.ArchiveManager
An archive mode that specifies that threads should be deleted.
deleteAbuseReports(User) - Method in interface com.jivesoftware.community.AbuseManager
Removes all abuse reports from a particular user from the system.
deleteAllComments(CommentContentResource) - 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(int, long) - 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.AttachmentManager
Deletes an attachment that belongs to the object.
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.
deleteBrokenPlugin(String) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Removes a plugin that was flagged as broken.
deleteComment(CommentContentResource, Comment) - Method in interface com.jivesoftware.community.CommentManager
Deletes a comment in the object.
deleteComment(CommentContentResource, 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.
deleteEmptyWorkflownBeans(long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Deletes all the empty workflow entries.
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(Comment, Image) - Method in interface com.jivesoftware.community.CommentManager
 
deleteImage(Image) - Method in interface com.jivesoftware.community.ImageContentResource
Deletes an image that belongs to the object.
deleteIMHandlesForUser(User) - Method in class com.jivesoftware.community.xmpp.IMManager
 
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(ForumThread, ForumMessage, boolean) - Method in interface com.jivesoftware.community.ForumManager
Deletes a message and (optionally) all of its child messages from the given thread.
deleteMessage(ForumThread, ForumMessage) - Method in interface com.jivesoftware.community.ForumManager
Deletes a message from the given thread.
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.
deletePoll(Poll) - Method in interface com.jivesoftware.community.PollManager
Deletes a poll.
deletePresence(User) - Method in interface com.jivesoftware.community.PresenceManager
Remove the given user's presence and roster entry.
deleteProfileByID(long) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Removes all user profile data associated with a particular profile field.
deleteProfileByUserID(long) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Removes all user profile data associated with a particular user.
deleteProfileField(long) - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Removes a profile field from the system.
deleteProfileImage(User) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Deletes the users profile image
deleteQuestion(Question) - Method in interface com.jivesoftware.community.QuestionManager
Deletes an existing question.
deleteRelationshipGraph(long) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Remove the graph from the peristence layer.
deleteRelationshipList(UserRelationshipList) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Delete a list and all child relationships from the DB.
deleteSettings(User) - Method in interface com.jivesoftware.community.WatchManager
Delete the watch settings for a user
deleteSocialGroupAssociations(User) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Deletes the given user's social group memberships, plus any social groups owned by the given user.
deleteSocialGroupImage(SocialGroup) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Deletes the social groups image
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.
deleteUserActivities(User) - Method in interface com.jivesoftware.community.ActivityManager
Deletes all activities for a given user.
deleteUserAndContent(User) - Method in interface com.jivesoftware.base.UserManager
Deletes a user and the user's associated content (to maintain data consistency).
deleteUserAnnouncements(User) - Method in interface com.jivesoftware.community.AnnouncementManager
Deletes all of a user's announcements.
deleteUserAvatar(User) - Method in interface com.jivesoftware.community.AvatarManager
Deletes the given user's avatar from the system.
deleteUserBans(User) - Method in interface com.jivesoftware.community.BanManager
Removes all of a user's ban entries from the database.
deleteUserBlogs(User) - Method in interface com.jivesoftware.community.BlogManager
Delete all blog related content by the given user. is deleted, which means any posts, comments, trackbacks and tags this blog contains will be removed.
deleteUserComments(User) - Method in interface com.jivesoftware.community.CommentManager
Deletes all comments authored by the the given user.
deleteUserDocuments(User) - Method in interface com.jivesoftware.community.DocumentManager
Deletes all user documents, including previous versions.
deleteUserDrafts(User) - Method in interface com.jivesoftware.community.DraftManager
Delete all of a given user's drafts.
deleteUserEmailTokens(User) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Called before a user is deleted.
deleteUserGroupAssociations(User) - Method in interface com.jivesoftware.base.GroupManager
Deletes all group membership and group administrative associations related to the given user from the system.
deleteUserMessages(User) - Method in interface com.jivesoftware.community.ForumManager
Deletes all messages authored by a given user.
deleteUserMessages(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Deletes a user's folders, including the four default folders.
deleteUserPolls(User) - Method in interface com.jivesoftware.community.PollManager
Deletes all of a user's polls.
deleteUserQuestions(User) - Method in interface com.jivesoftware.community.QuestionManager
Delete all questions authored by the given user.
deleteUserRatings(User) - Method in interface com.jivesoftware.community.RatingManager
Remove all ratings associated with the given user.
deleteUserReadTrackers(User) - Method in interface com.jivesoftware.community.ReadTrackerManager
Deletes a given user's read trackers from the system.
deleteUserRelationships(User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Delete all relationships related to the given user, regardless of which end of the relationship the given user exists.
deleteUserStatusLevels(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Deletes all statusLevel levels for a given user from the system.
deleteUserWidgets(User) - Method in interface com.jivesoftware.community.widget.WidgetManager
Removes all wigets associated with the given user from the system.
deleteUserWorkflowBean(long, long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Deletes a given workflow entry given a workflowID and userID.
deleteUserWorkflows(long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Deletes any workflow entry associated with the given user ID.
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.
deleteWatches(int, long) - Method in interface com.jivesoftware.community.WatchManager
Deletes all watches on the given objectType and objectID.
deleteWorkflow(long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Deletes all entries in the jiveWorkflowApproval table for a given workflow.
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.
DESCRIPTION_ATTRIBUTE - Static variable in class com.jivesoftware.community.user.profile.ProfileField
 
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 interface com.jivesoftware.base.plugin.Plugin
Destroys the plugin.
destroy() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Shuts down all running plugins.
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.AvatarEventDispatcher
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.ProjectEventDispatcher
Destroy dispatcher.
destroy() - Static method in class com.jivesoftware.community.event.QuestionEventDispatcher
Destroy dispatcher.
destroy() - Method in class com.jivesoftware.community.event.ScheduledTaskEventDispatcher
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.TaskEventDispatcher
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.JiveManager
Notifies the manager to release any resources that may be holding on too.
destroy() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Destroys the application.
destroy(ServletContext) - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Destroys the web application.
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.
devPlugins - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 
DISABLED - Static variable in class com.jivesoftware.community.action.JiveActionSupport
An action return type that indicates that a given feature has been disabled and is not available to the end user.
disablePluginForField(RenderPlugin, JiveContentObject.Field) - Method in interface com.jivesoftware.community.renderer.RenderManager
Disables a plugin for a field
disableUser(User) - Method in interface com.jivesoftware.base.UserManager
Disable the given user
disableWidgetLayout(long) - Method in interface com.jivesoftware.community.widget.WidgetManager
Disables a WidgetLayout in the system: this prevents users from selecting the layout after a layout has been disabled but lets existing users of the layout continue to use the layout.
discardWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Discards the draft WidgetFrames for the specified parent JiveObject.
discardWidgetLayout(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Discards the draft WidgetLayout 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(AnnouncementEvent) - Method in class com.jivesoftware.community.event.AnnouncementEventDispatcher
 
dispatchEvent(AttachmentEvent) - Method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
dispatchEvent(AvatarEvent) - Method in class com.jivesoftware.community.event.AvatarEventDispatcher
 
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(JiveEvent) - Method in class com.jivesoftware.community.event.ProjectEventDispatcher
 
dispatchEvent(QuestionEvent) - Method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
dispatchEvent(ScheduledTaskEvent) - Method in class com.jivesoftware.community.event.ScheduledTaskEventDispatcher
 
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.TaskEventDispatcher
 
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.
DISPLAY_NAME_ATTRIBUTE - Static variable in class com.jivesoftware.community.user.profile.ProfileField
 
Document - Interface in com.jivesoftware.community
A Document object encapsulates a document in Clearspace.
DOCUMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT - Static variable in class com.jivesoftware.community.util.SkinUtils.FileType
 
DOCUMENT_ADDED - Static variable in class com.jivesoftware.community.event.DocumentEvent
Event type for whenever a document is added to a container.
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 container.
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 container.
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.
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.
DocumentEvent - Class in com.jivesoftware.community.event
A class for Document events.
DocumentEvent(int, Document, JiveContainer, 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.
documentExpireWarning(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is about to expire.
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.
documentMoved(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a document is moved.
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.
documentRelatedObjectAdded(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a related document is added to a document.
documentRelatedObjectDeleted(DocumentEvent) - Method in interface com.jivesoftware.community.event.DocumentListener
Fired when a related document is deleted from a document.
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.
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.
doInitialize() - Static method in class com.jivesoftware.community.renderer.RendererFactory
 
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.
DUE_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
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
 
duplicateWidgetFrames(JiveObject, JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Duplicates the WidgetFrames from the source JiveObject to the destination JiveObject.
dwrWikiConversionBean - Variable in class com.jivesoftware.community.action.JiveActionSupport
 

E

EDIT_AVATAR - Static variable in class com.jivesoftware.community.Permissions
Permission to create and delete avatars
editAndApprove(ForumMessage, String, String, String) - Method in interface com.jivesoftware.community.OldModerationManager
Edit and approve a moderated message
EDITING_USER - Static variable in class com.jivesoftware.community.event.BlogPostEvent
User who edited the post, not necessarily the author.
editProfileField(ProfileField) - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Edits the profile field data.
editProfileFieldOptions(ProfileField) - Method in interface com.jivesoftware.community.user.profile.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_VISIBILITY_ALLOW_TOGGLE - Static variable in interface com.jivesoftware.base.User
A JiveProperty key to get the setting for allowing the user to choose email address visiblity.
EMAIL_VISIBILITY_DEFAULT - Static variable in interface com.jivesoftware.base.User
A JiveProperty key to get the default setting for email address visiblity.
EMAIL_WATCH - Static variable in interface com.jivesoftware.community.Watch
Email watch type.
EmailAlreadyExistsException - Exception in com.jivesoftware.base
Thrown when attempting to create a user with an email that is already in use by a different user.
EmailAlreadyExistsException() - Constructor for exception com.jivesoftware.base.EmailAlreadyExistsException
 
EmailAlreadyExistsException(String) - Constructor for exception com.jivesoftware.base.EmailAlreadyExistsException
 
EmailAlreadyExistsException(String, Throwable) - Constructor for exception com.jivesoftware.base.EmailAlreadyExistsException
 
EmailAlreadyExistsException(Throwable) - Constructor for exception com.jivesoftware.base.EmailAlreadyExistsException
 
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
 
emailResetPasswordInstructions(String, HttpServletRequest) - Static method in class com.jivesoftware.community.util.SkinUtils
This method will send the user specified an email with instructions on how to reset their password.
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.
enablePluginForField(RenderPlugin, JiveContentObject.Field) - Method in interface com.jivesoftware.community.renderer.RenderManager
Enables a plugin for a field
enableUser(User) - Method in interface com.jivesoftware.base.UserManager
Enable the given user
ENTITLEMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
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.
equals(Object) - Method in class com.jivesoftware.base.event.GroupEvent
 
equals(Object) - Method in class com.jivesoftware.base.UserTemplate
 
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.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.project.CheckPoint
 
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(Object) - Method in class com.jivesoftware.community.ResultFilter
 
equals(SearchQuery) - Method in interface com.jivesoftware.community.SearchQuery
Return true if the query is equal to the current query, false otherwise.
equals(Object) - Method in class com.jivesoftware.community.TagResultFilter
 
equals(Object) - Method in class com.jivesoftware.community.ThreadResultFilter
 
equals(Object) - Method in class com.jivesoftware.community.user.profile.ProfileField
 
equals(Object) - Method in class com.jivesoftware.community.widget.WidgetDescriptor
 
equals(Object) - Method in class com.jivesoftware.community.widget.WidgetLayoutDescriptor
 
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.
ERROR_TEMPLATE_FILE - Static variable in class com.jivesoftware.community.widget.BaseWidget
 
eventDispatcher - Variable in class com.jivesoftware.base.plugin.PluginManagerImpl
 
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
 
execute() - Method in class com.jivesoftware.community.JiveGlobals.ResetLocalizationSettingsClusterTask
 
execute(Document, RenderContext) - Method in interface com.jivesoftware.community.renderer.RenderFilter
Process the xml document that is passed to this method.
execute(Element, RenderContext) - Method in interface com.jivesoftware.community.renderer.RenderMacro
Applies the filter to the passed in string and returns the filtered string.
execute() - Method in class com.jivesoftware.community.xmpp.IMManager.ConcurrentConnectionCheckClusterTask
 
execute() - Method in class com.jivesoftware.community.xmpp.IMManager.ConcurrentPresenceInitCheckClusterTask
 
execute() - Method in class com.jivesoftware.community.xmpp.IMManager.LocalRestartTask
 
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

FATAL_EVENT - Static variable in class com.jivesoftware.base.event.LogEvent
Event type for whenever a fatal log event occurs.
FEATURE_DISABLED_FILE - Static variable in class com.jivesoftware.community.widget.BaseWidget
 
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.
filterDocument(Document) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
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.
filterPendingMessages(Iterator<ForumMessage>) - Static method in class com.jivesoftware.community.util.SkinUtils
Assumes index of iterator is at front of iterator (ie, iterator hasn't been used).
fine(Throwable) - Static method in class com.jivesoftware.base.Log
 
fine(String, Throwable) - Static method in class com.jivesoftware.base.Log
 
finishCallback(Long, JiveObject) - Method in interface com.jivesoftware.community.moderation.ModerationStrategy
Handles the finish call back.
finishContextRefresh(SpringJiveContextImpl) - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
This is called by the SpringJiveContextImpl when the context is done initializing but before any Spring contextRefresh events are fired, so calls done on that event don't wind up with a null JiveApplication.getContext() reference.
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
 
format(String, User) - Method in interface com.jivesoftware.community.DocumentFieldFormatter
Format a document 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.
formatDate(HttpServletRequest, User, Date) - Static method in class com.jivesoftware.community.util.SkinUtils
Formats a date for a user, according to their locale and time zone preferences.
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
 
freemarkerManager - Variable in class com.jivesoftware.community.widget.BaseWidget
 

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
 
generateNonce() - Method in class com.jivesoftware.community.xmpp.IMManager
Generates a new nonce.
getAbuseManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an abuse manager that can be used for managing abuse reports
getAbuseReport(long) - Method in interface com.jivesoftware.community.AbuseManager
Gets an abuse report associated with an id
getAbuseReports(JiveObject) - 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
message-abuse.jspa 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
getActionMappingName() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the current struts context's action mapping name as defined in the struts configuration file.
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.
getAdminConsoleInterface() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the interface where OF's admin console is listening
getAdminConsolePort() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the port where OF's admin console is listening
getAdminConsoleSecurePort() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the secure port where OF's admin console is listening
getAdminEmail() - Method in interface com.jivesoftware.community.EmailManager
 
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
 
getAllActiveRelationships(UserRelationshipManagerImpl.UserRelationshipResultFilter) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of active user relationships for a given graph (for admin console purposes).
getAllowedParameters() - Method in class com.jivesoftware.community.renderer.BaseMacro
return a list of all parameters allowed by this macro
getAllowedParameters() - Method in interface com.jivesoftware.community.renderer.RenderMacro
return a list of all parameters allowed by this macro
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 com.jivesoftware.community.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(JiveContainer) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the count of all currently viewable announcements in a container.
getAnnouncementCount(JiveContainer, boolean) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the count of all currently viewable announcements in a container.
getAnnouncementCount(JiveContainer, 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.
getAnnouncementManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an announcement manager, which is used to create and retrieve announcements.
getAnnouncements(JiveContainer) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns all currently viewable announcements in a container.
getAnnouncements(JiveContainer, Date, Date) - Method in interface com.jivesoftware.community.AnnouncementManager
Returns the announcements in a container that are viewable within a specified date range.
getAnnouncment() - Method in class com.jivesoftware.community.event.AnnouncementEvent
Returns the Announcement that the event corresponds to.
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.
getApplicationState() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
 
getApplicationUserCount() - Method in interface com.jivesoftware.base.UserManager
Returns the number of application users in the system.
getApplicationUsers() - Method in interface com.jivesoftware.base.UserManager
Returns a list of application users - users who have active accounts and can authenticate with the system.
getApplicationUsers(int, int) - Method in interface com.jivesoftware.base.UserManager
Returns a list of enabled application users from start to end params.
getApprovalManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an approval manager, which is manage approval workflows.
getApprovalStatus() - Method in interface com.jivesoftware.community.Document
Returns a collection of ApprovalStatus objects.
getApprovalViewForUserRelationship(UserRelationship, long) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Create a specific view for a relationship depending on who is requesting the view.
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.
getApproverContainers(int, long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Returns a list of container IDs for the given approver.
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.
getApproverUserIDs(User, UserRelationship) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
 
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.
getAtomId() - Method in enum com.jivesoftware.community.Permissions.PermissionAtom
 
getAttachment(long) - Method in interface com.jivesoftware.community.AttachmentManager
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
 
getAttachmentContentResource() - Method in interface com.jivesoftware.community.Attachment
Returns the AttachmentContentResource of the attachment.
getAttachmentContentResource() - 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(AttachmentContentResource) - Method in interface com.jivesoftware.community.AttachmentManager
Returns the number of attachments the object 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(AttachmentContentResource) - Method in interface com.jivesoftware.community.AttachmentManager
Returns an Iterable for the object's attachments.
getAttachments() - Method in class com.jivesoftware.community.EmailMessage
Returns the attachments of the email
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
 
getAuthenticatedUserCount() - Method in interface com.jivesoftware.base.UserManager
Returns the number of application users in the system who have authenticated at least once.
getAuthenticationManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the authentication manager configured by the application.
getAuthenticationProvider() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getAuthenticationProvider() - Method in interface com.jivesoftware.community.JiveContext
Returns the authentication provider for the current execution context.
getAuthenticationProvider() - Method in class com.jivesoftware.community.xmpp.IMManager
 
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() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getAuthToken() - Method in class com.jivesoftware.community.widget.BaseWidgetContext
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.SearchManager
Returns the number of minutes that the indexer waits between each update.
getAutoIndexInterval() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
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.
getAvailableContentTypes() - Method in interface com.jivesoftware.community.JiveContainer
Gets an array of ContentRetrieval.ContentTypes that are available for use by this container type
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.
getAvailableWidgetLayouts() - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns a list of all the WidgetLayouts in the system that have not been disabled.
getAvailableWidgets() - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns a list of all available Widgets in the system.
getAvailableWidgets(WidgetContext) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns a list of all available Widgets that are enabled for the given widget context.
getAvatar(long) - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire an avatar by its id
getAvatar() - Method in class com.jivesoftware.community.event.AvatarEvent
Returns the Avatar that the event corresponds to.
getAvatarCount(User) - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire a count of all the avatars for a specific user
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
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
Deprecated. Will return null if multiple entries are found. Use BanManager.getBans(BanFilter) instead.
getBan(String, BanLevel) - Method in interface com.jivesoftware.community.BanManager
Deprecated. Will return null if multiple entries are found. Use BanManager.getBans(BanFilter) instead.
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
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
getBansCount(BanFilter) - Method in interface com.jivesoftware.community.BanManager
Gets a count of the filtered list of Ban objects from the database
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.
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(JiveContainer) - Method in interface com.jivesoftware.community.BlogManager
Returns the blog for the given container.
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.
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 = JiveContentObject.Status.PUBLISHED 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 = JiveContentObject.Status.PUBLISHED 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(JiveContainer) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts associated with this container.
getBlogPostCount(JiveContainer, BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts in all blogs associated with the container based on the specified ResultFilter.
getBlogPostCount(TagSet) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts associated with this tag set.
getBlogPostCount(TagSet, BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of blog posts in all blogs associated with the tag set 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(JiveContainer) - Method in interface com.jivesoftware.community.BlogManager
Returns the blog posts associated with this container.
getBlogPosts(JiveContainer, BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the blog posts in all blogs associated with the container based on the specified ResultFilter.
getBlogPosts(TagSet) - Method in interface com.jivesoftware.community.BlogManager
Returns the blog posts associated with this tag set based on the specified ResultFilter.
getBlogPosts(TagSet, BlogPostResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the blog posts associated with this container.
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.
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.
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, boolean) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the URL for the blog as either a fully qualified URL or as a relative resource depending on the absolute parameter.
getBlogURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the URL for the blog as a fully-qualified path based on jiveHome.
getBlogURL(Blog, String) - 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.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.
getBooleanProperty(K) - Method in interface com.jivesoftware.community.JiveProperties
 
getBooleanProperty(K, boolean) - Method in interface com.jivesoftware.community.JiveProperties
 
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.
getBrokenPlugins() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns a list of broken plugins, mapped to what the cause of the breakage was.
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
getById(int) - Static method in enum com.jivesoftware.base.User.Status
 
getCachedSize() - Method in class com.jivesoftware.base.UserTemplate
 
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 enum com.jivesoftware.community.JiveContentObject.Status
 
getCachedSize() - Method in class com.jivesoftware.community.Permissions
 
getCachedSize() - Method in class com.jivesoftware.community.project.CheckPoint
 
getCachedSize() - Method in class com.jivesoftware.community.user.profile.ProfileField
Returns the estimated cache size of this object by calculating the size of each field.
getCachedSize() - Method in class com.jivesoftware.community.user.profile.ProfileFieldOption
Returns the esitmated cache size of this obejct by calculating the size of each field.
getCalendarFileName() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the name of the localized javascript filename for the current locale for use within the datetime picker.
getCalendarOverrideFormat() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the name of the localized javascript override filename for the current locale for use within the datetime picker.
getCanCreateSocialGroup() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getCharacterEncoding() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the character set that Jive uses for encoding.
getCheckPoints() - Method in interface com.jivesoftware.community.project.Project
Returns a list of checkpoints for the project
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.PluginManagerImpl
Returns a collection of all plugin classloaders.
getClassName() - Method in class com.jivesoftware.community.widget.WidgetDescriptor
Returns the classname of the widget
getClassName() - Method in class com.jivesoftware.community.widget.WidgetLayoutDescriptor
Returns the classname of the widget layout
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.
getColleagues(User, HierarchicalUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of a user's colleagues (people who report to the same manager, minus the user) (may return empty list, but not null).
getCombinedContent(JiveContainer, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for all threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContent(TagSet, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for all threads, documents, and blog posts in the tag set, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContent(JiveContainer, ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for all threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument, and according the the supplied ResultFilter.
getCombinedContent(TagSet, ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for all threads, documents, and blog posts in the tag set, depending on which ContentRetrieval.ContentTypes are supplied as an argument, and according the the supplied ResultFilter.
getCombinedContentCount(JiveContainer, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns the combined number of threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContentCount(TagSet, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns the combined number of threads, documents, and blog posts in the tag, depending on which ContentRetrieval.ContentTypes are supplied as an argument.
getCombinedContentCount(JiveContainer, ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns the combined number of threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument, and restricted by the ResultFilter.
getCombinedContentCount(TagSet, ResultFilter, ContentRetrieval.ContentType...) - Method in interface com.jivesoftware.community.CommunityManager
Returns the combined number of threads, documents, and blog posts in the tag set, 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(long) - Method in interface com.jivesoftware.community.CommentManager
Returns a comment from the object based on its id.
getComment(CommentContentResource, 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.
getCommentContentResource() - Method in interface com.jivesoftware.community.Comment
Returns the parent CommentContentResource of the comment.
getCommentContentResource(Comment) - Method in interface com.jivesoftware.community.CommentManager
Returns the parent CommentContentResource of the comment.
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(CommentContentResource) - Method in interface com.jivesoftware.community.CommentManager
Returns the number of comments in the object.
getCommentCount(CommentContentResource, 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(CommentContentResource) - Method in interface com.jivesoftware.community.CommentManager
Returns an iterable for all the comments in the object.
getComments(CommentContentResource, 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(CommentContentResource) - Method in interface com.jivesoftware.community.CommentManager
Convenience method that return the date that the first comment was created.
getCommentsModificationDate(CommentContentResource) - 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(CommentContentResource) - 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.
getCommonFileExtensionName(String) - Static method in class com.jivesoftware.community.util.SkinUtils
Get the file type of a given file name.
getCommunities(Community) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for the child communities of the specified community.
getCommunities(Community, int, int) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for the child communities of this community using a start index and the number of results to return.
getCommunity(long) - Method in interface com.jivesoftware.community.CommunityManager
Returns the Community with the supplied communityID.
getCommunity() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getCommunity() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Gets the community used for this query.
getCommunity() - Method in class com.jivesoftware.community.widget.CommunityWidgetContext
Get the community from the widget context.
getCommunityCount(Community) - Method in interface com.jivesoftware.community.CommunityManager
Returns the number of sub-communities under the specified community.
getCommunityDepth(Community) - Method in interface com.jivesoftware.community.CommunityManager
Returns the depth of a 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.
getCommunityManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a community manager which is used to access community wide resources
getConfig() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getConfigurationFiles() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Returns the current set of Spring configuration files underlying the Jive application.
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.
getContainerApprovers(int, long) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Returns a list of user IDs for all the container level document approvers.
getContainerID() - Method in interface com.jivesoftware.community.ForumMessage
Returns the id of the container object of the message.
getContainerID() - Method in interface com.jivesoftware.community.ForumThread
Returns the id of the container object of the thread.
getContainerID() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the system ID of the parent object.
getContainerID() - Method in class com.jivesoftware.community.project.CheckPoint
 
getContainerID() - Method in class com.jivesoftware.community.widget.WidgetFrame
Gets the id of the container
getContainerID() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the id of the container
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.Poll
Returns the object ID of the container that 'contains' the poll.
getContainerObjectType() - Method in interface com.jivesoftware.community.Poll
Returns the object type of the container that 'contains' the poll.
getContainers() - Method in interface com.jivesoftware.community.OldModerationManager
This method will return a list of containers where the user is a moderator.
getContainerType() - Method in interface com.jivesoftware.community.ForumMessage
Returns the type of the container object of the message.
getContainerType() - Method in interface com.jivesoftware.community.ForumThread
Returns the type of the container object of the thread.
getContainerType() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the type of the parent object.
getContainerType() - Method in class com.jivesoftware.community.project.CheckPoint
 
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.JiveContainer
Gets an array of ContentRetrieval.ContentTypes that are enabled for this container.
getContentTypesFromValue(long) - Static method in enum com.jivesoftware.community.ContentRetrieval.ContentType
 
getContentTypesFromValue(long) - Static method in enum com.jivesoftware.community.TagManager.Taggable
 
getContext() - Method in class com.jivesoftware.community.EmailMessage
Returns a map of replacement tokens to use in the email
getContext() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Returns the raw jive context (spring context).
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.
getContributors() - Method in interface com.jivesoftware.community.Blog
Returns an alpha-sorted set of all users who have contributed to the blog.
getConverter() - Method in enum com.jivesoftware.community.user.profile.ProfileField.Type
Gets the field value type converter for this type.
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 class com.jivesoftware.base.UserTemplate
 
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.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.JiveContainer
Returns the Date that the container 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 class com.jivesoftware.community.project.CheckPoint
 
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.
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.
getCssClass() - Method in interface com.jivesoftware.community.widget.WidgetLayout
Returns a custom css class for the widget layout preview, or null if a custom css class does not exist.
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).
getCurrentCount() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns the number of entries that have been indexed if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getCurrentRelationshipMap(User, boolean) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a map of relationship views revolving around the user argument.
getCurrentRelationships(User, UserRelationshipGraph, boolean) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a collection of relationship views revolving around the user argument.
getCustomFields() - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Returns a list of all profile fields added by the administrator.
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, or null if the attachment is scheduled for virus scanning, and has not yet been scanned.
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.AvatarEvent
 
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.ProjectEvent
 
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.TaskEvent
 
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.PrivateMessage
Returns the date the message was saved or sent, or null if the message hasn't been sent or saved yet.
getDecoratedDocumentElementName() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getDefaultAvatarID() - Method in interface com.jivesoftware.community.AvatarManager
Retrieves the ID of the system default avatar, default is -1.
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.
getDefaultFields() - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Returns a list of all default profile fields.
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.
getDefaultHierarchicalRelationshipGraph() - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Find the default (primary) HierarchicalUserRelationshipGraph.
getDefaultMeshRelationshipGraph() - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Find the default (primary) MeshUserRelationshipGraph.
getDefaultParameterValue(Element, boolean) - Method in class com.jivesoftware.community.renderer.BaseMacro
 
getDefaultParameterValue(Element) - Method in class com.jivesoftware.community.renderer.BaseMacro
 
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.
getDeletedDocumentVersion() - Method in interface com.jivesoftware.community.VersionManager
Convenience method which returns the deleted document version.
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.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.JiveContainer
Returns the description of the container.
getDescription() - Method in interface com.jivesoftware.community.Poll
Returns a brief description of the poll.
getDescription() - Method in class com.jivesoftware.community.project.CheckPoint
 
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(String) - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the description of this profile field for the specified locale
getDescription() - Method in enum com.jivesoftware.community.user.profile.ProfileField.Type
Gets the description of this type.
getDescription(WidgetContext) - Method in interface com.jivesoftware.community.widget.Widget
Returns the default description of the widget
getDescriptionKey() - Method in class com.jivesoftware.community.user.profile.ProfileField
 
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.PluginManagerImpl
Returns a set of all the plugins that have been specified with -DpluginDirs system property
getDirectReports(User, HierarchicalUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of a user's direct reports (may return empty list, but not null).
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.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 interface com.jivesoftware.community.JiveContainer
Returns the display name of the container.
getDisplayName(String) - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the display name of this profile field for the specified locale.
getDisplayName() - Method in enum com.jivesoftware.community.user.profile.ProfileField.Type
Gets the displayName of this type.
getDisplayName(User) - Static method in class com.jivesoftware.community.util.SkinUtils
A simple method to check whether to display a user's full name or their username.
getDisplayNameKey() - Method in class com.jivesoftware.community.user.profile.ProfileField
 
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 container 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(JiveContainer, String) - Method in interface com.jivesoftware.community.DocumentManager
Returns a document from a container 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.user.profile.ProfileSearchResult
Gets the search Document for this user.
getDocumentAdditionClassname() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getDocumentApprovers(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
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(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns the number of published documents in the container.
getDocumentCount(TagSet) - Method in interface com.jivesoftware.community.DocumentManager
Returns the number of published documents in the tag set.
getDocumentCount(JiveContainer, DocumentResultFilter) - Method in interface com.jivesoftware.community.DocumentManager
Returns the number of documents in the container {and possibly all child containers (if the container is a community)} based on the specified ResultFilter.
getDocumentCount(TagSet, DocumentResultFilter) - Method in interface com.jivesoftware.community.DocumentManager
Returns the number of documents in the tag set based on the specified ResultFilter.
getDocumentDeletionClassname() - Static method in class com.jivesoftware.community.util.SkinUtils
 
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(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable for all the published documents in the container.
getDocuments(TagSet) - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable for all the published documents in the tag set.
getDocuments(JiveContainer, DocumentResultFilter) - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable for all the documents in the container {and possibly all child containers (if the container is a community)} that match the criteria specified by the ResultFilter.
getDocuments(TagSet, DocumentResultFilter) - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable for all the documents in the tag set that match the criteria specified by the ResultFilter.
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.
getDocumentShareManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the document share manager.
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.DocumentManager
Returns an Iterable of documents currently being editted.
getDocumentsUnderEdit(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns the count of the number of documents currently being editted in the container.
getDocumentsUnderEditCount() - Method in interface com.jivesoftware.community.DocumentManager
Returns the count of the number of documents currently being editted.
getDocumentsUnderEditCount(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns an Iterable of documents currently being editted in the container.
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.
getDueDate() - Method in class com.jivesoftware.community.project.CheckPoint
 
getDueDate() - Method in interface com.jivesoftware.community.project.Project
Returns the due date for the project upon which all contained tasks should be completed
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
getEffectiveContext() - Static method in class com.jivesoftware.community.lifecycle.JiveApplication
Returns a jive context with the appropriate permissions of the effective user (which is not necessarily the same as the authenticated user.
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 class com.jivesoftware.base.UserTemplate
 
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
 
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
 
getEnabledFields(RenderPlugin) - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns a list of fields that are enabled for a plugin
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.
getEntitlementManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an entitlement manager used to modify permissions.
getEntitlementProvider() - Method in interface com.jivesoftware.community.JiveContext
Returns a provider for authorization information.
getErrorType() - Method in exception com.jivesoftware.community.AttachmentException
 
getErrorType() - Method in exception com.jivesoftware.community.BinaryBodyException
 
getErrorType() - Method in exception com.jivesoftware.community.ImageException
 
getEscalationChain(User, HierarchicalUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Build a list of people upward in the hierarchical org from a given user.
getEventDispatcher() - Method in interface com.jivesoftware.community.JiveContext
Returns the eventDispatcher for firing events.
getEventListenerRegistry() - Method in interface com.jivesoftware.community.JiveContext
Returns the eventListenerRegistry for registering and un registering listeners.
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.AvatarEvent
 
getEventType() - Method in class com.jivesoftware.community.event.BlogEvent
 
getEventType() - Method in class com.jivesoftware.community.event.BlogPostEvent
 
getEventType() - Method in class com.jivesoftware.community.event.CommentEvent
 
getEventType() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getEventType() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getEventType() - Method in class com.jivesoftware.community.event.EmailEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ImageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.MessageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.PollEvent
 
getEventType() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ProfileEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ProjectEvent
 
getEventType() - Method in class com.jivesoftware.community.event.QuestionEvent
 
getEventType() - Method in class com.jivesoftware.community.event.SearchIndexEvent
 
getEventType() - Method in class com.jivesoftware.community.event.StorageManagerEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TagEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TagSetEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TaskEvent
 
getEventType() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getEventType() - Method in class com.jivesoftware.community.event.TrackbackEvent
 
getEventType() - Method in class com.jivesoftware.spi.ServiceEvent
Return the enum that denotes the event type.
getEveryoneQuery() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Return a Lucene query string to find all users in the system.
getExcerpt() - Method in interface com.jivesoftware.community.Trackback
Returns the excerpt of the trackback.
getExpirationDate() - Method in class com.jivesoftware.community.Ban
Gets the date this ban object will expire, or null if it is a permanent ban object.
getExpirationDate() - Method in interface com.jivesoftware.community.Document
Returns the date that the document is set to expire on.
getExpirationDate() - Method in interface com.jivesoftware.community.Poll
Returns the date the poll should expire.
getExpirationDateRangeMax() - Method in class com.jivesoftware.community.BanFilter
Returns a date that represents the upper boundry for bans to be selected by the ban filter.
getExpirationDateRangeMax() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns a date that represents the upper boundry for documents to be selected by the result filter.
getExpirationDateRangeMin() - Method in class com.jivesoftware.community.BanFilter
Returns the expiration date that represents the lower boundary for bans to be filtered on.
getExpirationDateRangeMin() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns a date that represents the lower boundry for documents to be selected by the result filter.
getExternallyManagedFields() - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Returns a list of all profile fields whose values are pulled from an external system such as LDAP.
getExternalMapping() - Method in class com.jivesoftware.community.user.profile.ProfileField
Returns the external configuration data as a map of attribute name -> configuration string pairs.
getExternalMappings() - Method in class com.jivesoftware.community.user.profile.ProfileField
Returns the external configuration data as a map of attribute name -> configuration string pairs.
getExternalMappingString() - Method in class com.jivesoftware.community.user.profile.ProfileField
Returns a string which contains external configuration data (such as an LDAP field name) which is used to pull the field value into the system.
getExternalSearchableURL(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the externral search URL with the {searchTerms} token substitued by the argument.
getExternalSearchURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get an OpenSearch compliant URL that can be queried against.
getFailureException() - Method in class com.jivesoftware.base.event.GroupEvent
Returns the exception that indicates why a listener failed to handle an event.
getFailureException() - Method in class com.jivesoftware.base.event.UserEvent
Returns the exception that indicates why a listener failed to handle an event.
getFailureException() - Method in class com.jivesoftware.community.event.ProfileEvent
Returns the exception that indicates why a listener failed to handle an event.
getFeedURL() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to a feed which contains recent posts across the entire system.
getFeedURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the feed which is a combination of the base URL, the blog display name and the default system feed type.
getFeedURL() - Method in class com.jivesoftware.community.widget.BaseWidget
 
getFeedURL() - Method in interface com.jivesoftware.community.widget.Widget
Returns the location of a feed for this widget or null if no feed exists.
getFieldID() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getFieldID() - Method in class com.jivesoftware.community.user.profile.ProfileFieldOption
Gets the id of the ProfileField in which this option belongs.
getFieldID() - Method in class com.jivesoftware.community.user.profile.ProfileSearchFilter
Gets the ID of the ProfileField used to filter the user results.
getFieldType() - Method in interface com.jivesoftware.community.DocumentField
Returns the DocumentFieldType associated with this DocumentField.
getFile() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getFilter(String) - Method in interface com.jivesoftware.community.SearchQueryManager
Returns a cached filter assocaited with the related key.
getFilterableFields() - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Returns a list of all filterable profile fields.
getFilteredBlog() - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Returns the blog that query results are restricted to.
getFilteredDocumentType() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns a DocumentType that query results are restricted to.
getFilteredProject() - Method in interface com.jivesoftware.community.TaskSearchQueryCriteria
Returns the project that query results are restricted to.
getFilteredTagSets() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns a collection of TagSets that query results are restricted to.
getFilteredThread() - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Returns the thread that query results are restricted to.
getFilteredUser() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the user that query results are restricted to.
getFilters() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Gets a list of ProfileSearchFilters used to filter user results for this query.
getFilterTags() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns a list of tags for all the currently configured render filters which implement the TagFilter interface.
getFinalGroupPerms(int, long, long, PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Returns the Permissions object that corresponds to the permissions that a group has for a particular object.
getFinalLocale() - Method in interface com.jivesoftware.community.Community
Returns the locale for this community.
getFinalUserPerms(int, long, long, PermissionType) - Method in interface com.jivesoftware.community.PermissionsManager
Returns the Permissions object that corresponds to the combined permissions that a user has for a particular object: Anonymous and "registered users" permissions.
getFirstName() - Method in interface com.jivesoftware.base.User
Returns the user's first name.
getFirstName() - Method in class com.jivesoftware.base.UserTemplate
 
getFirstPost() - Method in interface com.jivesoftware.community.Blog
Returns the first blog post on this blog.
getFolder() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the folder the private message or null if the message does not yet belong to a folder.
getFolder(User, long) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the specified folder for a user.
getFolderCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of folders the user has.
getFolders(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns an Iterable of PrivateMessageFolder objects for the folders the user has.
getFormatter() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the formatter for this document field type.
getForumManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a forum manager which can be used to access threads and messages
getForumThread(long) - Method in interface com.jivesoftware.community.ForumManager
Returns the thread with the specified threadID.
getForumThread() - Method in interface com.jivesoftware.community.ForumMessage
Returns the thread this message belongs to.
getForumThread() - Method in interface com.jivesoftware.community.Question
Returns the thread that the question is associated with.
getFreemarkerManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the jive freemarker manager.
getFreemarkerTemplate() - Method in interface com.jivesoftware.community.widget.WidgetLayout
Returns the path to the Freemarker template responsible for rendering this widget layout
getFriendRelationship(User, User, MeshUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
If two users have a relationship in a given graph, return it, else return null.
getFriends(User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get an list of a user's friends from the default mesh graph.
getFriends(User, MeshUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get an list of a user's friends in a given mesh graph.
getFromEmail() - Static method in class com.jivesoftware.community.util.BlogUtils
Get an available email address to use for outbound emails.
getFromName() - Static method in class com.jivesoftware.community.util.BlogUtils
Get an available from name to use for outbound emails.
getGatewayManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a gateway manager that can be used for managing gateways
getGlobalAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns a collection of all of the global avatars
getGlobalRenderManager() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getGroup() - Method in class com.jivesoftware.base.event.GroupEvent
 
getGroup(long) - Method in interface com.jivesoftware.base.GroupManager
Gets a Group by ID.
getGroup(String) - Method in interface com.jivesoftware.base.GroupManager
Gets a Group by name.
getGroup(long, boolean) - Method in interface com.jivesoftware.base.GroupManager
Loads a group by id, optionally forcing a direct lookup in the system of record if the force parameter is true.
getGroup() - Method in interface com.jivesoftware.community.StatusLevel
The group this status level is associated with.
getGroupCount() - Method in interface com.jivesoftware.base.GroupManager
Returns the total number of groups in the system.
getGroupManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a group manager that can be used to manage groups.
getGroups() - Method in interface com.jivesoftware.base.GroupManager
Returns an iterator for all groups in the system.
getGroups(int, int) - Method in interface com.jivesoftware.base.GroupManager
Returns an iterator for all groups starting at startIndex with the given number of results.
getGroupStatusLevels() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an iterable of all group based status levels in the system.
getGuestProperty(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a guest property.
getHelpfulAnswers() - Method in interface com.jivesoftware.community.Question
Returns a read-only Collection of ForumMessage objects that have been marked as helpful.
getHelpfulAnswersPerThread() - Method in interface com.jivesoftware.community.QuestionManager
Returns the number of helpful answers allowed per question.
getHtmlBody() - Method in class com.jivesoftware.community.EmailMessage
Returns the html version of the body
getHtmlBodyProperty() - Method in class com.jivesoftware.community.EmailMessage
 
getHttpBindSecureUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the secure URL on which it can be reached.
getHttpBindUnsecureUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the unsecure URL on which it can be reached.
getHttpBindUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
If the HTTP binding service is enabled on the RTC server, see IMManager.isHttpBindEnabled(), this method will return the URL on which it can be reached.
getHumanFriendlyDate(Date) - Static method in class com.jivesoftware.community.util.BlogUtils
Deprecated. Replaced by DateUtils#displayFriendly(long)
getIcon() - Method in class com.jivesoftware.community.renderer.BaseMacro
 
getIcon() - Method in interface com.jivesoftware.community.renderer.RenderMacro
returns the relative path of the icon image.
getIcon(JiveObject, boolean, int) - Method in interface com.jivesoftware.community.util.IconGenerator
Fetch an icon for the given JiveObject, return null if the method declines to provide an icon and the SkinUtils implementation will delegate to the system default.
getIcon(String, boolean, int) - Static method in class com.jivesoftware.community.util.SkinUtils
Returns an icon string in the standard Jive format.
getIconURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the URL of an icon described in the descriptor file.
getID() - Method in interface com.jivesoftware.base.Group
Returns the id of the group.
getID() - Method in interface com.jivesoftware.base.User
Returns the user's id.
getId() - Method in enum com.jivesoftware.base.User.Status
 
getID() - Method in class com.jivesoftware.base.UserTemplate
 
getID() - Method in class com.jivesoftware.community.AbuseReport
Gets the unique ID of this abuse report.
getID() - Method in enum com.jivesoftware.community.Activity.Type
 
getID() - Method in class com.jivesoftware.community.Ban
Returns the unique ID that represents this ban object.
getID() - Method in interface com.jivesoftware.community.Blog
Returns the unique ID of the blog, or -1 if the blog hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.community.BlogPost
Returns the unique ID of this post, or -1 if the post hasn't been added to the database yet.
getID() - Method in enum com.jivesoftware.community.ContentRetrieval.ContentType
 
getID() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the ID of the document field option.
getId() - Method in enum com.jivesoftware.community.DocumentFieldType.DataType
 
getID() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns the id of this type
getID() - Method in class com.jivesoftware.community.EntityDescriptor
Returns the ID of this entity (object).
getID() - Method in interface com.jivesoftware.community.ForumMessage
Returns the id of this message, or -1 if this message hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.community.ForumThread
Returns the unique ID of this thread, or -1 if the thread hasn't been added to the database yet.
getID() - Method in interface com.jivesoftware.community.JiveObject
Retrieve the unique identifier for the jive object, or -1 if the object hasn't yet been added/inserted into the system.
getID() - Method in class com.jivesoftware.community.PermissionType
Returns the id of the PermissionType
getID() - Method in interface com.jivesoftware.community.Poll
Returns the unique ID of the poll.
getID() - Method in interface com.jivesoftware.community.Presence
Returns the unique ID for this status.
getID() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the id of the message.
getID() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the ID of the folder.
getID() - Method in class com.jivesoftware.community.project.CheckPoint
 
getID() - Method in enum com.jivesoftware.community.socialgroup.SocialGroup.Type
 
getID() - Method in enum com.jivesoftware.community.TagManager.Taggable
 
getID() - Method in interface com.jivesoftware.community.Trackback
Returns the id of this trackback, or -1 if this trackback hasn't been added to the database yet.
getID() - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the id representing this profile field.
getID() - Method in enum com.jivesoftware.community.user.profile.ProfileField.Type
Gets the id representing this type.
getID() - Method in class com.jivesoftware.community.widget.BaseWidget
 
getID() - Method in enum com.jivesoftware.community.widget.Widget.ContainerSize
 
getID() - Method in interface com.jivesoftware.community.widget.Widget
Gets the internal id of the widget
getID() - Method in class com.jivesoftware.community.widget.WidgetFrame
Gets the id of the WidgetFrame
getID() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the id of the WidgetFrame
getID() - Method in interface com.jivesoftware.community.widget.WidgetLayout
Gets the internal id of the widget layout
getIdentifiedObject() - Method in class com.jivesoftware.community.event.DocumentEvent
Return an EntityDescriptor if document is null and documentID is not.
getIdentifiedObject() - Method in class com.jivesoftware.community.event.MessageEvent
Return an EntityDescriptor if message is null and messageID is not.
getIdentifiedObject() - Method in class com.jivesoftware.community.event.TaskEvent
Return an EntityDescriptor if thread is null and threadID is not.
getIdentifiedObject() - Method in class com.jivesoftware.community.event.ThreadEvent
Return an EntityDescriptor if thread is null and threadID is not.
getImage() - Method in class com.jivesoftware.community.event.ImageEvent
 
getImage(long) - Method in interface com.jivesoftware.community.ImageContentResource
Returns the image corresponding to the imageID.
getImage(long) - Method in interface com.jivesoftware.community.ImageManager
Returns an image given the image id.
getImageClassname() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getImageCount() - Method in interface com.jivesoftware.community.ImageContentResource
Returns the number of images the object has.
getImageDeletionClassname() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getImageDirectorySize() - Method in interface com.jivesoftware.community.StorageManager
Returns the size (in bytes) of the image directory on the file system.
getImageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an image manager that can be used to manage image settings.
getImageMaxHeight() - Method in interface com.jivesoftware.community.ImageManager
Returns the max height of images that will be displayed.
getImageMaxWidth() - Method in interface com.jivesoftware.community.ImageManager
Returns the max width of images that will be displayed.
getImagePath() - Method in interface com.jivesoftware.community.StatusLevel
Returns the relative path to the image.
getImagePreviewMaxSize() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getImagePreviewMaxSize() - Method in interface com.jivesoftware.community.ImageManager
Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getImages() - Method in interface com.jivesoftware.community.Draft
Returns a list of images for the draft, or an empty list if no images are associated with the draft.
getImages() - Method in interface com.jivesoftware.community.ImageContentResource
Returns an Iterable for the object's images.
getImageThumbNailClassname() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getImageUrlBuilder() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getIMManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the IMManager.
getIndex() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the index of the option in the list of options for the document field.
getIndex() - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the index of this profile field.
getIndex() - Method in class com.jivesoftware.community.user.profile.ProfileFieldOption
Gets the index of this option which represents the order in which the options will appear in the list.
getIndex() - Method in class com.jivesoftware.community.widget.WidgetFrame
Gets the index of this WidgetFrame in the specified container, the index is zero based.
getIndex() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the index of this WidgetFrame in the specified container.
getIndexContent() - Method in interface com.jivesoftware.community.JiveContentObject
Returns a collection of fields that can be used to index this content object.
getIndexOfChild(Comment, Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the index of child in parent.
getIndexOfChild(ForumMessage, ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the index of child in parent.
getInstalledWidgets() - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the set of all installed widgets.
getInstance() - Static method in class com.jivesoftware.base.event.GroupEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.base.event.JivePropertyEventDispatcher
Returns an instance of JivePropertyEventDispatcher
getInstance() - Static method in class com.jivesoftware.base.event.LogEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.base.event.UserEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.base.plugin.PluginManagerImpl
This method had to be created in order to perform operations on plugins that must happen before spring initializes inside of the JiveApplicationContextLoader
getInstance() - Static method in class com.jivesoftware.community.event.AnnouncementEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.AttachmentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.AvatarEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.BlogEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.BlogPostEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.CommentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.CommunityEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.DocumentEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.EmailEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ImageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.MessageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.PollEventDispatcher
Returns an event dispatcher instance.
getInstance() - Static method in class com.jivesoftware.community.event.PrivateMessageEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ProfileEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ProfileSearchIndexEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ProjectEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.QuestionEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.SearchIndexEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.StorageManagerEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TagEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TagSetEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TaskEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.ThreadEventDispatcher
 
getInstance() - Static method in class com.jivesoftware.community.event.TrackbackEventDispatcher
 
getInstance(RenderTarget) - Static method in class com.jivesoftware.community.renderer.RendererFactory
Returns an implementation of the Renderer interface.
getInterceptor(int) - Method in interface com.jivesoftware.community.InterceptorManager
Return the interceptor at the specified index in the list of currently configured interceptors.
getInterceptorCount() - Method in interface com.jivesoftware.community.InterceptorManager
Returns the count of currently active interceptors.
getInterceptorManager() - Method in interface com.jivesoftware.community.BlogManager
Returns an interceptor manager that can be used to manage interceptors for all the blogs in the system.
getInterceptorManager() - Method in interface com.jivesoftware.community.JiveContainer
Returns an interceptor manager that can be used to manage the interceptors for this container.
getInterceptorManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an interceptor manager that can be used to manage global interceptors.
getInterceptorManager() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getInternalID() - Method in class com.jivesoftware.community.widget.WidgetDescriptor
Returns the internal id of the widget
getInternalID() - Method in class com.jivesoftware.community.widget.WidgetLayoutDescriptor
Returns the internal id of the widget layout
getInternalQuery() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Get the internal query used by the search mechanism.
getIntProperty(K, int) - Method in interface com.jivesoftware.community.JiveProperties
 
getIntValue() - Method in enum com.jivesoftware.community.moderation.JiveObjectModerator.Type
The int value that represents the type.
getInverseFriends(User, MeshUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of who has friended a user, for a non-reflexive graph.
getInvitationManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a manager for controlling invitations
getIpAddress() - Method in class com.jivesoftware.community.Ban
Gets the IP address that is banned.
getIpAddress() - Method in class com.jivesoftware.community.BanFilter
Gets the currently selected IP address that bans will be filtered on.
getIPAddress() - Method in interface com.jivesoftware.community.Comment
Returns the IP address of the person that authored this comment.
getIPAddress() - Method in interface com.jivesoftware.community.Presence
Returns the IP address of the user.
getIPAddress() - Method in interface com.jivesoftware.community.Trackback
Returns the IP address of the person that authored this comment.
getIqDiscoHandler() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJavaScriptUrl() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJIDForUser(User) - Method in class com.jivesoftware.community.xmpp.IMManager
 
getJiveBooleanProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as a boolean or returns false if the property doesn't exist or isn't parseable.
getJiveBooleanProperty(String, boolean) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as a boolean or returns defaultValue if the property doesn't exist or isn't parseable.
getJiveContainer() - Method in interface com.jivesoftware.community.Blog
Returns the parent container to which this blog belongs.
getJiveContainer() - Method in interface com.jivesoftware.community.Comment
Returns the container object of the document.
getJiveContainer() - Method in interface com.jivesoftware.community.Document
Returns the container object of the document.
getJiveContainer() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getJiveContainer() - Method in class com.jivesoftware.community.event.MessageEvent
 
getJiveContainer() - Method in class com.jivesoftware.community.event.PollEvent
 
getJiveContainer() - Method in class com.jivesoftware.community.event.TaskEvent
 
getJiveContainer() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getJiveContainer() - Method in interface com.jivesoftware.community.ForumMessage
Returns the container object of the message.
getJiveContainer() - Method in interface com.jivesoftware.community.ForumThread
Returns the container object of the thread.
getJiveContainer() - Method in interface com.jivesoftware.community.TagSet
Returns the JiveContainer to which this TagSet is bound.
getJiveContainerManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a jive container manager which can be used to load and update jive container objects.
getJiveContentObject() - Method in interface com.jivesoftware.community.Image
Returns the parent JiveContentObject of the image.
getJiveContentObject() - Method in interface com.jivesoftware.community.Trackback
Returns the JiveContentObject this trackback belongs to.
getJiveContext() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns a JiveContext object providing access to the clearspace api.
getJiveContext() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getJiveContext() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the jive context under which the filter is executing.
getJiveHome() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the location of the jiveHome directory.
getJiveI18nTextManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a jive i18n text manager which is used to manage internationalization text of various objects.
getJiveIntProperty(String, int) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the specified Jive property as an integer or returns the defaultValue if the property does't exist or the value isn't a number.
getJiveLinkBuilder() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getJiveManager(Class<U>) - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of a manager if one exists for the specified class.
getJiveObject() - Method in class com.jivesoftware.community.AbuseReport
Gets the forum message that caused this abuse report.
getJiveObject() - Method in interface com.jivesoftware.community.Activity
Returns the jive object this activity pertains to.
getJiveObject() - Method in class com.jivesoftware.community.event.ImageEvent
 
getJiveObject() - Method in exception com.jivesoftware.community.RejectedException
Returns the jive object that triggered the exception.
getJiveObject() - Method in interface com.jivesoftware.community.SearchQueryResult
This method returns a JiveContentObject this query result pertains to.
getJiveObjectIcon(JiveObject, boolean, int) - Static method in class com.jivesoftware.community.util.SkinUtils
Returns an icon path or a css class name for the icon to associate with the given jive object.
getJiveObjectID() - Method in interface com.jivesoftware.community.SearchQueryResult
Retrieve the unique id for the jive object this query result pertains to.
getJiveObjectLoader() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getJiveObjectModerator() - Method in interface com.jivesoftware.community.JiveContext
Returns a moderation manager that can be used for moderating messages
getJiveObjectType() - Method in interface com.jivesoftware.community.SearchQueryResult
Retrieve the type of the jive object this query result pertains to.
getJiveProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property values of a parent Jive property as a list of strings, or an empty list if there are no children.
getJiveProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns the value of the specified property or null if the value doesn't exist.
getJiveProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a Jive property.
getJivePropertyNames() - Static method in class com.jivesoftware.community.JiveGlobals
Returns all Jive property names.
getJivePropertyNames(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property names of a parent Jive property as a list of strings, or an empty list if there are no children.
getKey() - Method in class com.jivesoftware.community.AbuseType
Gets the unique key representing this abuse type.
getKey() - Method in class com.jivesoftware.community.BanLevel
Gets the key of a BanLevel object
getKey() - Method in enum com.jivesoftware.community.BlogPostSearchQueryCriteria.BlogPostSortType
 
getKey() - Method in enum com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType
 
getKey() - Method in enum com.jivesoftware.community.JiveInterceptor.Type
 
getKey() - Method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
 
getKey() - Method in enum com.jivesoftware.community.renderer.RenderTarget
Gets the key of a RenderTarget object
getKey() - Method in enum com.jivesoftware.community.renderer.RenderType
Gets the key of a RenderType object
getKey() - Method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
 
getKey() - Method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
 
getKey() - Method in enum com.jivesoftware.community.SearchQueryResult.ResultType
 
getKey() - Method in enum com.jivesoftware.community.TaskSearchQueryCriteria.TaskSortType
 
getKeywords() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Gets the keywords for the user search.
getLanguage() - Method in interface com.jivesoftware.community.Document
Return the ISO-639 code of the language associated with the document, or null if the document has no language specified (thus implying that it uses the global default language).
getLanguages() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the list of languages to filter results selected by the result filter.
getLanguages() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns the collection of languages that query results will be restricted to.
getLargeImagePath() - Method in interface com.jivesoftware.community.StatusLevel
 
getLastArchivedDate() - Method in interface com.jivesoftware.community.ArchiveManager
Returns the date the archiving process was last run.
getLastIndexedDate() - Method in interface com.jivesoftware.community.SearchManager
Returns the date that the last update to the index was made.
getLastIndexedDate() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns the date that the last update to the index was made.
getLastLoggedIn() - Method in interface com.jivesoftware.base.User
Returns the date the user last logged in.
getLastLoggedIn() - Method in class com.jivesoftware.base.UserTemplate
 
getLastLoggedIn(User) - Static method in class com.jivesoftware.community.util.SkinUtils
Returns the time the given user last logged in.
getLastName() - Method in interface com.jivesoftware.base.User
Returns the user's last name.
getLastName() - Method in class com.jivesoftware.base.UserTemplate
 
getLastUpdatedDate() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The last updated date of this resource.
getLastUpdateTime() - Method in interface com.jivesoftware.community.Presence
Return the time when the presence was last updated (when the user last visited).
getLastVisited(HttpServletRequest, HttpServletResponse) - Static method in class com.jivesoftware.community.util.SkinUtils
Returns the Date the user last visited.
getLatestDocument(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns the most recently created or edited document in this container (including all sub-communities).
getLatestMessage(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Returns the most recently created or edited message in this container (including all sub-containers if applicable).
getLatestMessage(TagSet) - Method in interface com.jivesoftware.community.ForumManager
Returns the most recently created or edited message in this tag set .
getLatestMessage() - Method in interface com.jivesoftware.community.ForumThread
Returns the most recently created messages in this thread.
getLatestPost() - Method in interface com.jivesoftware.community.Blog
Returns the most recently created and published blog post on this blog.
getLeaderIds(JiveContainer, int, int) - Method in interface com.jivesoftware.community.StatusLevelCalculator
Returns a long array of user ids of community leaders given a start index and desired number of results.
getLeaders() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of system wide leaders.
getLeaders(int, int) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of system wide leaders.
getLeaders(JiveContainer) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of leaders for a specific container
getLeaders(JiveContainer, int, int) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an Iterable of leaders for a specific container
getLicense() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getLicenseManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the license manager.
getLinkingObjects(JiveObject) - Method in interface com.jivesoftware.community.LinkManager
Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject.
getLinkManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a WikiLinkManager which can be used to manage links between content in the system.
getLinks(JiveObject) - Method in interface com.jivesoftware.community.LinkManager
Retrieve all the links in a particular jive object (With the exception of internal anchor links).
getLivePollCount() - Method in interface com.jivesoftware.community.PollManager
Returns a count of all live polls in the system.
getLivePollCount(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns a count of all live polls of a given type and object ID.
getLivePolls() - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of live polls in the system.
getLivePolls(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of live polls associated with the object specified by the objectType and objectID.
getLocale() - Method in interface com.jivesoftware.community.Community
Returns the locale for this community.
getLocale() - Method in class com.jivesoftware.community.EmailMessage
Return the locale for the email message.
getLocale() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the global Locale used by Jive.
getLocale(Community, User, HttpServletRequest) - Method in interface com.jivesoftware.community.LocaleManager
Returns a Locale object for the specified entity, if one exists.
getLocale() - Static method in class com.jivesoftware.community.util.SkinUtils
Returns the locale from the struts context if one exists, otherwise we return JiveGlobals.getLocale().
getLocaleManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a locale manager which can be used to get a locale for a particular user/object.
getLocales() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a list of available locales as a sorted list of Locale objects.
getLocalizedJiveProperty(String, Locale) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a localized Jive property given its name and locale.
getLocalizedPropertyLocales(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a list of locales where this property is set.
getLocalizedString(String, WidgetContext) - Method in class com.jivesoftware.community.widget.BaseWidget
 
getLocalProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
Return all immediate children property values of a parent local property as a list of strings, or an empty list if there are no children.
getLocalProperty(String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a local property.
getLocalProperty(String, int) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a local property as an integer.
getLocalProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
Returns a local property.
getLocalRenderPluginCount() - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns the count of currently installed render plugins.
getLogDirectory() - Static method in class com.jivesoftware.base.Log
Returns the directory that log files exist in.
getLoggedSearchQueryInfo(SearchQuery) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns the logged information about the query, or null if the query has not been logged yet.
getLoginTime() - Method in interface com.jivesoftware.community.Presence
Return the time when the presence was created.
getMacroParameterSets() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns a list of all available default parameter implementations, if any
getMacroParameterSets() - Method in interface com.jivesoftware.community.renderer.RenderMacro
Returns a list of all available default parameter implementations, if any
getMacroTag() - Method in class com.jivesoftware.community.renderer.BaseMacro
returns tag type
getMacroTag() - Method in interface com.jivesoftware.community.renderer.RenderMacro
returns tag type
getManager(User, HierarchicalUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a user's current manager in a hierarchical graph, or null if no manager is found.
getManagerRelationship(User, HierarchicalUserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a user's current manager.
getMaxAllowableHeight() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum allowable height for an avatar image
getMaxAllowableWidth() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum allowable width for an avatar image
getMaxAttachmentSize() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum size of an individual attachment in kilobytes.
getMaxAttachmentsPerBlogPost() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per blog post.
getMaxAttachmentsPerDocument() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per document.
getMaxAttachmentsPerMessage() - Method in interface com.jivesoftware.community.AttachmentManager
Returns the maximum number of attachments per message.
getMaxBodySize() - Method in interface com.jivesoftware.community.BinaryBodyManager
Returns the maximum size of an individual binary document body in kilobytes.
getMaxCreationDate() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Get the maximum document creation date for this query.
getMaxFieldSize() - Method in interface com.jivesoftware.community.DocumentField
Returns the maximum data size for the field.
getMaxFileSystemCacheSize() - Method in interface com.jivesoftware.community.StorageManager
Returns the maximum amount of storage (in bytes) that will be used by the file system cache when database binary object mode is enabled.
getMaxImageSize() - Method in interface com.jivesoftware.community.ImageManager
Returns the maximum size of an individual image in kilobytes.
getMaxImagesPerObject() - Method in interface com.jivesoftware.community.ImageManager
Returns the maximum number of images per document.
getMaxMessagesPerUser() - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the max number of messages each user is allowed to store in their mailbox, or -1 if there is no limit.
getMaxPoints() - Method in interface com.jivesoftware.community.StatusLevel
Returns the maximum value for a status level point range. -1 means unbounded (unless there is a group specified)
getMaxResultCount() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
The maximum number of results you want returned from #performSearch.
getMaxUserAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns the maximum amount of avatars a user is allowed to have, -1 for limitless
getMaxValue() - Method in class com.jivesoftware.community.user.profile.ProfileSearchFilter
Gets the maximum value that will be used to filter the user results.
getMeanRating(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
A convenience method which returns a geometric mean average of all the ratings given to the JiveContentObject.
getMemberCount() - Method in interface com.jivesoftware.base.Group
Returns the number of group members.
getMembers() - Method in interface com.jivesoftware.base.Group
An iterator for all the users that are members of the group.
getMessage() - Method in class com.jivesoftware.base.event.LogEvent
 
getMessage() - Method in class com.jivesoftware.community.event.EmailEvent
Returns the Message that the event corresponds to.
getMessage() - Method in class com.jivesoftware.community.event.MessageEvent
Returns the ForumMessage that the event corresponds to.
getMessage(long) - Method in interface com.jivesoftware.community.ForumManager
Returns the forum message with the specified messageID.
getMessage(long) - Method in interface com.jivesoftware.community.ForumThread
Returns a message from this thread based on its id.
getMessage() - Method in exception com.jivesoftware.community.ImageException
 
getMessage(long) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the specified private message.
getMessageCount(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Acquire the count of all messages for a specified container.
getMessageCount(TagSet) - Method in interface com.jivesoftware.community.ForumManager
Acquire the count of all messages for a specified tag set.
getMessageCount(JiveContainer, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
The account of messages for the JiveContainer with the ThreadResultFilter applied.
getMessageCount(TagSet, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
The account of messages for the TagSet with the ThreadResultFilter applied.
getMessageCount() - Method in interface com.jivesoftware.community.ForumThread
Returns the number of messages in the thread.
getMessageCount(ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumThread
Returns the number of messages in this thread based on the specified result filter.
getMessageCount(ModerationFilter) - Method in interface com.jivesoftware.community.OldModerationManager
Gets the number of moderated messages in the system
getMessageCount(JiveContainer) - Method in interface com.jivesoftware.community.OldModerationManager
Gets the number of moderated messages in a container
getMessageCount(ModerationFilter, JiveContainer) - Method in interface com.jivesoftware.community.OldModerationManager
Gets the number of moderated messages in a container
getMessageCount() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the number of messages in the folder.
getMessageCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of private messages a user has in their mailbox.
getMessageDepth(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the depth of a message in the message tree hierarchy.
getMessages(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the messages in the container.
getMessages(TagSet) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the messages in the tag set.
getMessages(JiveContainer, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the messages in the container that match the criteria specified by the ResultFilter.
getMessages(TagSet, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the messages in the tag set that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.community.ForumThread
Return an Iterable for all the messages in this thread.
getMessages(ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumThread
Returns a Iterable for all the messages in the thread that match the criteria specified by the ResultFilter.
getMessages() - Method in interface com.jivesoftware.community.OldModerationManager
This method will return a list of messages where the user is a moderator.
getMessages(ModerationFilter) - Method in interface com.jivesoftware.community.OldModerationManager
This method will return a list of messages where the user is a moderator.
getMessages(JiveContainer) - Method in interface com.jivesoftware.community.OldModerationManager
Gets a list of moderated messages for a particular container.
getMessages(ModerationFilter, JiveContainer) - Method in interface com.jivesoftware.community.OldModerationManager
Gets a list of moderated messages for a particular container.
getMessages() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns all the messages in the folder sorted by date descending.
getMessages(int, int, int, boolean) - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns messages in the folder based on the params.
getMessageSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the MessageSearchQueryCriteria that can be used to specify criteria to sort and/or filter message search results.
getMessageSortType(int) - Static method in enum com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType
A helper method to get a specific MessageSortType object from its key
getMessageToken(long, long) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Uses the supplied user id and message id to build a token string which can be used to identify and authenticate that user and message.
getMinCreationDate() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Get the minimum document creation date for this query.
getMinimum() - Method in class com.jivesoftware.community.TagResultFilter
Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
getMinPoints() - Method in interface com.jivesoftware.community.StatusLevel
Returns the minimum value for a status level point range. -1 means unbounded (unless there is a group specified)
getMinServerVersion() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getMinValue() - Method in class com.jivesoftware.community.user.profile.ProfileSearchFilter
Gets the minimum value that will be used to filter the user results.
getModeratedTypes() - Method in interface com.jivesoftware.community.moderation.ModerationStrategy
Specifies a list of JiveObjectType that the strategy supports.
getModerationAvatarCount() - Method in interface com.jivesoftware.community.AvatarManager
Used to acquire a count of all the avatars that require moderation.
getModerationAvatars() - Method in interface com.jivesoftware.community.AvatarManager
Returns a collection of all of the avatars that require moderation.
getModerationDefaultMessageValue() - Method in interface com.jivesoftware.community.Community
Returns the default number of moderation points for messages created in the community.
getModerationDefaultThreadValue() - Method in interface com.jivesoftware.community.Community
Returns the default number of moderation points for threads created in the community.
getModerationRangeMax() - Method in class com.jivesoftware.community.ModerationFilter
 
getModerationRangeMax() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter.
getModerationRangeMin() - Method in class com.jivesoftware.community.ModerationFilter
 
getModerationRangeMin() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter.
getModerationValue() - Method in interface com.jivesoftware.community.ForumMessage
Returns the number of moderation points this message has.
getModerationValue() - Method in interface com.jivesoftware.community.ForumThread
Returns the number of moderation points this thread has.
getModerators(JiveObject) - Method in interface com.jivesoftware.community.moderation.ModerationStrategy
Retrieves a list of unique User IDs representing the available moderators for a given JiveObject.
getModificationDate() - Method in interface com.jivesoftware.base.Group
Returns the date that the group was last modified.
getModificationDate() - Method in interface com.jivesoftware.base.User
Returns the date that the user was last modified.
getModificationDate() - Method in class com.jivesoftware.base.UserTemplate
 
getModificationDate() - Method in interface com.jivesoftware.community.Attachment
Returns the date the attachment was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Blog
Returns the date that the blog name, display name or description was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.BlogPost
Returns the date that this post was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Comment
Returns the date that the comment was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Document
A convenience method which returns the date the document was last modified as determined by the version with a DocumentState.PUBLISHED state, or if no version has that state the modification date of the current instance of the document.
getModificationDate() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the date the document version was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Draft
Returns the date that the draft was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.ForumMessage
Returns the date this message was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.ForumThread
Returns the date that this thread was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.Image
Returns the date the image was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.JiveContainer
Returns the Date this container was last modified.
getModificationDate() - Method in interface com.jivesoftware.community.JiveContentObject
Gets the modification date of the jive object
getModificationDate() - Method in interface com.jivesoftware.community.Poll
Returns the date the poll was last modified.
getModificationDate() - Method in class com.jivesoftware.community.project.CheckPoint
 
getModificationDate() - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the modification date of the jive content object this query result pertains to.
getModificationDate() - Method in interface com.jivesoftware.community.TagSet
A convenience method which returns the date the tag set was last modified

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

getModificationDate() - Method in interface com.jivesoftware.community.Trackback
Returns the date this trackback was last modified.
getModificationDateRangeMax() - Method in class com.jivesoftware.community.ResultFilter
Returns the date that represents the upper boundry for modification dates that will pass the result filter.
getModificationDateRangeMin() - Method in class com.jivesoftware.community.ResultFilter
Returns the date that represents the lower boundry for modification dates that will pass the result filter.
getModifiedObject() - Method in class com.jivesoftware.spi.ServiceEvent
Retrieve the object that was modified.
getModValue() - Method in interface com.jivesoftware.community.Avatar
Returns the moderation value for this Avatar
getModValueList() - Method in class com.jivesoftware.community.ModerationFilter
Gets a list of moderation values that will be used to filter results.
getName() - Method in class com.jivesoftware.base.event.JivePropertyEvent
Returns the name of the jive property
getName() - Method in interface com.jivesoftware.base.Group
Returns the name of the group.
getName() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getName() - Method in interface com.jivesoftware.base.User
Returns the user's name.
getName() - Method in class com.jivesoftware.base.UserTemplate
 
getName() - Method in interface com.jivesoftware.community.Attachment
Returns the name of the attachment.
getName() - Method in interface com.jivesoftware.community.BinaryBody
Returns the name of the body object.
getName() - Method in interface com.jivesoftware.community.Blog
Returns the name of the blog.
getName() - Method in interface com.jivesoftware.community.Comment
Returns the name of the person that authored this comment.
getName() - Method in interface com.jivesoftware.community.ContentTag
The name of the tag
getName() - Method in interface com.jivesoftware.community.DocumentField
Returns the unique name of the document field.
getName() - Method in enum com.jivesoftware.community.DocumentFieldType.DataType
 
getName() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns unique name of this Document Field Type.
getName() - Method in interface com.jivesoftware.community.DocumentPresenter
Returns the identifying name of the document presenter.
getName() - Method in interface com.jivesoftware.community.DocumentType
Returns the name of the document type.
getName() - Method in enum com.jivesoftware.community.DocumentTypeElement.Type
Returns the text representation of this Type
getName() - Method in class com.jivesoftware.community.EmailMessage.EmailAddress
 
getName() - Method in interface com.jivesoftware.community.ForumThread
Returns the subject of the root message of this thread.
getName() - Method in interface com.jivesoftware.community.Image
Returns the name of the image.
getName() - Method in interface com.jivesoftware.community.JiveContainer
Returns the name of the container.
getName() - Method in enum com.jivesoftware.community.JiveContentObject.Status
 
getName() - Method in interface com.jivesoftware.community.Poll
Returns the name of the poll.
getName() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the name of the folder.
getName() - Method in class com.jivesoftware.community.project.CheckPoint
 
getName() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getName() - Method in class com.jivesoftware.community.renderer.BaseFilter
Returns the value of the Name annotation if defined otherwise the value of getClass().getSimpleName().
getName() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the name of the macro tag.
getName() - Method in enum com.jivesoftware.community.renderer.RenderType
Returns a string based key representing this render type.
getName() - Method in interface com.jivesoftware.community.StatusLevel
Returns the name of this status level
getName() - Method in interface com.jivesoftware.community.TagSet
Returns the name of this TagSet.
getName() - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the internal name of this profile field.
getName() - Method in enum com.jivesoftware.community.user.profile.ProfileField.Type
 
getName() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns the name of the provider for system reporting and logging purposes.
getNestedContainerContext(Community) - Static method in class com.jivesoftware.community.util.BlogUtils
 
getNestedContainerContext(Project) - Static method in class com.jivesoftware.community.util.BlogUtils
 
getNestedThrowable() - Method in exception com.jivesoftware.base.UnauthorizedException
 
getNewestDocumentVersion() - Method in interface com.jivesoftware.community.VersionManager
Convenience method which returns the newest document version as determined by version number.
getNewestMembers(int) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Get results corresponding to the recent members in the system.
getNextPost() - Method in interface com.jivesoftware.community.BlogPost
Returns the next blogpost that has been published or null if this is the most recent post.
getNonAuthenticatedCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getNonce() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns a new nonce genereted in Openfire.
getNonParseableCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getNotificationUserIDs(User, UserRelationship) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
 
getNumberOfAbuseReports(JiveObject) - Method in interface com.jivesoftware.community.AbuseManager
Gets the number of abuse reports for a particular message
getNumColumns() - Method in interface com.jivesoftware.community.widget.WidgetLayout
Returns the number of columns that this widget layout supports.
getNumResults() - Method in class com.jivesoftware.community.QuestionFilter
Returns the max number of results that should be returned.
getNumResults() - Method in class com.jivesoftware.community.ResultFilter
Returns the max number of results that should be returned.
getObjectID() - Method in class com.jivesoftware.community.AbuseReport
Returns the message ID of the forum message.
getObjectID() - Method in interface com.jivesoftware.community.Announcement
 
getObjectID() - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
getObjectID() - Method in interface com.jivesoftware.community.TrackbackManager
Returns the id of the object managed by this instance.
getObjectID() - Method in interface com.jivesoftware.community.Watch
Returns the object ID of the object being watched.
getObjectType() - Method in class com.jivesoftware.base.UserTemplate
 
getObjectType() - Method in class com.jivesoftware.community.AbuseReport
 
getObjectType() - Method in class com.jivesoftware.community.Ban
Return the BAN object type.
getObjectType() - Method in exception com.jivesoftware.community.DocumentObjectNotFoundException
 
getObjectType() - Method in class com.jivesoftware.community.EntityDescriptor
Returns the type of object this is.
getObjectType() - Method in interface com.jivesoftware.community.JiveObject
Return the object type of the jive object.
getObjectType() - Method in class com.jivesoftware.community.project.CheckPoint
 
getObjectType() - Method in interface com.jivesoftware.community.TrackbackManager
Returns the type (one of the values in JiveConstants) of the object managed by this instance.
getObjectType() - Method in interface com.jivesoftware.community.Watch
Returns the object type of the object being watched.
getOldModerationManager() - Method in interface com.jivesoftware.community.JiveContext
 
getOnlineUserCount() - Method in interface com.jivesoftware.community.PresenceManager
Returns the number of users who are currently online.
getOnlineUserCount(Group) - Method in interface com.jivesoftware.community.PresenceManager
Returns the number of users in the group who are currently online.
getOnlineUserCount() - Method in interface com.jivesoftware.community.Roster
Returns the number of users in the roster who are currently online.
getOnlineUsers() - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online.
getOnlineUsers(Group) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users in the group who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(Group, boolean, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(boolean, int, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers(Group, boolean, int, int) - Method in interface com.jivesoftware.community.PresenceManager
Returns an iterator of users who are currently online matching the criteria given.
getOnlineUsers() - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users in the roster who are currently online.
getOnlineUsers(boolean, int) - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users sorted in the manner requested who are currently online.
getOnlineUsers(boolean, int, int) - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users who are currently online matching the criteria given.
getOption(long) - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Returns a DocumentFieldOption by its id.
getOption(int) - Method in interface com.jivesoftware.community.Poll
Returns the text of the option at the specified index.
getOptionCount() - Method in interface com.jivesoftware.community.Poll
Returns the number of options available in the poll.
getOptionIDs() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getOptions() - Method in interface com.jivesoftware.community.MultiOptionDocumentField
Returns an iterator of DocumentFieldOption objects.
getOptions() - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets a list of ProfileFieldOption objects for this profile field.
getOrder() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getOrder() - Method in class com.jivesoftware.community.renderer.BaseMacro
returns the order the macro should be run in. 0 should be "normal"
getOrder() - Method in interface com.jivesoftware.community.renderer.RenderFilter
Return the order in which to place the filter in the render pipeline.
getOrder() - Method in interface com.jivesoftware.community.renderer.RenderMacro
returns the order the macro should be run in. 0 should be "normal"
getOwner() - Method in interface com.jivesoftware.community.Avatar
Returns user who created this avatar, if the user is null then this is a global avatar
getOwner() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the owner of the private message folder.
getPageURL() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the URL of the current page as a string.
getParameters() - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getParameters() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the parameters passed into this tag.
getParams() - Method in class com.jivesoftware.base.event.GroupEvent
 
getParams() - Method in class com.jivesoftware.base.event.JivePropertyEvent
Returns any extra parameters associated with event
getParams() - Method in class com.jivesoftware.base.event.LogEvent
 
getParams() - Method in class com.jivesoftware.base.event.UserEvent
 
getParams() - Method in class com.jivesoftware.community.event.AnnouncementEvent
 
getParams() - Method in class com.jivesoftware.community.event.AttachmentEvent
 
getParams() - Method in class com.jivesoftware.community.event.AvatarEvent
 
getParams() - Method in class com.jivesoftware.community.event.BlogEvent
 
getParams() - Method in class com.jivesoftware.community.event.BlogPostEvent
 
getParams() - Method in class com.jivesoftware.community.event.CommentEvent
 
getParams() - Method in class com.jivesoftware.community.event.CommunityEvent
 
getParams() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getParams() - Method in class com.jivesoftware.community.event.EmailEvent
 
getParams() - Method in class com.jivesoftware.community.event.ImageEvent
 
getParams() - Method in class com.jivesoftware.community.event.MessageEvent
 
getParams() - Method in class com.jivesoftware.community.event.PollEvent
 
getParams() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
 
getParams() - Method in class com.jivesoftware.community.event.ProfileEvent
 
getParams() - Method in class com.jivesoftware.community.event.ProfileSearchIndexEvent
 
getParams() - Method in class com.jivesoftware.community.event.ProjectEvent
 
getParams() - Method in class com.jivesoftware.community.event.QuestionEvent
 
getParams() - Method in class com.jivesoftware.community.event.SearchIndexEvent
 
getParams() - Method in class com.jivesoftware.community.event.StorageManagerEvent
 
getParams() - Method in class com.jivesoftware.community.event.TagEvent
 
getParams() - Method in class com.jivesoftware.community.event.TagSetEvent
 
getParams() - Method in class com.jivesoftware.community.event.TaskEvent
 
getParams() - Method in class com.jivesoftware.community.event.ThreadEvent
 
getParams() - Method in class com.jivesoftware.community.event.TrackbackEvent
 
getParent(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the parent of the child comment.
getParent(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the parent of the child ForumMessage.
getParentCommunities(Community) - Static method in class com.jivesoftware.community.util.SkinUtils
Returns a list of parent communities for the given forum in top-down order.
getParentCommunity() - Method in interface com.jivesoftware.community.Community
Deprecated. use getParentContainer instead
getParentContainer() - Method in interface com.jivesoftware.community.Community
Returns the parent community of this community.
getParentContainer() - Method in interface com.jivesoftware.community.JiveHierarchicalContainer
Returns the JiveContainer that contains this JiveContainer
getParentMessage() - Method in interface com.jivesoftware.community.ForumMessage
Returns the parent message of this message or null if this message is the root message of a thread.
getParentObject() - Method in class com.jivesoftware.community.widget.WidgetFrame
Gets the parent JiveObject of this frame
getParentObjectID() - Method in class com.jivesoftware.community.event.TagEvent
 
getParentObjectID() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the object id of the parent
getParentObjectType() - Method in class com.jivesoftware.community.event.TagEvent
 
getParentObjectType() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the object type of the parent
getParseableCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getPassword() - Method in interface com.jivesoftware.base.User
Exposes a raw password.
getPassword() - Method in class com.jivesoftware.base.UserTemplate
 
getPasswordHash() - Method in interface com.jivesoftware.base.User
Returns the user's password in hashed form.
getPasswordHash() - Method in class com.jivesoftware.base.UserTemplate
 
getPendingRelationships(User, UserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of not-yet-approved relationships for a given graph.
getPercentComplete() - Method in interface com.jivesoftware.community.SearchManager
Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getPercentComplete() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns the percent complete that an indexing operation is if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getPermalink() - Method in interface com.jivesoftware.community.BlogPost
Returns the permalink for this post, where the permalink is a composed only of unreserved characters:

unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"

as according to RFC 3986: http://www.ietf.org/rfc/rfc3986.txt

Space characters and characters not in the list of unreserved characters are replaced with a hyphen character.

getPermissionNames() - Static method in class com.jivesoftware.community.Permissions
 
getPermissions(AuthToken) - Method in interface com.jivesoftware.base.Group
Returns the permissions for the group that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.base.User
Returns the permissions for the user that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in class com.jivesoftware.base.UserTemplate
 
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.Blog
Deprecated. 
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.Document
Returns the permissions for the document that correspond to the passed-in AuthToken.
getPermissions(AuthToken) - Method in interface com.jivesoftware.community.JiveContainer
Deprecated. 
getPermissionsManager() - Method in interface com.jivesoftware.community.Document
Returns a permissions manager that can be used to set permissions for the document.
getPermissionsManager() - Method in interface com.jivesoftware.community.JiveContainer
Deprecated. 
getPermissionsManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a permissions manager that can be used to set system wide permissions.
getPermissionsProvider() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the permissions provider.
getPingServices() - Method in interface com.jivesoftware.community.Blog
Returns a line break separated list of services that the user has chosen to ping.
getPingServices() - Method in interface com.jivesoftware.community.BlogManager
Returns a comma delimited list of available ping services for the system.
getPlainBody() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the body of the jive object content with no markup applied.
getPlainSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the title of the jive object content with no markup applied
getPlugin(String) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns a plugin by name or null if a plugin with that name does not exist.
getPlugin() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginBeans() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns beans for all the plugins that need to have their spring config loaded with the parent context.
getPluginClassloader(String, File) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
 
getPluginClassloader(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns the classloader of a plugin.
getPluginDbBean() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginDirectory(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns the plugin's directory.
getPluginDirectory() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns the directory {jiveHome}/plugins.
getPluginDirectory() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginDirectory() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the directory that plugins are locally cached for a particular clearspace instance.
getPluginManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the plugin which can be used for acquiring plugin instances.
getPluginMap() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns a map of plugin name plugin entries.
getPluginMetaData() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns meta data about the plugin this macro is deployed in.
getPluginMetaData(String) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns meta data associated with the plugin.
getPluginMetaData(Plugin<?>) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns meta data assosiated with the plugin.
getPluginProperties(String) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns a object for storing and receving property setting for a plugin.
getPluginProperties() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginResourceBundle(Plugin<?>, Locale) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Acquires a plugins resource bundle which should be stored in /plugin_i18n in the plugin's classloader.
getPluginResourceBundle(Locale) - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getPluginResourceBundles(Locale) - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns all of the plugin resource bundles that match the specified locale.
getPlugins() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
Returns a Collection of all installed plugins.
getPointLevel(User, JiveContainer) - Method in interface com.jivesoftware.community.StatusLevelCalculator
Returns the status level points for a user in regards to a specific community
getPointLevel(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the point level for a user system wide.
getPointLevel(User, JiveContainer) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the status level points for a user in regards to a specific container
getPoints() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResult
Gets the StatusLevel points for this user.
getPointStatusLevels() - Method in interface com.jivesoftware.community.StatusLevelManager
Returns an iterable of point based status levels in the system sorted by point range.
getPoll() - Method in class com.jivesoftware.community.event.PollEvent
Returns the Poll that the event corresponds to.
getPoll(long) - Method in interface com.jivesoftware.community.PollManager
Returns the Poll specified by the poll ID.
getPollCount() - Method in interface com.jivesoftware.community.PollManager
Returns a count of all polls, both active and inactive.
getPollCount(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPollManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a poll manager that can be used to retrieve and manager polls.
getPolls() - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of all polls, both active and inactive.
getPolls(int, long) - Method in interface com.jivesoftware.community.PollManager
Returns an iterable of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPopularBlogPosts(Blog) - Method in interface com.jivesoftware.community.ActivityManager
Returns a JiveIterator of popular blog posts for the blog in popularity order.
getPopularBlogPosts() - Method in interface com.jivesoftware.community.ActivityManager
Returns a JiveIterator of popular blog posts system wide in popularity order.
getPopularBlogPosts() - Method in interface com.jivesoftware.community.Blog
Returns the top x blog posts according to blog post views, number of comments & time passed since the blog post was created.
getPopularBlogPosts() - Method in interface com.jivesoftware.community.BlogManager
Returns the top x blog posts according to blog post views, number of comments & time passed since the blog post was created.
getPopularDocuments() - Method in interface com.jivesoftware.community.ActivityManager
Returns a system wide JiveIterator of popular documents in popularity order.
getPopularDocuments(JiveContainer) - Method in interface com.jivesoftware.community.ActivityManager
Returns a JiveIterator of popular documents for the container in popularity order.
getPopularDocuments() - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across all containers according to ratings, document views & time passed since the document was created.
getPopularDocuments(JiveContainer) - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across a given community & it's subcommunities according to ratings, document views & time passed since the document was created in the languages specified.
getPopularDocuments(List<String>) - Method in interface com.jivesoftware.community.DocumentManager
Returns the top x documents across all containers according to ratings, document views & time passed since the document was created in the languages specified.
getPopularTags() - Method in interface com.jivesoftware.community.Blog
Returns the 20 most popular tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog.
getPopularThreads() - Method in interface com.jivesoftware.community.ActivityManager
Returns a system wide JiveIterator of popular threads in popularity order.
getPopularThreads(JiveContainer) - Method in interface com.jivesoftware.community.ActivityManager
Returns a JiveIterator of popular threads for the container in popularity order.
getPopularThreads() - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for the most threads in the system as ForumThread objects.
getPossibleRelationshipMap(User, User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
 
getPossibleRelationships(User, User, UserRelationshipGraph) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a collection of relationship views (per graph) showing the possible relationships between two users.
getPostPermalink(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a permalink for a blog post which is a combination of the base URL, the blog display name and the post permalink.
getPreferredEditorMode() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getPrefix() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Get a single-character prefix used to filter names, such as "A" which would return all users with first names, last names, and usernames beginning in "A".
getPrefixCharacters() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns a set of one-character Strings corresponding to the first character (or symbol) of all usernames, names, first names, and last names in the system.
getPresence(User) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getPresence(User) - Method in interface com.jivesoftware.community.PresenceManager
Returns the presence for the user, or null if the user isn't online.
getPresence(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a particular XMPP address, or null if is unavailable (offline) or if no presence information is available.
getPresence(User) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a User, or null if is unavailable (offline) or if no presence information is available.
getPresenceForResource(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns the presence info for a particular XMPP address resource, or null if the resource is unavailable (offline) or if no presence information is available.
getPresenceManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a presence manager that can be used to retrieve and manage presences.
getPresences(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
Returns a collection Presence information for all the user's current resources or null if the user is unavailable (offline) or if no presence information is available.
getPreviousPost() - Method in interface com.jivesoftware.community.BlogPost
Returns the previous blogpost that has been published or null if this is the first post.
getPreviousStatus() - Method in class com.jivesoftware.community.event.DocumentEvent
 
getPrivateMessage() - Method in class com.jivesoftware.community.event.PrivateMessageEvent
Returns the ForumMessage that the event corresponds to.
getPrivateMessageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a private message manager, which controls private message settings.
getProfile(User) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.
getProfileField() - Method in class com.jivesoftware.community.event.ProfileFieldEvent
 
getProfileField(long) - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Gets a profile field object by its id.
getProfileField(String) - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Gets a profile field object by its name or null if the field name is not found.
getProfileFieldManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile field manager.
getProfileFields() - Method in interface com.jivesoftware.community.user.profile.ProfileFieldManager
Gets the list of all profile fields in the system.
getProfileFieldTermsByFieldID(long, boolean) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Gets a list of distinct terms and their count used for any given profile field.
getProfileFieldText() - Method in class com.jivesoftware.community.user.profile.ProfileField
 
getProfileImage(User) - Method in interface com.jivesoftware.community.user.profile.ProfileManager
Returns the profile image for a user.
getProfileManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile manager.
getProfileSearchManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the profile search manager.
getProject() - Method in class com.jivesoftware.community.event.ProjectEvent
Returns the work space that the event corresponds to.
getProject(long) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the project with the given projectID
getProject() - Method in class com.jivesoftware.community.widget.ProjectWidgetContext
Get the blog from the widget context.
getProjectCount() - Method in interface com.jivesoftware.community.project.ProjectManager
Returns a count of all the projects in the system
getProjectCount(ProjectResultFilter) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns a count of all the projects in the system, according to the work space result filter
getProjectCountFromTaskList(User) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the count of unique projects that the user is assigned one or more tasks
getProjectId() - Method in class com.jivesoftware.community.project.CheckPoint
 
getProjectManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the project manager.
getProjects() - Method in interface com.jivesoftware.community.project.ProjectManager
Returns an Iterable for all the projects in the container
getProjects(ProjectResultFilter) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns an Iterable for all the visible projects in the system, according to the work space result filter
getProjectsFromTaskList(User) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns an iterator of unique projects that the user is assigned one or more tasks
getProperties() - Method in interface com.jivesoftware.base.Group
Retrieve a map of all the extended properties for the group.
getProperties() - Method in interface com.jivesoftware.base.User
Retrieve a map of all the extended properties for the user.
getProperties() - Method in class com.jivesoftware.base.UserTemplate
 
getProperties() - Method in interface com.jivesoftware.community.Announcement
Retrieve a map of all the extended properties for the announcement.
getProperties() - Method in interface com.jivesoftware.community.Attachment
Retrieve a map of all the extended properties for the attachment.
getProperties() - Method in interface com.jivesoftware.community.Avatar
Retrieve a map of all the extended properties for the avatar.
getProperties() - Method in interface com.jivesoftware.community.Blog
Retrieve a map of all the extended properties for the blog.
getProperties() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a map of all the extended properties for the post.
getProperties() - Method in interface com.jivesoftware.community.Comment
Retrieve a map of all the extended properties for the comment.
getProperties() - Method in interface com.jivesoftware.community.Document
Retrieve a map of all the extended properties for the document.
getProperties() - Method in interface com.jivesoftware.community.DocumentType
Retrieve a map of all the extended properties for the document type.
getProperties() - Method in interface com.jivesoftware.community.Draft
Returns a map of properties associated with this draft.
getProperties() - Method in interface com.jivesoftware.community.ForumMessage
Retrieve a map of all the extended properties for the message.
getProperties() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a map of all the extended properties for the thread.
getProperties() - Method in interface com.jivesoftware.community.JiveContainer
Retrieve a map of all the extended properties for the container.
getProperties() - Method in interface com.jivesoftware.community.PrivateMessage
Retrieve a map of all the extended properties for the private message.
getProperties() - Method in class com.jivesoftware.community.project.CheckPoint
 
getProperties() - Method in interface com.jivesoftware.community.Question
Retrieve a map of all the extended properties for the question.
getProperties() - Method in interface com.jivesoftware.community.Trackback
Retrieve a map of all the extended properties for the trackback.
getProperties() - Method in class com.jivesoftware.community.widget.WidgetFrameBean
Gets the properties specific to this WidgetFrame
getProperties() - Method in class com.jivesoftware.spi.ServiceEvent
Retrieve properties associated with the event
getPropertyCount() - Method in class com.jivesoftware.community.QuestionFilter
Returns the number of properties that results will be filtered on.
getPropertyCount() - Method in class com.jivesoftware.community.ResultFilter
Returns the number of properties that results will be filtered on.
getPropertyMatchType(int) - Method in class com.jivesoftware.community.ResultFilter
Returns the value of the property at the specified index in the list of properties.
getPropertyMode() - Method in class com.jivesoftware.community.ResultFilter
Returns the mode that will be used to select results if multiple properties have been specified.
getPropertyName(int) - Method in class com.jivesoftware.community.QuestionFilter
Returns the name of the property at the specified index in the list of properties to be filtered on.
getPropertyName(int) - Method in class com.jivesoftware.community.ResultFilter
Returns the name of the property at the specified index in the list of properties to be filtered on.
getPropertyNames() - Method in interface com.jivesoftware.community.JiveProperties
Returns all property names as a Collection of String values.
getPropertyValue(int) - Method in class com.jivesoftware.community.QuestionFilter
Returns the value of the property at the specified index in the list of properties to be filtered on.
getPropertyValue(int) - Method in class com.jivesoftware.community.ResultFilter
Returns the value of the property at the specified index in the list of properties to be filtered on.
getPropertyValueString(int) - Method in class com.jivesoftware.community.ResultFilter
Returns the value of the property at the specified index in the list of properties to be filtered on.
getPublishDate() - Method in interface com.jivesoftware.community.BlogPost
Returns that date that this post should be published.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns a date that represents the upper boundry for blog posts to be selected by the result filter.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.BlogTagResultFilter
Returns a date that represents the upper boundry for tags to be selected by the result filter.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.BlogPostResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.BlogTagResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getPublishedDate() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The published date of this resource.
getPublishedDocumentVersion() - Method in interface com.jivesoftware.community.VersionManager
Convenience method which returns the published document version.
getPublishedWidgetFrames(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the map containing all the published WidgetFrames for the specified parent JiveObject.
getPublishedWidgetLayout(JiveObject) - Method in interface com.jivesoftware.community.widget.WidgetManager
Returns the published WidgetLayout for the specified parent JiveObject.
getQueryCacheManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the query cache manager.
getQueryString() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the search query string for the SearchQuery object.
getQueryTestTerm() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the test term that is used for performing the test query.
getQuestion() - Method in class com.jivesoftware.community.event.QuestionEvent
Returns the Question that the event corresponds to.
getQuestion() - Method in interface com.jivesoftware.community.ForumThread
Returns the question associated with a thread or null if the question does not exist.
getQuestion(ForumThread) - Method in interface com.jivesoftware.community.QuestionManager
Returns the question associated with a thread.
getQuestionCount() - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in the system.
getQuestionCount(QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in the system that pass the specified question filter.
getQuestionCount(JiveContainer) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of all questions in a container.
getQuestionCount(JiveContainer, QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns the count of questions in a container that pass the specified question filter.
getQuestionManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a QuestionManager, which can be used to manage Questions.
getQuestions() - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in the system.
getQuestions(QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in the system that pass the specified question filter.
getQuestions(JiveContainer) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in a container.
getQuestions(JiveContainer, QuestionFilter) - Method in interface com.jivesoftware.community.QuestionManager
Returns an iterable for all questions in a categetory that pass the specified question filter.
getRange() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
The number of returned user results.
getRating(User, JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns the rating associated with the user, or null if this user hasn't rated the JiveContentObject.
getRatingCount(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns the total number of ratings given to the JiveContentObject.
getRatingDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a rating delegator to manage blog post ratings.
getRatingDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a rating delegator to manage document ratings.
getRatingDelegator() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a rating delegator to manage thread ratings.
getRatingFromScore(int) - Method in interface com.jivesoftware.community.RatingManager
Retrieve the rating with the specified score.
getRatingManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a RatingManager which can be used to add, retrieve and manage ratings
getRatings(JiveObject) - Method in interface com.jivesoftware.community.RatingManager
Returns an Iterable of all the ratings given to the JiveContentObject.
getReadStatus(User, ForumThread) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns the read status on the specified thread.
getReadStatus(User, ForumMessage) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns the read status on the specified message.
getReadStatus(JiveContainer, User, int) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns true if the user has the specified read status on the object, false otherwise.
getReadTracker() - Method in interface com.jivesoftware.community.JiveContext
Returns a read tracker that can be used to track which threads and messages a user has read.
getReadTrackerManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a read tracker manager that can be used to track which threads and messages a user has read.
getRecentActivity(JiveContainer) - Method in interface com.jivesoftware.community.ActivityManager
Returns all the recent activities that have occurred in the specified container and all subcontainers.
getRecentActivity(JiveContainer, Predicate<ActivityBean>) - Method in interface com.jivesoftware.community.ActivityManager
Returns all the recent activities matching the provided predicate that have occurred in the specified container and all subcontainers.
getRecentActivity(User) - Method in interface com.jivesoftware.community.ActivityManager
Returns all the recent activities for a particular user
getRecentActivity(Collection<User>) - Method in interface com.jivesoftware.community.ActivityManager
Returns all the recent activities for a collection of users.
getRecentActivity(User, Predicate<ActivityBean>) - Method in interface com.jivesoftware.community.ActivityManager
Returns all the recent activities for a particular user matching the provided predicate.
getRecentBlogPosts() - Method in interface com.jivesoftware.community.Blog
Returns (at most) the ten most recent blog posts on this blog.
getRecentBlogs() - Method in interface com.jivesoftware.community.BlogManager
Returns (at most) the ten most recent blogs created on this system.
getRecentComments() - Method in interface com.jivesoftware.community.Blog
Returns (at most) the ten most recent comments on this blog.
getRecentContent(JiveContainer) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content for the specified container.
getRecentContent(User) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content for the specified user.
getRecentContent(Collection<User>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content for a set of users.
getRecentContent(JiveContainer, Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content that pass the provided predicate for the specified container.
getRecentContent(User, Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content that pass the provided predicate for the specified user.
getRecentContent(JiveContainer, ContentRetrieval.ContentType[]) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types for the specified container.
getRecentContent(User, ContentRetrieval.ContentType[]) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types for the specified user.
getRecentContent(JiveContainer, ContentRetrieval.ContentType[], Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types and predicate for the specified container.
getRecentContent(User, ContentRetrieval.ContentType[], Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types and predicate for the specified user.
getRecentContentManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a recent content manager that can be used to retrieve lists of recent content
getRecentContentMapSize() - Static method in class com.jivesoftware.community.action.JiveActionSupport
 
getRecentUserCount(Date) - Method in interface com.jivesoftware.base.UserManager
Returns the number of application users in the system who have been created since a given date.
getRecipient() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the user the message was sent to.
getRecipients() - Method in class com.jivesoftware.community.EmailMessage
Returns the recipients of the email
getRecursiveChildCount(Comment) - Method in interface com.jivesoftware.community.CommentTreeWalker
Returns the total number of recursive children of a parent.
getRecursiveChildCount(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns the total number of recursive children of a parent.
getRecursiveChildren(ForumMessage) - Method in interface com.jivesoftware.community.TreeWalker
Returns an Iterable for all child messages (and sub-children, etc) of the parent.
getRecursiveCommunities(Community) - Method in interface com.jivesoftware.community.CommunityManager
Returns an Iterable for all sub-communities of a community, including sub-communities of sub-communities, etc.
getRecursiveCommunityCount(Community) - Method in interface com.jivesoftware.community.CommunityManager
Returns the count of all sub-communities of a community, including sub-communities of sub-communities, etc.
getRecursiveMessages() - Method in interface com.jivesoftware.community.TreeWalker
Returns an Iterable for all messages in the thread in depth-first order.
getRecursiveRecentContent(JiveContainer) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content for the specified container and all subcontainers.
getRecursiveRecentContent(JiveContainer, Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns all the recent content that pass the provided predicate for the specified container and all subcontainers.
getRecursiveRecentContent(JiveContainer, ContentRetrieval.ContentType[]) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types for the specified container and all subcontainers.
getRecursiveRecentContent(JiveContainer, ContentRetrieval.ContentType[], Predicate<RecentContentBean>) - Method in interface com.jivesoftware.community.RecentContentManager
Returns the recent content matching the provided content types and predicate for the specified container and all subcontainers.
getRegistrationExpirationPeriod() - Method in interface com.jivesoftware.community.RegistrationManager
Returns the period of time from a users time of registration at which their account will be removed if they have not responded to their validation email.
getRegistrationFields() - Method in interface com.jivesoftware.community.RegistrationManager
Returns the collection of fields displayed at registration.
getRegistrationIndex() - Method in class com.jivesoftware.community.user.profile.ProfileField
 
getRegistrationManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a validation manager that can be used for validating user accounts
getRegistrationProfileField(int) - Method in interface com.jivesoftware.community.RegistrationManager
 
getRejectionType() - Method in exception com.jivesoftware.community.PrivateMessageRejectedException
Returns the type of the rejection exception.
getRelationship(long) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a given relationship for its ID.
getRelationshipGraph(long) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a graph for a given graph ID.
getRelationshipGraphs(boolean) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a collection of all graphs in the system, regardless of state (enabled or disabled).
getRelationshipList(long) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Retrive a relationship list by ID.
getRelationshipListsByOwner(User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Retrieves a collection of lists based on an owner userID.
getRelationshipListsByPerson(User, User) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Retrieves a collection of lists based on an owner userID and a person who is on the list.
getRelationshipListUsers(UserRelationshipList) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a list of users from a user relationship list.
getRelativePostLink(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
 
getRelevance() - Method in interface com.jivesoftware.community.SearchQueryResult
Get the relevance of this query result as determined by the search engine.
getRelevance() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResult
Gets the search relevance for this user, a floating point number between 0.0 and 1.0.
getRelevanceAsPercentage(Locale) - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the relevance as a percentage (no decimal places) formatted according to the locale passed in.
getRenderCacheManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the render cache manager, used for caching rendered content fields.
getRenderManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a render manager that can be used to manage system wide render filters and macros.
getRenderManager() - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns a render manager for private messages in the system.
getRenderManager(JiveContainer) - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns the RenderManager associated with the container.
getRenderPipe() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the render pipe that will be used for rendering.
getRenderPlugin(String) - Method in interface com.jivesoftware.community.renderer.RenderManager
Return the render filter with the specified name
getRenderPlugins() - Method in interface com.jivesoftware.community.renderer.RenderManager
Returns an array of RenderFilter objects that list all the currently configured render filters.
getRenderPlugins() - Method in class com.jivesoftware.community.renderer.RenderPipe
 
getRenderStrategy() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the render strategy that will be used for rendering.
getRenderTarget(int) - Static method in enum com.jivesoftware.community.renderer.RenderTarget
A helper method to get a specific RenderTarget object from its key
getRenderType(int) - Static method in enum com.jivesoftware.community.renderer.RenderType
A helper method to get a specific RenderType object from its key
getRenderType(String) - Static method in enum com.jivesoftware.community.renderer.RenderType
 
getReplyTo() - Method in class com.jivesoftware.community.EmailMessage
 
getReportDate() - Method in class com.jivesoftware.community.AbuseReport
Gets the date that this abuse report was created.
getRequest() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getRequest() - Method in class com.jivesoftware.community.widget.BaseWidgetContext
Gets the http servlet request object
getReservedURIs() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a list of reserved words that cannot be used by blog authors as display names.
getResolutionDate() - Method in interface com.jivesoftware.community.Question
Returns the date that question was resolved, or null if the question has not been resolved.
getResolutionDateRangeMax() - Method in class com.jivesoftware.community.QuestionFilter
Returns a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMax() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns a date that represents the upper boundry for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMin() - Method in class com.jivesoftware.community.QuestionFilter
Returns a date that represents the lower boundary for the resolution date of questions to be selected by the result filter.
getResolutionDateRangeMin() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns a date that represents the lower boundary for the resolution date of questions to be selected by the result filter.
getResolutionStates() - Method in class com.jivesoftware.community.QuestionFilter
Returns the set resolution states that will be included in filtered results.
getResolutionStates() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the set resolution states that will be included in filtered results.
getResourceURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The link to the search result resource.
getResponse() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getResponse() - Method in class com.jivesoftware.community.widget.BaseWidgetContext
Gets the http servlet response object
getResponseNotes(JiveObject, JiveObjectModerator.Type, JiveObjectModerator.Type...) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Return a list of response notes for a given object.
getResult() - Method in class com.jivesoftware.community.xmpp.IMManager.ConcurrentConnectionCheckClusterTask
 
getResult() - Method in class com.jivesoftware.community.xmpp.IMManager.ConcurrentPresenceInitCheckClusterTask
 
getResultBlogCount(Blog) - Method in interface com.jivesoftware.community.SearchQuery
Returns the number of blog posts results in the search that match the given blog.
getResultBlogs() - Method in interface com.jivesoftware.community.SearchQuery
Returns an Iterable of the Blogs that search results are from.
getResultCommunities() - Method in interface com.jivesoftware.community.SearchQuery
Returns an Iterable of the Communities that search results are from.
getResultCommunityCount(Community) - Method in interface com.jivesoftware.community.SearchQuery
Returns the number of document results in the search that match the given community.
getResultCount() - Method in interface com.jivesoftware.community.SearchQuery
Returns the total number of results of the query for all result types.
getResultCount(List<SearchQueryResult.ResultType>) - Method in interface com.jivesoftware.community.SearchQuery
Returns the total number of results of the query across the provided list of result types.
getResultCount() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResults
The total number of hits returned by the query.
getResults() - Method in interface com.jivesoftware.community.SearchQuery
Returns the search query results for all result types.
getResults(List<SearchQueryResult.ResultType>) - Method in interface com.jivesoftware.community.SearchQuery
Returns the search query results across the provided list of result types.
getResults(int, int) - Method in interface com.jivesoftware.community.SearchQuery
Returns the results of the query for all result types.
getResults(List<SearchQueryResult.ResultType>, int, int) - Method in interface com.jivesoftware.community.SearchQuery
Returns the results of the query across the provided list of result types.
getResultType() - Method in interface com.jivesoftware.community.SearchQueryResult
Returns the ResultType for this search query result.
getResultType(int) - Static method in enum com.jivesoftware.community.SearchQueryResult.ResultType
A helper method to get a specific ResultType object from its key
getReturnedUserIDs() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
A collection of userids returned by a search using this query.
getReviewerCount() - Method in interface com.jivesoftware.community.Document
Returns the count of reviewers which have been added to this document.
getReviewers() - Method in interface com.jivesoftware.community.Document
Returns the Users who are intended to review the document.
getRewardPoints() - Method in interface com.jivesoftware.community.ForumMessage
 
getRoot() - Method in interface com.jivesoftware.community.TreeWalker
Returns the root of the tree.
getRootCommunity() - Method in interface com.jivesoftware.community.CommunityManager
Returns the "root" community that all other communities are children of.
getRootMessage() - Method in interface com.jivesoftware.community.ForumThread
Returns the root message this thread.
getRoster(User) - Method in interface com.jivesoftware.community.PresenceManager
Returns the user's roster.
getScore() - Method in interface com.jivesoftware.community.Rating
Retrieve the score for the rating.
getSearchableURL(String) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the search URL with the {searchTerms} token substitued by the argument.
getSearchEngineByID(long) - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Find a managed search engine by its ID.
getSearchEngineManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a SearchEngineManager which can be used to manager OpenSearch search engines.
getSearchEngines() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Get a List of all managed search engines.
getSearchHttpMethod() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the Http method (i.e.
getSearchManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the search manager which can be used to manage the index used by Jive to perform searches.
getSearchQueries() - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns an iterable of all the queries that have been made.
getSearchQueries(User) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns an Iterable consisting of all the SearchQuery's that the specified user has made.
getSearchQuery(long) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns the query associated with the given queryID.
getSearchQueryCount() - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns a count of all the queries that have been made in the system.
getSearchQueryCount(User) - Method in interface com.jivesoftware.community.SearchQueryLogger
Returns a count of all the queries that the user has made.
getSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQuery
Returns the criteria that will be used to return results.
getSearchQueryManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the search query manager which can be used to create SearchQuery objects for searching document/messages and blog posts.
getSearchResultContentType() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the content type (i.e. text/xml) of search results.
getSearchURL() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get an OpenSearch compliant URL that can be queried against.
getSearchURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the script that accepts search queries for a blog which is a combination of the base URL, the blog display name and the search path.
getSender() - Method in class com.jivesoftware.community.EmailMessage
Returns the sender of them email
getSender() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the user the message was sent by, or null if the message was sent by the system.
getSenderName() - Method in interface com.jivesoftware.community.Trackback
Returns the sender name of the trackback.
getServerInformation() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns information about the XMPP server as well as some basic statistics.
getServerVersion() - Method in class com.jivesoftware.community.xmpp.IMManager
Returns information about the XMPP server version.
getSession() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getSettings(User) - Method in interface com.jivesoftware.community.WatchManager
Retrieve a watch settings for the given user
getShortMacroName() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns the name of the macro tag Defined by the MacroTagName annotation if defined, otherwise the value of getClass().getShortName() will be used.
getShortMacroName() - Method in interface com.jivesoftware.community.renderer.RenderMacro
Returns the tag name of the macro.
getShortName() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngine
Get the short name of the search engine.
getShowModerated() - Method in class com.jivesoftware.community.ThreadResultFilter
 
getSimilarUserResults(long, int) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns the hits that are similar to the specified user.
getSingleExternalMapping() - Method in class com.jivesoftware.community.user.profile.ProfileField
GetExternalMapping for 1:1 mappings.
getSingleExternalMappings() - Method in class com.jivesoftware.community.user.profile.ProfileField
 
getSize() - Method in interface com.jivesoftware.community.Attachment
Returns the size of the attachment in bytes.
getSize() - Method in interface com.jivesoftware.community.BinaryBody
Returns the size of the body object in bytes.
getSize() - Method in interface com.jivesoftware.community.Image
Returns the size of the image in bytes.
getSize() - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Returns the number of items in the store.
getSkinProperty(Community, String) - Static method in class com.jivesoftware.community.util.SkinUtils
Searches for the property name in the given community.
getSocialGroup(long) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Gets the social group with the given id
getSocialGroup(String) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Gets the social group with the given display name
getSocialGroupCount() - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the total number of groups viewable by the currently authenticated user (as specified by the default group filter)
getSocialGroupCount(SocialGroupResultFilter) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the total number of groups that match the criteria of the given result filter
getSocialGroupImage(SocialGroup, int) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the profile image for a user.
getSocialGroupImageID(SocialGroup, int) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the profile image for a user.
getSocialGroupManager() - Method in interface com.jivesoftware.community.JiveContext
Returns the social group manager which can be used to create SocialGroup objects.
getSocialGroupMember(long) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the group member with the matching membership id
getSocialGroupMembers(SocialGroup) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Gets all users, excluding invited users, that are members of the given social group.
getSocialGroups() - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns all groups viewable by the currently authenticated user (as specified by the default group filter)
getSocialGroups(SocialGroupResultFilter) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns all groups viewable by the currently authenticated user (as specified by the default group filter)
getSort(ProfileSearchManager.SortType) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Return a Lucene Sort object for the specified field
getSort(ProfileSearchManager.SortType, Locale) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Return a Lucene Sort object for the specified field and locale.
getSort() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Gets the sort used for this query.
getSortDocumentField() - Method in class com.jivesoftware.community.DocumentResultFilter
Returns the document field that will be sorted on.
getSortField() - Method in class com.jivesoftware.community.BanFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.QuestionFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.ResultFilter
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.ThreadResultFilter
Returns the currently selected sort field.
getSortOrder() - Method in class com.jivesoftware.community.BanFilter
Sets the currently selected sort order.
getSortOrder() - Method in class com.jivesoftware.community.QuestionFilter
Returns the sort order, which will be QuestionFilter.ASCENDING for ascending sorting, or QuestionFilter.DESCENDING for descending sorting.
getSortOrder() - Method in class com.jivesoftware.community.ResultFilter
Returns the sort order, which will be ResultFilter.ASCENDING for ascending sorting, or ResultFilter.DESCENDING for descending sorting.
getSortOrder() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the sort order, which will be SearchQueryCriteria.SortOrder.ASCENDING for ascending sorting, or SearchQueryCriteria.SortOrder.DESCENDING for descending sorting.
getSortOrder(int) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortOrder
A helper method to get a specific SortOrder object from its key
getSortPropertyName() - Method in class com.jivesoftware.community.QuestionFilter
Returns the name of the extended property that will be sorted on.
getSortPropertyName() - Method in class com.jivesoftware.community.ResultFilter
Returns the name of the extended property that will be sorted on.
getSortType() - Method in interface com.jivesoftware.community.BlogPostSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.DocumentSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.MessageSearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the sort type to use to sort search results.
getSortType(int) - Static method in enum com.jivesoftware.community.SearchQueryCriteria.SortType
A helper method to get a specific SortType object from its key
getSortType() - Method in interface com.jivesoftware.community.TaskSearchQueryCriteria
Returns the sort type to use to sort search results.
getSourceObject() - Method in interface com.jivesoftware.community.renderer.RenderContext
Returns the source object for which we're filtering a string from.
getSpiProperties(String) - Static method in class com.jivesoftware.community.JiveGlobals
 
getSpiProperty(String, String) - Static method in class com.jivesoftware.community.JiveGlobals
 
getSpringBean(String) - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the spring bean with the given ID
getSpringUnManagedDAO() - Method in class com.jivesoftware.base.plugin.PluginManagerImpl
 
getStart() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
The starting index of returned user results, with respect to total hits.
getStartDate() - Method in interface com.jivesoftware.community.Announcement
Returns the date when the announcement should first be visible.
getStartDate() - Method in interface com.jivesoftware.community.Poll
Returns the date voting for the poll is set to start.
getStartIndex() - Method in class com.jivesoftware.community.QuestionFilter
Returns the index of the first result to return.
getStartIndex() - Method in class com.jivesoftware.community.ResultFilter
Returns the index of the first result to return.
getStartupDate() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the date the Jive system was started.
getState() - Method in enum com.jivesoftware.community.DocumentState
 
getState() - Method in interface com.jivesoftware.community.Question
Returns the resolution state of this question.
getStats() - Method in interface com.jivesoftware.community.search.opensearch.SearchEngineManager
Get a {@link SearchEngineManagerStats) object.
getStatus() - Method in interface com.jivesoftware.base.User
Returns the current status of the user in regards to moderation.
getStatus() - Method in class com.jivesoftware.base.UserTemplate
 
getStatus() - Method in interface com.jivesoftware.community.BlogPost
Returns the status of this blog post which may be any one of the following: JiveContentObject.Status.DRAFT -- post has status of unpublished JiveContentObject.Status.PUBLISHED -- post has status of published.
getStatus() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the visibility of the content object.
getStatus() - Method in interface com.jivesoftware.community.Presence
Returns the status of the presence.
getStatus(Project) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the current project status for the given project.
getStatus(long) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the project status for the given status ID.
getStatus() - Method in interface com.jivesoftware.community.Trackback
 
getStatusLevel(long) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to acquire a specific status level object from the system
getStatusLevel(String) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to acquire a specific status level by its name
getStatusLevel(User) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the system wide status level for specific user, will return null if there is no status level for this user.
getStatusLevel(User, JiveContainer) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns the status level for a user in a specific container. if a status level cannot be determined for this user in this container null will be returned.
getStatusLevel(Group) - Method in interface com.jivesoftware.community.StatusLevelManager
If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.
getStatusLevelByPoints(long) - Method in interface com.jivesoftware.community.StatusLevelManager
Used to get a status level by a point value.
getStatusLevelManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a StatusLevelManager that can be used to check a user status level, find leaders system wide or by community.
getStatusLevelScenarioByCode(String) - Method in interface com.jivesoftware.community.StatusLevelManager
Returns a com.jivesoftware.community.StatusLevelScenario by its code.
getStatusManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the status manager.
getStorageManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a StorageManager which can be used to manage storage settings for binary objects such as attachments and images.
getStringValue() - Method in class com.jivesoftware.community.DocumentFieldValue
 
getSubject() - Method in interface com.jivesoftware.community.Announcement
Returns the announcement subject.
getSubject() - Method in interface com.jivesoftware.community.BlogPost
Returns the blog post subject.
getSubject() - Method in interface com.jivesoftware.community.Document
Returns the subject of the document.
getSubject() - Method in interface com.jivesoftware.community.Draft
Returns the subject of the draft.
getSubject() - Method in class com.jivesoftware.community.EmailMessage
Returns the subject of the email.
getSubject() - Method in interface com.jivesoftware.community.ForumMessage
Returns the message subject.
getSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Return the title of the jive object content
getSubject() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message subject.
getSubjectProperty() - Method in class com.jivesoftware.community.EmailMessage
Returns the property name for subject of the email
getSummary() - Method in interface com.jivesoftware.community.Document
Returns the summary of the document.
getTag() - Method in class com.jivesoftware.community.event.TagEvent
Returns the tag that the event corresponds to.
getTag(String) - Method in interface com.jivesoftware.community.TagManager
Returns a tag by tag name.
getTag(long) - Method in interface com.jivesoftware.community.TagManager
Returns a tag given a tag ID.
getTag() - Method in class com.jivesoftware.community.user.profile.ProfileSearchQuery
Get the tag for this query.
getTagCloud(Map<String, Integer>) - Method in interface com.jivesoftware.community.TagManager
Returns a list of com.jivesoftware.community.ContentTagCloudBean objects corresponding to the provided parameters
getTagCloud(Map<String, Integer>, int, int) - Method in interface com.jivesoftware.community.TagManager
Returns a list of com.jivesoftware.community.ContentTagCloudBean objects corresponding to the provided parameters
getTagCount(JiveObject) - Method in interface com.jivesoftware.community.TagManager
Return a count of all the tags associated with this jive object.
getTagDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a tag delegator to manage blog post tags.
getTagDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a tag delegator to manage document tags.
getTagDelegator() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a tag delegator to manage thread tags.
getTagFeedURL(ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed for the system and a given tag.
getTagFeedURL(List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed for the system and a given list of tags.
getTagFeedURL(Blog, ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURL(Blog, List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURL(Blog, String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the tag feed which is a combination of the base URL, the blog display name, the word 'feed-tags' and the given tag or tags.
getTagFeedURLPrefix(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the tag feed URL prefix for a given blog, which the BlogUtils.getTagFeedURL(com.jivesoftware.community.ContentTag) methods depend on.
getTagFeedURLPrefix() - Static method in class com.jivesoftware.community.util.BlogUtils
Returns the tag feed URL prefix for the system tag feeds, which the BlogUtils.getTagFeedURL(com.jivesoftware.community.ContentTag) methods depend on.
getTaggableContent(JiveContainer) - Method in interface com.jivesoftware.community.TagManager
Returns an iterator of taggable jive objects for the specific container.
getTaggableContent(JiveContainer, ResultFilter, TagManager.Taggable...) - Method in interface com.jivesoftware.community.TagManager
Returns an iterator of taggable jive objects for the specific container.
getTaggableContentCount(JiveContainer) - Method in interface com.jivesoftware.community.TagManager
Returns a count of taggable jive objects for the specific container.
getTaggableContentCount(JiveContainer, ResultFilter, TagManager.Taggable...) - Method in interface com.jivesoftware.community.TagManager
Returns a cout of taggable jive objects for the specific container.
getTaggableType(JiveObject) - Static method in enum com.jivesoftware.community.TagManager.Taggable
 
getTaggableTypes() - Method in interface com.jivesoftware.community.JiveContainer
Gets an array of TagManager.Taggables that are enabled for this container.
getTagManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a tag manager that can be used to manage tags.
getTagMap(JiveContainer) - Method in interface com.jivesoftware.community.TagManager
Returns all tags for a given container in a Map where the key is the name of tag and the value is the number of times the tag has been used in this container.
getTagMap(JiveContainer, TagResultFilter, TagManager.Taggable...) - Method in interface com.jivesoftware.community.TagManager
Returns all tags for a given container in a Map where the key is the name of tag and the value is the number of times the tag has been used in this container filtered by the TagResultFilter.
getTagPermalink(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for the system which is a combination of the base URL, the word 'tags' and the tag.
getTagPermalink(Blog, ContentTag) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and the given tag..
getTagPermalink(Blog, List<ContentTag>) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and a list of tags.
getTagPermalink(Blog, String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name, the word 'tags' and the given tag or tags, delimited using a plus (+) sign.
getTags() - Method in interface com.jivesoftware.community.Blog
Returns all tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog.
getTags(BlogTagResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog filtered by the BlogTagResultFilter.
getTags() - Method in interface com.jivesoftware.community.BlogManager
Returns all tags for blogs in the system in a Map where the key is the name of tag and the value is the number of times the tag has been used in this system.
getTags(BlogTagResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all tags for blogs in the system in a Map where the key is the name of tag and the value is the number of times the tag has been used in this system filtered by the BlogTagResultFilter.
getTags() - Method in class com.jivesoftware.community.ResultFilter
Returns the the ContentTags to filter on.
getTags(JiveObject) - Method in interface com.jivesoftware.community.TagManager
Return an Iterable for all the tags associated with this jive object.
getTags() - Method in interface com.jivesoftware.community.TagSet
Returns an Iterable of ContentTags which define the view this TagSet represents.
getTagsAsString(JiveObject) - Method in interface com.jivesoftware.community.TagManager
Return a String for all the tags associated with this jive object.
getTagSet() - Method in class com.jivesoftware.community.event.TagSetEvent
Returns the tag set that the event corresponds to.
getTagSet(long) - Method in interface com.jivesoftware.community.TagSetManager
Returns the TagSet with the supplied id.
getTagSetManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a TagSetManager that can be used to create and load TagSets.
getTagSets(JiveContainer) - Method in interface com.jivesoftware.community.TagSetManager
Returns all TagSets which are defined for the specified JiveContainer.
getTagSetsTagBelongsTo(ContentTag) - Method in interface com.jivesoftware.community.TagSetManager
Returns all TagSets that contains the specified ContentTag.
getTagsPermalink(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a tag permalink for a blog which is a combination of the base URL, the blog display name and the word 'tags'.
getTarget() - Method in class com.jivesoftware.community.renderer.RenderStrategy
 
getTask() - Method in class com.jivesoftware.community.event.TaskEvent
Returns the task that the event corresponds to.
getTask(long) - Method in interface com.jivesoftware.community.project.TaskManager
Retrieves the task with the given id
getTaskCount() - Method in interface com.jivesoftware.community.project.TaskManager
Returns a count of all the incomplete tasks in the system.
getTaskCount(TaskResultFilter) - Method in interface com.jivesoftware.community.project.TaskManager
Returns a count of all the incomplete tasks in the system that match the provided result filter.
getTaskManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the task manager.
getTasks() - Method in interface com.jivesoftware.community.project.TaskManager
Returns a system wide iterator of incomplete tasks.
getTasks(TaskResultFilter) - Method in interface com.jivesoftware.community.project.TaskManager
Returns an iterator of tasks that match the provided result filter.
getTaskSearchQueryCriteria() - Method in interface com.jivesoftware.community.SearchQueryCriteria
Returns the TaskSearchQueryCriteria that can be used to specify criteria to sort and/or filter task search results.
getTaskSortType(int) - Static method in enum com.jivesoftware.community.TaskSearchQueryCriteria.TaskSortType
A helper method to get a specific TaskSortType object from its key
getTemplate() - Method in interface com.jivesoftware.community.DocumentPresenter
Returns the template used to display a document for a particular presenter.
getTermsURL() - Method in interface com.jivesoftware.community.RegistrationManager
Gets the string url representing the terms and conditions page
getText(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
Override the getText(..) in ActionSupport so that we can intercept keys that are specific to either the internal or external editions of Clearspace.
getText(String, String, List, ValueStack) - Method in class com.jivesoftware.community.action.JiveActionSupport
Override the getText(..) in ActionSupport so that we can intercept keys that are specific to either the internal or external editions of Clearspace.
getText(String, String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, List) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String[]) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, List) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String[]) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String, String, String[], OgnlValueStack) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getText(String) - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Retrieve a text snippet from the store.
getText(String, String) - Static method in class com.jivesoftware.community.util.SkinUtils
This method is primarily for accessing the internationalized text bundles when no action context is available (i.e. inside a standalone freemarker context such as the email templating system).
getTextBody() - Method in class com.jivesoftware.community.EmailMessage
Returns the text version of the body.
getTextBodyProperty() - Method in class com.jivesoftware.community.EmailMessage
Return the property name for the html version of the email body
getTextExtractors() - Method in interface com.jivesoftware.community.SearchManager
Returns the current collection of TextExtractor objects.
getTexts() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getTexts(String) - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getTheme() - Static method in class com.jivesoftware.community.util.SkinUtils
Returns the current skin theme or the string "default" to denote the default theme.
getThemeManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a manager for working with themes.
getThread() - Method in class com.jivesoftware.community.event.ThreadEvent
Returns the ForumThread that the event corresponds to.
getThreadCount(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Returns the number of threads in the container.
getThreadCount(TagSet) - Method in interface com.jivesoftware.community.ForumManager
Returns the number of threads in the tag set.
getThreadCount(JiveContainer, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns the number of threads in the container based on the specified ResultFilter.
getThreadCount(TagSet, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns the number of threads in the tag set based on the specified ResultFilter.
getThreads(JiveContainer) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the threads in the container.
getThreads(TagSet) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the threads in the tag set.
getThreads(JiveContainer, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the threads in the container that match the criteria specified by the ResultFilter.
getThreads(TagSet, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an Iterable for all the threads in the tag set that match the criteria specified by the ResultFilter.
getThrowable() - Method in class com.jivesoftware.base.event.LogEvent
 
getTimeZone() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns the page user's time zone.
getTimeZone() - Static method in class com.jivesoftware.community.JiveGlobals
Returns the global TimeZone used by Jive.
getTimeZones() - Method in class com.jivesoftware.community.action.JiveActionSupport
Returns a list of time zones as a double String array.
getTitle() - Method in interface com.jivesoftware.community.search.opensearch.SearchResult
The title of the result (will be displayed on the view).
getTitle() - Method in interface com.jivesoftware.community.Trackback
Returns the title of the trackback.
getTitle(WidgetContext) - Method in interface com.jivesoftware.community.widget.Widget
Returns the default title of the widget
getTitle() - Method in interface com.jivesoftware.community.widget.WidgetLayout
Returns the title of the widget layout
getTokenPattern() - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Returns a Pattern which matches any email token generated by this EmailTokenManager instance.
getTokens() - Method in class com.jivesoftware.community.renderer.RenderedTextStore
Returns a list of all the tokens in the store.
getTopMembers(int) - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Get results corresponding to the top members in the system.
getTotalCount() - Method in class com.jivesoftware.community.search.opensearch.SearchEngineManagerStats
 
getTotalCount() - Method in interface com.jivesoftware.community.SearchManager
Returns the total number of content objects that are to be indexed if an indexing operation is currently active (i.e., SearchManager.isBusy() returns true).
getTotalCount() - Method in interface com.jivesoftware.community.user.profile.ProfileSearchManager
Returns the total number of entries that are to be indexed if an indexing operation is currently active (i.e., ProfileSearchManager.isBusy() returns true).
getTotalMemberships(SocialGroupMemberResultFilter) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the total number of users matching the given result filter.
getTotalUserCount() - Method in interface com.jivesoftware.base.UserManager
Returns the number of user identities known to the system, including external relationships and representations of external users.
getTotalUserCount() - Method in interface com.jivesoftware.community.Roster
Returns the total number of users in the roster.
getTotalUsersInGroup(SocialGroup) - Method in interface com.jivesoftware.community.socialgroup.SocialGroupManager
Returns the total number of owners and members in this social group
getTotalWatchCount(User, int) - Method in interface com.jivesoftware.community.WatchManager
Returns a count of all watches that a user has of a particular type.
getTotalWatchCount(User) - Method in interface com.jivesoftware.community.WatchManager
Returns a count of all watches that a user has for all types.
getTrackback(long) - Method in interface com.jivesoftware.community.Blog
Returns a trackback by trackback ID.
getTrackback() - Method in class com.jivesoftware.community.event.TrackbackEvent
Returns the trackback that the event corresponds to.
getTrackback(long) - Method in interface com.jivesoftware.community.TrackbackManager
Returns the Trackback with the supplied id.
getTrackbackCount() - Method in interface com.jivesoftware.community.Blog
Returns the total number of trackbacks on this blog.
getTrackbackCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns the total number of trackbacks on this blog that match the criteria specified by the ResultFilter.
getTrackbackCount() - Method in interface com.jivesoftware.community.BlogManager
Returns the number of trackbacks on blog posts in the system.
getTrackbackCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns the number of trackbacks on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getTrackbackCount(int, long) - Method in interface com.jivesoftware.community.TrackbackManager
Returns the number of incoming trackbacks on the object with the given objectID and objectType.
getTrackbackCount(FeedbackResultFilter, int, long) - Method in interface com.jivesoftware.community.TrackbackManager
Returns the number of incoming trackbacks on the object with the given objectID and objectType that match the criteria specified by the ResultFilter.
getTrackbackDelegator() - Method in interface com.jivesoftware.community.BlogPost
Retrieve a trackback delegator to manage blog post trackbacks.
getTrackbackDelegator() - Method in interface com.jivesoftware.community.Document
Retrieve a trackback delegator to manage document trackbacks.
getTrackbackDelegator() - Method in interface com.jivesoftware.community.ForumThread
Retrieve a trackback delegator to manage thread trackbacks.
getTrackbackFeedURL(Blog) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the trackbacks feed for a blog.
getTrackbackFeedURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the trackbacks feed for a specific post.
getTrackbackManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the trackback manager.
getTrackbackPermalink(Trackback) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a permalink for a blog trackback which is a combination of the base URL, the blog display name, the year / month / day, the entry name and a suffix / trackback ID.
getTrackbacks(FeedbackResultFilter) - Method in interface com.jivesoftware.community.Blog
Returns all the trackbacks on this blog that match the criteria specified by the ResultFilter.
getTrackbacks(FeedbackResultFilter) - Method in interface com.jivesoftware.community.BlogManager
Returns all the trackbacks on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getTrackbacks(int, long) - Method in interface com.jivesoftware.community.TrackbackManager
Return an Iterable for all the incoming trackbacks on this object.
getTrackbacks(FeedbackResultFilter, int, long) - Method in interface com.jivesoftware.community.TrackbackManager
Returns a Iterable for all the incoming trackbacks on this object that match the criteria specified by the ResultFilter.
getTrackbackURL(BlogPost) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a trackback URL for a blog post which is a combination of the base URL, the blog display name and the post permalink.
getTrackedProjectCount(User) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the number of projects the user is tracking.
getTrackedProjects(User) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns all tracked projects for the given user.
getTransformedTemplate(Document, AuthToken, Locale) - Method in interface com.jivesoftware.community.DocumentPresenter
Applies the template to a Document and returns the results as a string
getTreeWalker() - Method in interface com.jivesoftware.community.ForumThread
Returns the TreeWalker for this thread.
getType() - Method in interface com.jivesoftware.community.Activity
Returns the type of activity this instance represents.
getType() - Method in exception com.jivesoftware.community.AvatarException
 
getType() - Method in interface com.jivesoftware.community.DocumentTypeElement
Returns the type of this DocumentTypeElement.
getType(String) - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Acquires a Type by its string name.
getType(long) - Static method in enum com.jivesoftware.community.DocumentTypeElement.Type
Acquires a Type by its ID.
getType() - Method in class com.jivesoftware.community.EntityDescriptor
Deprecated. EntityDescriptor.getObjectType() should used instead, since it is defined in JiveObject.
getType(int) - Static method in enum com.jivesoftware.community.JiveInterceptor.Type
A helper method to get a specific Type object from its key
getType() - Method in interface com.jivesoftware.community.socialgroup.SocialGroup
Returns the type of the social group.
getType() - Method in class com.jivesoftware.community.user.profile.ProfileField
Returns the ProfileField.Type of this profile field.
getTypeID() - Method in enum com.jivesoftware.community.JiveObjectType
 
getTypeID() - Method in class com.jivesoftware.community.user.profile.ProfileField
Gets the id of the ProfileField.Type of this profile field.
getTypes() - Method in interface com.jivesoftware.community.JiveInterceptor
Returns the interception types the interceptor supports.
getUnApprovedWorkflowBeans(long, JiveObjectModerator.Type, JiveObjectModerator.Type...) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Returns a list of ApprovalWorkflowBean belonging to the specified user ID and of one of the specified JiveObjectModerator.Type.
getUnApprovedWorkflowCount(long, JiveObjectModerator.Type, JiveObjectModerator.Type...) - Method in interface com.jivesoftware.community.impl.dao.ApprovalDAO
Returns a count of the unapproved workflow items belonging to the specified user ID and of any of the specified JiveObjectModerator.Types.
getUnDecoratedDocumentElementName() - Static method in class com.jivesoftware.community.util.SkinUtils
 
getUnfilteredData() - Method in interface com.jivesoftware.community.Attachment
Returns a InputStream for the binary contents of the attachment.
getUnfilteredDocumentFieldValue(DocumentField) - Method in interface com.jivesoftware.community.Document
Returns the value of the document field bypassing any active filters.
getUnfilteredName() - Method in interface com.jivesoftware.community.ContentTag
The unfiltered name of the tag
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Blog
Returns an extended property of the blog, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.BlogPost
Returns an extended property of the blog, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Comment
Returns an extended property of the comment, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Document
Returns an extended property of the document, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.ForumMessage
Returns an extended property of the message, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.PrivateMessage
Returns an extended property of the private message, bypassing any filters.
getUnfilteredProperty(String) - Method in interface com.jivesoftware.community.Trackback
Returns an extended property of the trackback, bypassing any filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.Announcement
Returns the annoucenment subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the subject, bypassing any active filters.
getUnfilteredSubject() - Method in interface com.jivesoftware.community.PrivateMessage
Returns the message subject, bypassing any active filters.
getUnfilteredSummary() - Method in interface com.jivesoftware.community.Document
Returns the document summary, bypassing any active filters.
getUnmodifiableMap() - Static method in class com.jivesoftware.community.JiveGlobals
 
getUnreadMessageCount() - Method in interface com.jivesoftware.community.PrivateMessageFolder
Returns the number of unread messages in the folder.
getUnreadMessageCount(User) - Method in interface com.jivesoftware.community.PrivateMessageManager
Returns the total number of unread private messages a user has in their mailbox.
getUnreadMessageCount(User, JiveContainer) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns the count of unread messages that the user has in the community.
getUnreadMessages(User, JiveContainer) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns an iterable for the unread messages in the community.
getUnreadThreadCount(User, JiveContainer) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns the count of unread threads that the user has in the community.
getUnreadThreads(User, JiveContainer) - Method in interface com.jivesoftware.community.ReadTrackerManager
Returns an iterable for the unread threads in the community.
getUpdateManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the UpdateManager.
getUpgradeManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the upgrade manager.
getURL() - Method in interface com.jivesoftware.community.Comment
Returns the URL of the person that authored this comment.
getUrl() - Method in class com.jivesoftware.community.renderer.BaseMacro
Returns an optional URL for setting this macro's properties or an empty String if none
getUrl() - Method in interface com.jivesoftware.community.renderer.RenderMacro
Returns the optional URL to open when adding this macro
getURL() - Method in interface com.jivesoftware.community.Trackback
Returns the URL of the trackback.
getUser() - Method in class com.jivesoftware.base.event.UserEvent
 
getUser() - Method in class com.jivesoftware.base.plugin.MacroContext
Returns the current user logged in if the user is not a guest, if the user is a guest null will be returned.
getUser(User) - Method in interface com.jivesoftware.base.UserManager
Returns a user matching the given user template.
getUser(User, boolean) - Method in interface com.jivesoftware.base.UserManager
Searches for a user with the given template.
getUser(String) - Method in interface com.jivesoftware.base.UserManager
Loads the user by unique username.
getUser(long) - Method in interface com.jivesoftware.base.UserManager
Retrives a user based on their unique system ID.
getUser() - Method in class com.jivesoftware.community.AbuseReport
Gets the user that created this abuse report.
getUser() - Method in class com.jivesoftware.community.action.JiveActionSupport
NOTE: DO NOT call this method from a DWR-called method.
getUser() - Method in interface com.jivesoftware.community.Activity
Returns the user who performed the activity
getUser() - Method in interface com.jivesoftware.community.Announcement
Returns the User that is the author of the announcemnt.
getUser() - Method in class com.jivesoftware.community.ApprovalStatus
Returns The approval user.
getUser() - Method in interface com.jivesoftware.community.Blog
If this blog is a "user" blog, this method will return the User to whom this blog belongs, otherwise an IllegalStateException will be thrown.
getUser() - Method in interface com.jivesoftware.community.BlogPost
Returns the User that authored this post.
getUser() - Method in interface com.jivesoftware.community.Comment
Returns the user that authored the comment.
getUser() - Method in interface com.jivesoftware.community.Document
Returns the user that authored the document.
getUser() - Method in class com.jivesoftware.community.event.ProfileEvent
 
getUser() - Method in interface com.jivesoftware.community.ForumMessage
Returns the User that authored this message.
getUser() - Method in interface com.jivesoftware.community.JiveContentObject
Returns the user who authored of the jive object.
getUser() - Method in interface com.jivesoftware.community.Poll
Returns the user who created the poll or null if the poll was created anonymously.
getUser() - Method in interface com.jivesoftware.community.Presence
Return the user owning the presence.
getUser() - Method in interface com.jivesoftware.community.project.Project
Returns the user that created this project
getUser() - Method in interface com.jivesoftware.community.Question
Returns the user that created the question.
getUser() - Method in interface com.jivesoftware.community.Roster
Returns the user that this roster belongs to.
getUser() - Method in interface com.jivesoftware.community.SearchQuery
Returns the user that is executing the search.
getUser() - Method in interface com.jivesoftware.community.socialgroup.SocialGroup
Returns the user that created the social group.
getUser() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResult
Gets the user that this search result represents.
getUser() - Method in interface com.jivesoftware.community.Watch
Returns the user who is associated with this watch.
getUser() - Method in class com.jivesoftware.community.widget.BaseWidgetContext
Gets the current page user, or null if annonymous
getUser(User) - Method in interface com.jivesoftware.spi.user.UserProvider
Template-driven search approach.
getUserAndMessageID(String) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Uses the supplied token string to lookup a user id and forums message id.
getUserApprovalDocumentCount(User) - Method in interface com.jivesoftware.community.DocumentManager
Returns a count of all documents that a user needs to approve.
getUserApprovalDocuments(User) - Method in interface com.jivesoftware.community.DocumentManager
Returns all documents that a user needs to approve.
getUserCommandManager() - Method in class com.jivesoftware.community.xmpp.IMManager
 
getUserContainerManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a manager for coordinating activity of user containers.
getUserContentCommentCount(User) - Method in interface com.jivesoftware.community.CommentManager
Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentCommentCount(User, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns a count of all the comments in all content which has been authored by the supplied user that match the criteria specified by the ResultFilter.
getUserContentComments(User) - Method in interface com.jivesoftware.community.CommentManager
Returns a JiveIterator for all the comments in all content which has been authored by the supplied user.
getUserContentComments(User, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.CommentManager
Returns a JiveIterator for all the comments in all content which has been authored by the supplied user that match the criteria specified by the ResultFilter.
getUserCount() - Method in interface com.jivesoftware.community.Blog
Returns the number of users associated with this blog.
getUserCount(Project) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns the count of unique users that own tasks in the specified project
getUserDocumentation(String) - Method in class com.jivesoftware.community.renderer.AbstractRenderFilter
 
getUserDocumentation(String) - Method in interface com.jivesoftware.community.renderer.RenderFilter
Returns a string array of [section,title, body] of xml formatted documentation that is targetted for end user usage.
getUserDocumentCount(User, DocumentState[]) - Method in interface com.jivesoftware.community.DocumentManager
Returns a count of all documents in the supplied DocumentStates a user is an author of.
getUserDocuments(User, DocumentState[]) - Method in interface com.jivesoftware.community.DocumentManager
Returns all documents in the supplied DocumentStates for the supplied user.
getUserFeedURL(String) - Static method in class com.jivesoftware.community.util.BlogUtils
Returns a string containing the path to the feed which is a combination of the base URL, the username and the default system feed type.
getUserFeedURLPrefix() - Static method in class com.jivesoftware.community.util.BlogUtils
 
getUserForJID(JID) - Method in class com.jivesoftware.community.xmpp.IMManager
 
getUserGroups(User) - Method in interface com.jivesoftware.base.GroupManager
Returns an iterator for all groups that a user is a member of.
getUserGroups() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getUserID() - Method in interface com.jivesoftware.base.AuthToken
Returns the userID associated with this AuthToken.
getUserID() - Method in exception com.jivesoftware.base.UserNotFoundException
Returns id of the user not found if available, else -1.
getUserID() - Method in class com.jivesoftware.community.AbuseReport
The user ID of the abuse message.
getUserID() - Method in interface com.jivesoftware.community.Draft
Returns the ID of the user that authored this draft.
getUserID(String) - Method in interface com.jivesoftware.community.mail.EmailTokenManager
Returns just the user id as found in the supplied token string.
getUserID() - Method in class com.jivesoftware.community.QuestionFilter
Returns the ID of the creator of questions that results will be filtered on.
getUserID() - Method in class com.jivesoftware.community.ResultFilter
Returns the userID that results will be filtered on.
getUserIDs() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResults
Get a list of returned userIDs.
getUserManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a UserManager that can be used to manage users.
getUserMessageCount(User) - Method in interface com.jivesoftware.community.ForumManager
Returns the total number of messages a user has posted in all containers.
getUserMessageCount(User, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns the total number of messages a user has posted in all containers that obey the parameters set by the specificed ResultFilter.
getUserMessages(User) - Method in interface com.jivesoftware.community.ForumManager
Returns an iterable for all messages posted by a user.
getUserMessages(User, ThreadResultFilter) - Method in interface com.jivesoftware.community.ForumManager
Returns an iterable for all messages posted by a user that obey the parameters set by the specified ResultFilter.
getUsername() - Method in interface com.jivesoftware.base.User
Returns the user's username.
getUsername() - Method in exception com.jivesoftware.base.UserNotFoundException
Returns username of the user not found if available, else null.
getUsername() - Method in class com.jivesoftware.base.UserTemplate
 
getUsername() - Method in interface com.jivesoftware.community.Presence
Returns the unique username for this status.
getUsernames() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns an unmodifiable Collection of usernames of all users in the system.
getUserRelationshipCount() - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a count of all UserRelationships.
getUserRelationshipCount(UserRelationshipManagerImpl.UserRelationshipResultFilter) - Method in interface com.jivesoftware.community.user.relationships.UserRelationshipManager
Get a filtered count of all UserRelationships.
getUserRelationshipManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a UserRelationshipManager that can be used to manage user relatinosihps.
getUsers() - Method in interface com.jivesoftware.base.UserManager
Returns a list of all users including external users and relationships.
getUsers(int, int) - Method in interface com.jivesoftware.base.UserManager
Returns a set of users starting with the beginning and ending with the ending params.
getUsers() - Method in interface com.jivesoftware.community.Blog
Return all the users given permission to post to this blog.
getUsers(Project) - Method in interface com.jivesoftware.community.project.ProjectManager
Returns an iterator of unique users that own tasks in the specified project
getUsers() - Method in interface com.jivesoftware.community.Roster
Returns an iterator of users in this roster.
getUsers() - Method in class com.jivesoftware.community.user.profile.ProfileSearchResults
Get a list of returned Users.
getUsers() - Method in interface com.jivesoftware.spi.user.UserProvider
Returns an unmodifiable Collections of all users in the system.
getUsers(int, int) - Method in interface com.jivesoftware.spi.user.UserProvider
Returns iterable result set of users, containing size or less users and starting at startIndex.
getUserStatusManager() - Method in interface com.jivesoftware.community.JiveContext
Returns a manager for retrieving and updating of user status information.
getUserTrackedProjects() - Method in class com.jivesoftware.community.action.JiveActionSupport
 
getUserVoteCount() - Method in interface com.jivesoftware.community.Poll
Returns a count of all user votes for all options in the poll.
getUserVoteCount(int) - Method in interface com.jivesoftware.community.Poll
Returns a count of all user votes for the specified option in the poll.
getUserVotes() - Method in interface com.jivesoftware.community.Poll
Returns an Iterator of User objects for users who have voted for any options in the poll.
getUserVotes(int) - Method in interface com.jivesoftware.community.Poll
Returns an Iterator of User objects for users who have voted for the option at the given index.
getUserVotes(User) - Method in interface com.jivesoftware.community.Poll
Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
getValidationMessage() - Method in class com.jivesoftware.community.widget.WidgetFrame
Returns a possible validation message or null if there is none
getValidator() - Method in interface com.jivesoftware.community.DocumentFieldType
Returns the validator for the document field.
getValidator() - Method in interface com.jivesoftware.community.DocumentType
Returns the validator for the document type.
getValue() - Method in class com.jivesoftware.base.event.JivePropertyEvent
Returns the value of the jive property
getValue() - Method in class com.jivesoftware.community.AbuseType
Gets the i18n key that can be used to lookup the text value for this abuse type.
getValue() - Method in class com.jivesoftware.community.BanLevel
Gets the value of a BanLevel object
getValue() - Method in interface com.jivesoftware.community.DocumentFieldOption
Returns the value of the option.
getValue() - Method in interface com.jivesoftware.community.DocumentTypeLabelElement
Returns the getValue of this Document label
getValue() - Method in enum com.jivesoftware.community.renderer.RenderTarget
Gets the value of a RenderTarget object
getValue() - Method in enum com.jivesoftware.community.renderer.RenderType
Gets the value of a RenderType object
getValue() - Method in class com.jivesoftware.community.user.profile.ProfileFieldOption
Gets the value of this option.
getValue() - Method in class com.jivesoftware.community.user.profile.ProfileSearchFilter
Gets the value that will be used to filter the user results.
getValueFromContentTypes(ContentRetrieval.ContentType[]) - Static method in enum com.jivesoftware.community.ContentRetrieval.ContentType
 
getValueFromTaggables(TagManager.Taggable[]) - Static method in enum com.jivesoftware.community.TagManager.Taggable
 
getVersion() - Method in class com.jivesoftware.base.plugin.PluginMetaDataImpl
 
getVersionCommentCount() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the number of comments made on the document version.
getVersionComments() - Method in interface com.jivesoftware.community.DocumentVersion
Returns an iterator of VersionComment objects for all the comments made on the document version.
getVersionID() - Method in interface com.jivesoftware.community.VersionableContentObject
Returns the object's versionID.
getVersionManager() - Method in interface com.jivesoftware.community.Document
Returns the version manager for the document.
getVersionNumber() - Method in interface com.jivesoftware.community.DocumentVersion
Returns the version number of the version of the document.
getViewCount() - Method in interface com.jivesoftware.community.BlogPost
Returns the number of times this blog post has been viewed.
getViewCount() - Method in interface com.jivesoftware.community.Community
Returns the number of times this thread has been community.
getViewCount() - Method in interface com.jivesoftware.community.Document
Returns the number of times this document has been viewed.
getViewCount() - Method in interface com.jivesoftware.community.ForumThread
Returns the number of times this thread has been viewed.
getViewCountManager() - Method in interface com.jivesoftware.community.JiveContext
Returns an instance of the view count manager.
getVoteCount() - Method in interface com.jivesoftware.community.Poll
Returns a count of all votes (both guest and user votes) for all options in the poll.
getVoteCount(int) - Method in interface com.jivesoftware.community.Poll
Returns a count of all votes (both guest and user votes) for the specified option in the poll.
getWatch(User, JiveObject) - Method in interface com.jivesoftware.community.WatchManager
Returns a watch on