Uses of Package
com.jivesoftware.community

Packages that use com.jivesoftware.community

com.jivesoftware.base	Base APIs and classes for Jive Software products.
com.jivesoftware.base.plugin	Plugin API for extending the core API with custom functionality.
com.jivesoftware.community	Core interfaces and classes for Clearspace.
com.jivesoftware.community.action	Clearspace WebWork actions.
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	Data access objects for core Clearspace objects.
com.jivesoftware.community.lifecycle	Provides application lifecycle management for Clearspace.
com.jivesoftware.community.moderation
com.jivesoftware.community.project
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.search.opensearch
com.jivesoftware.community.socialgroup
com.jivesoftware.community.user.profile
com.jivesoftware.community.util	Clearspace utility classes.
com.jivesoftware.community.widget
com.jivesoftware.community.xmpp	XMPP integration classes to integrate XMPP with Clearspace.

Classes in com.jivesoftware.community used by com.jivesoftware.base

AttachmentContentResource
A marker interface to denote objects that support attachments.

JiveException
Base exception class for all Jive exceptions.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

JiveRuntimeException
Base exception class for all Jive runtime exceptions.

NotFoundException
Thrown when trying to load an object that does not exist, or the object could not be loaded.

Permissions
Represents a set of permissions that an entity has for an object in the system.

Classes in com.jivesoftware.community used by com.jivesoftware.base.plugin

JiveContentObject
A base object that most content objects in Clearspace implement.

JiveContext
A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application.

JiveManager
An interface that all Jive Managers should implement.

JiveProperties
An extension of the Map interface to add support for getting child property names or a Collection of all property names.

Classes in com.jivesoftware.community used by com.jivesoftware.community

AbuseManager
Manages all aspects of reporting abuse and managing abuse reports.

AbuseReport
This class contains all the necessary information to file an abuse report.

AbuseType
A typesafe enum class that contains various abuse types used for reporting abuse

Activity
Represents activity within a community.

Activity.Type
Defines a specific type of activity with regard to a piece of content.

ActivityManager
This manager provides methods to retrieve recent activities and popular threads, documents and blog posts.

Announcement
Alerts users to important information.

AnnouncementManager
Manages announcements, including viewing, creating, and deleting them.

AnnouncementNotFoundException
Thrown if the specified Announcement was not found.

ApprovalStatus
Contains information on whether a user has approved a document edit and when.

ArchiveManager
Manages the archive feature of Jive.

Attachment
An object that encapsulates an attachment.

AttachmentContentResource
A marker interface to denote objects that support attachments.

AttachmentException
Thrown if an error occurs uploading or updating an Attachment.

AttachmentManager
Manages attachment settings.

AttachmentNotFoundException
Thrown if the specified Attachment was not found.

Avatar
An object that represents a user's avatar.

AvatarException
Thrown if there are problems with creation of an Avatar

AvatarManager
Manages the avatar feature.

Ban
Represents a ban object.

BanFilter
Filters and sorts lists of Ban objects.

BanLevel
A typesafe-enum class containing key/value pairs representing BanLevel objects.

BanManager
Manages the banning of User Accounts and IP Addresses.

BinaryBody
An object that encapsulates a binary document body.

BinaryBodyException
Thrown if there are problems with creation or loading of a BinaryBody.

BinaryBodyManager
Manages binary body settings.

Blog
A container for a list of blog postings by a user or group of users.

BlogManager
Manages blogs, including viewing, creating, and deleting them.

BlogNotFoundException
Thrown if the specified Blog was not found.

BlogPost
A container for blog post data and for a hierarchy of blog comments.

BlogPostNotFoundException
Thrown if the specified BlogPost was not found.

BlogPostResultFilter
Filters and sorts BlogPosts.

BlogPostSearchQueryCriteria
Search criteria specific to searching blog posts may be specified using this criteria class.

BlogPostSearchQueryCriteria.BlogPostSortType
Represents how message blog post queries will be sorted

BlogTagResultFilter
Filters and sorts tags with specific fields for Blogs.

Comment
A comment provides a way for users to annotate or give feedback on a JiveContentObject.

CommentManager
Handles comments for a JiveObject.

CommentNotFoundException
Thrown if the specified Comment was not found

CommentResultFilter
Filters and sorts lists of Comments.

CommentTreeWalker
Allows hierarchical navigation of comments.

Community
A container for threads, documents and a hierarchy of other communities.

CommunityManager
This manager provides methods to load communities by ID and to retrieve the root community.

CommunityNotFoundException
Thrown if the specified Community was not found

ContentRetrieval.ContentType
Enumeration of the primary three types of content elements in the system.

ContentTag
Container for tags associated with a taggable object.

Document
A Document object encapsulates a document in Clearspace.

DocumentAlreadyExistsException
Thrown whenever a Document's title is set to be the same as a title to an existing published document.

DocumentAttributes
Attributes for documents -- recommendation status and published status.

DocumentField
The DocumentType interface allows for an arbitrary number of document fields to be created for each document type.

DocumentFieldAttributes
Document field attributes consist of properties which control how the field is used throughout the system.

DocumentFieldFormatter
Document field formatters format a document field for display to the end user.

DocumentFieldManager
Manages the creation and deletion of document fields in Clearspace.

DocumentFieldOption
Container object for document field options.

DocumentFieldType
Type information that can be associated with a DocumentField.

DocumentFieldType.DataType
Represents the XMPP data form field type.

DocumentFieldTypeManager
Manages the creation and deletion of Document Field Types for Clearspace.

DocumentFieldValidator
Document field validators validate a document field value as entered or selected by the end user.

DocumentFieldValue
Bean holder for document field values.

DocumentManager
This manager provides methods to load documents and to retrieve popular documents.

DocumentObjectNotFoundException
Thrown if the specified Document was not found

DocumentPresenter
Similar to the DocumentBuilder interface, document presenters allow for organizing the fields of a document type into an optimal layout for display.

DocumentResultFilter
Filters and sorts lists of Documents.

DocumentSearchQueryCriteria
Search criteria specific to searching documents may be specified using this criteria class.

DocumentSearchQueryCriteria.DocumentSortType
Represents how document search queries will be sorted

DocumentState
Throughout the document lifecycle a document will have different documents states appropriate to where it is along the lifecycle.

DocumentType
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
This class gives the DocumentType the ability to handle kinds entities (DocumentFields, document, and summaries).

DocumentTypeElement.Type
Simple enumerated type for Document elements.

DocumentTypeLabelElement
Used to specify labels in the DocumentCreation process

DocumentTypeManager
Handles the creation, deletion, and access of DocumentTypes.

DocumentTypeSectionElement
Used to specify a Section of Elements in the Document creation process.

DocumentTypeValidator
A document type validator is useful to validate document input when there are interdepencies between multiple document fields.

DocumentVersion
Information about a document's version is stored and retrieved using this interface.

Draft
A container for a draft of a message of any type.

DraftManager
Manages the draft features of Clearspace.

DuplicateIDException
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.

EmailManager
Provides ability to send email messages.

EmailMessage
Represents an Email message that can be sent using EmailManager

EmailMessage.EmailAddress
Represents an email address with a name like Andrew Wright <andrew@jivesoftware.com>

EntityDescriptor
An object that describes a specific entity.

FeedbackResultFilter
Filters and sorts blog comments and blog trackbacks.

ForumManager
This manager provides methods to load forum threads, user messages and to retrieve popular forum threads.

ForumMessage
A ForumMessage encapsulates message data.

ForumMessageNotFoundException
Thrown if the specified ForumMessage was not found

ForumThread
A ForumThread is a container for a hierarchy of ForumMessages.

ForumThreadNotFoundException
Thrown if the specified ForumThread was not found

Image
An object that encapsulates an image.

ImageContentResource
A base interface defining images methods.

ImageException
Thrown if there are problems with creation or loading of an Image.

ImageManager
Manages image settings.

InterceptorManager
Manages interceptors.

InvalidLanguageException
Thrown when attempting to specify a language that is not among the list of allowed languages.

JiveContainer
A base container object that most jive container objects will implement

JiveContentObject
A base object that most content objects in Clearspace implement.

JiveContentObject.Field

JiveContentObject.Status

JiveException
Base exception class for all Jive exceptions.

JiveHierarchicalContainer
A base container object that jive container objects that can be nested will implement

JiveInterceptor
A jive interceptor encapsulates an action that is invoked on a jive object immediately before or after it is added to the system and also when the object's subject or body is being edited.

JiveInterceptor.Type
Represents the different ways a JiveInterceptor may be run

JiveIterator
An extension of the Iterator class which allows backwards and forwards iteration, looking up of the ID of next element as well as setting an index into the iteration.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

JiveObjectType
An enum for jive objects types

JiveRuntimeException
Base exception class for all Jive runtime exceptions.

LinkManager
Manages links between objects in the system.

LocaleManager
Manages Locale settings for various objects.

MessageSearchQueryCriteria
Search criteria specific to searching messages may be specified using this criteria class.

MessageSearchQueryCriteria.MessageSortType
Represents how message search queries will be sorted

ModerationFilter
Filters and sorts lists of ForumMessages based upon the message's moderation and abuse value.

NameAlreadyExistsException
Thrown if the specified name already exists on the object.

NotFoundException
Thrown when trying to load an object that does not exist, or the object could not be loaded.

NotUniqueException
Thrown by an object when an action is attempted on an object where a parameter (say a name) has to be unique but is not.

OldModerationManager
Manages the moderation feature within Clearspace

Permissions
Represents a set of permissions that an entity has for an object in the system.

Permissions.PermissionAtom

PermissionsManager
Manages permissions for users and groups on a particular resource.

PermissionType
A class to represent the two modes of permissions - additive and negative.

Poll
A poll can be attached to any object in the system or can exist at the global level.

PollException
A poll exception is thrown by methods in the Poll class.

PollManager
Provides a manager to create, retrieve and delete polls.

Presence
A Presence encapsulates information relating to the owning user such as login time, status and last update time.

PresenceManager
The presence manager creates presences and keeps track on a global basis who's online.

PresenterTemplateException
Thrown if there are errors processing a presentation template

PrivateMessage
Private messages are used for user to user communication.

PrivateMessageFolder
Holds private messages.

PrivateMessageFolderNotFoundException
Thrown if the specified PrivateMessageFolder was not found

PrivateMessageManager
Manages the private message feature.

PrivateMessageNotFoundException
Thrown when a PrivateMessage was not found

PrivateMessageRejectedException
Thrown when a PrivateMessage is prevented from being posted.

Question
Questions provide additional workflow around a thread; the thread creator asks a question and the question moves from unresolved to resolved as one or more answers are posted to the question.

Question.State
Type-safe enumeration for the state a question is in.

QuestionFilter
Filters and sorts lists of questions from QuestionManager.

QuestionFilter.SortField
Type-safe enumeration for field that be sorted on.

QuestionManager
Manages questions.

Rating
A container object for Ratings.

RatingManager
Provides optional rating of JiveContentObjects.

ReadTracker
A way to track the read status of forum threads and messages.

ReadTrackerManager
Manages objects that track the read status of forum threads and messages.

RecentContentManager
This manager provides methods to retrieve recent content.

RegistrationManager
Manages validation settings and validating new user accounts.

RejectedException
Thrown by a JiveInterceptor when a jive object is prevented from being posted.

ResultFilter
Abstract base class for Clearspace result filters.

Roster
A roster is a list of users that the user wishes to know if they are online.

SearchManager
Manages the search feature of Clearspace by defining properties of the search indexer.

SearchQuery
Encapsulates a search for message, document or blog post content.

SearchQueryCriteria
Criteria for searching.

SearchQueryCriteria.SortOrder
Represents the order in which search results will be returned

SearchQueryCriteria.SortType
Represents how search results will be sorted

SearchQueryManager
This manager provides methods to create query objects to be used for searching either the whole system or just in particular areas such as communities.

SearchQueryResult
Encapsulates a search result resulting from a search using the SearchQuery class.

SearchQueryResult.ResultType
Represents the different types of results that can be queried upon

StatusLevel
Represents a status Level in the system.

StatusLevelAlreadyExistsException
Thrown when attempting to create a StatusLevel that already exists in the system

StatusLevelException
The StatusLevelException is thrown by the StatusLevel class.

StatusLevelManager
Manages status level feature.

StatusLevelNotFoundException
Thrown by StatusLevelManager when attempting to acquire or perform an operation on a status level that does not exist.

StorageManager
Manages the storage of binary objects and determines whether binary object data is stored on the file system or in the database.

TagManager
Provides a manager to create, retrieve and delete tags.

TagManager.Taggable
Enumeration of the primary three types of content elements in the system.

TagResultFilter
Filters and sorts JiveContentObjects based on ContentTags.

TagSet
A TagSet is a named collection of ContentTags used to build filtered content views.

TagSetManager
Manages the creation, deletion and lookup of TagSets.

TaskSearchQueryCriteria
Search criteria specific to searching tasks may be specified using this criteria class.

TaskSearchQueryCriteria.TaskSortType
Represents how task search queries will be sorted

ThreadResultFilter
Filters and sorts lists of ForumThreads and ForumMessages.

Trackback
A container for jive trackback data.

TrackbackManager
Manages the trackback feature within Clearspace

TreeWalker
Allows hierarchical navigation of a Thread.

VersionableContentObject
An interface for objects which implement a versionID.

VersionComment
Encapsulates a comment on a document version.

VersionManager
Manages document versions.

Watch
A watch is a way for a user to track updates to an object.

WatchManager
Manages watches on jive objects.

Classes in com.jivesoftware.community used by com.jivesoftware.community.action

BanManager
Manages the banning of User Accounts and IP Addresses.

ContentTag
Container for tags associated with a taggable object.

JiveContainer
A base container object that most jive container objects will implement

JiveContentObject
A base object that most content objects in Clearspace implement.

JiveContext
A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application.

JiveObject
An interface for jive objects that contains two method common to all jive objects

NotFoundException
Thrown when trying to load an object that does not exist, or the object could not be loaded.

RegistrationManager
Manages validation settings and validating new user accounts.

Classes in com.jivesoftware.community used by com.jivesoftware.community.event

Announcement
Alerts users to important information.

Attachment
An object that encapsulates an attachment.

AttachmentContentResource
A marker interface to denote objects that support attachments.

AttachmentManager
Manages attachment settings.

Avatar
An object that represents a user's avatar.

Blog
A container for a list of blog postings by a user or group of users.

BlogPost
A container for blog post data and for a hierarchy of blog comments.

Comment
A comment provides a way for users to annotate or give feedback on a JiveContentObject.

Community
A container for threads, documents and a hierarchy of other communities.

ContentTag
Container for tags associated with a taggable object.

Document
A Document object encapsulates a document in Clearspace.

EmailMessage
Represents an Email message that can be sent using EmailManager

ForumMessage
A ForumMessage encapsulates message data.

ForumThread
A ForumThread is a container for a hierarchy of ForumMessages.

Image
An object that encapsulates an image.

JiveContainer
A base container object that most jive container objects will implement

JiveContentObject.Status

JiveObject
An interface for jive objects that contains two method common to all jive objects

Poll
A poll can be attached to any object in the system or can exist at the global level.

PrivateMessage
Private messages are used for user to user communication.

Question
Questions provide additional workflow around a thread; the thread creator asks a question and the question moves from unresolved to resolved as one or more answers are posted to the question.

TagSet
A TagSet is a named collection of ContentTags used to build filtered content views.

Trackback
A container for jive trackback data.

Classes in com.jivesoftware.community used by com.jivesoftware.community.impl.dao

JiveObject
An interface for jive objects that contains two method common to all jive objects

Classes in com.jivesoftware.community used by com.jivesoftware.community.lifecycle

JiveContext
A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application.

Classes in com.jivesoftware.community used by com.jivesoftware.community.moderation

JiveContainer
A base container object that most jive container objects will implement

JiveContentObject.Status

JiveObject
An interface for jive objects that contains two method common to all jive objects

JiveObjectType
An enum for jive objects types

Classes in com.jivesoftware.community used by com.jivesoftware.community.project

JiveContainer
A base container object that most jive container objects will implement

JiveHierarchicalContainer
A base container object that jive container objects that can be nested will implement

JiveIterator
An extension of the Iterator class which allows backwards and forwards iteration, looking up of the ID of next element as well as setting an index into the iteration.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

NotFoundException
Thrown when trying to load an object that does not exist, or the object could not be loaded.

Classes in com.jivesoftware.community used by com.jivesoftware.community.renderer

JiveContainer
A base container object that most jive container objects will implement

JiveContentObject
A base object that most content objects in Clearspace implement.

JiveContentObject.Field

JiveContext
A JiveContext is used to access managers that can be used to add, retrieve, modify and delete content in the system as well as control the behaviour of the application.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

Classes in com.jivesoftware.community used by com.jivesoftware.community.search.opensearch

JiveException
Base exception class for all Jive exceptions.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

JiveRuntimeException
Base exception class for all Jive runtime exceptions.

Classes in com.jivesoftware.community used by com.jivesoftware.community.socialgroup

AttachmentContentResource
A marker interface to denote objects that support attachments.

AttachmentException
Thrown if an error occurs uploading or updating an Attachment.

ContentRetrieval.ContentType
Enumeration of the primary three types of content elements in the system.

JiveContainer
A base container object that most jive container objects will implement

JiveIterator
An extension of the Iterator class which allows backwards and forwards iteration, looking up of the ID of next element as well as setting an index into the iteration.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

NameAlreadyExistsException
Thrown if the specified name already exists on the object.

NotFoundException
Thrown when trying to load an object that does not exist, or the object could not be loaded.

Classes in com.jivesoftware.community used by com.jivesoftware.community.user.profile

AttachmentException
Thrown if an error occurs uploading or updating an Attachment.

Community
A container for threads, documents and a hierarchy of other communities.

JiveManager
An interface that all Jive Managers should implement.

Classes in com.jivesoftware.community used by com.jivesoftware.community.util

Blog
A container for a list of blog postings by a user or group of users.

BlogPost
A container for blog post data and for a hierarchy of blog comments.

Comment
A comment provides a way for users to annotate or give feedback on a JiveContentObject.

Community
A container for threads, documents and a hierarchy of other communities.

ContentTag
Container for tags associated with a taggable object.

ForumMessage
A ForumMessage encapsulates message data.

ForumThread
A ForumThread is a container for a hierarchy of ForumMessages.

JiveObject
An interface for jive objects that contains two method common to all jive objects

Trackback
A container for jive trackback data.

Classes in com.jivesoftware.community used by com.jivesoftware.community.widget

Community
A container for threads, documents and a hierarchy of other communities.

JiveException
Base exception class for all Jive exceptions.

JiveManager
An interface that all Jive Managers should implement.

JiveObject
An interface for jive objects that contains two method common to all jive objects

Classes in com.jivesoftware.community used by com.jivesoftware.community.xmpp

JiveContainer
A base container object that most jive container objects will implement

JiveManager
An interface that all Jive Managers should implement.