Package com.jivesoftware.community

Core interfaces and classes for Clearspace.

See:
Description

Interface Summary

AbuseManager	Manages all aspects of reporting abuse and managing abuse reports.
Activity	Represents activity within a community.
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.
ArchiveManager	Manages the archive feature of Jive.
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.
AvatarManager	Manages the avatar feature.
BanManager	Manages the banning of User Accounts and IP Addresses.
BinaryBody	An object that encapsulates a binary document body.
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.
BlogPost	A container for blog post data and for a hierarchy of blog comments.
BlogPostSearchQueryCriteria	Search criteria specific to searching blog posts may be specified using this criteria class.
Comment	A comment provides a way for users to annotate or give feedback on a JiveContentObject.
CommentManager	Handles comments for a JiveObject.
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.
ContentRetrieval	Interface for accessing threads, messages, documents, blog posts and task - all the fundamental content elements in the system.
ContentTag	Container for tags associated with a taggable object.
Document	A Document object encapsulates a document in Clearspace.
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.
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.
DocumentManager	This manager provides methods to load documents and to retrieve popular documents.
DocumentPresenter	Similar to the DocumentBuilder interface, document presenters allow for organizing the fields of a document type into an optimal layout for display.
DocumentSearchQueryCriteria	Search criteria specific to searching documents may be specified using this criteria class.
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).
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.
EmailManager	Provides ability to send email messages.
ForumManager	This manager provides methods to load forum threads, user messages and to retrieve popular forum threads.
ForumMessage	A ForumMessage encapsulates message data.
ForumThread	A ForumThread is a container for a hierarchy of ForumMessages.
Image	An object that encapsulates an image.
ImageContentResource	A base interface defining images methods.
ImageManager	Manages image settings.
InterceptorManager	Manages interceptors.
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.
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.
JiveIterator<T extends JiveObject>	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
JiveProperties<K,V>	An extension of the Map interface to add support for getting child property names or a Collection of all property names.
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.
MultiOptionDocumentField	An extension of the document field interface to support multi optioned field types such as radio and selection lists.
OldModerationManager	Manages the moderation feature within Clearspace
PermissionsManager	Manages permissions for users and groups on a particular resource.
Poll	A poll can be attached to any object in the system or can exist at the global level.
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.
PrivateMessage	Private messages are used for user to user communication.
PrivateMessageFolder	Holds private messages.
PrivateMessageManager	Manages the private message feature.
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.
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.
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.
SearchQueryLogger	This interface provides methods to retrieve query objects previously used for searching.
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.
StatusLevel	Represents a status Level in the system.
StatusLevelCalculator	Defines methods need to calculate status levels and leaders.
StatusLevelManager	Manages status level feature.
StorageManager	Manages the storage of binary objects and determines whether binary object data is stored on the file system or in the database.
Taggable	Deprecated.
TagManager	Provides a manager to create, retrieve and delete tags.
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.
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.
Watchable	Deprecated.
WatchManager	Manages watches on jive objects.

Class Summary

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
ApprovalStatus	Contains information on whether a user has approved a document edit and when.
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.
BlogPostResultFilter	Filters and sorts BlogPosts.
BlogTagResultFilter	Filters and sorts tags with specific fields for Blogs.
CommentResultFilter	Filters and sorts lists of Comments.
DocumentFieldValue	Bean holder for document field values.
DocumentResultFilter	Filters and sorts lists of Documents.
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.
JiveConstants	Contains constant values representing various objects in Clearspace.
JiveGlobals	This class controls access to a number of global propeties in the applcation.
JiveGlobals.ResetLocalizationSettingsClusterTask
ModerationFilter	Filters and sorts lists of ForumMessages based upon the message's moderation and abuse value.
Permissions	Represents a set of permissions that an entity has for an object in the system.
PermissionType	A class to represent the two modes of permissions - additive and negative.
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.
ResultFilter	Abstract base class for Clearspace result filters.
TagResultFilter	Filters and sorts JiveContentObjects based on ContentTags.
ThreadResultFilter	Filters and sorts lists of ForumThreads and ForumMessages.

Enum Summary

Activity.Type	Defines a specific type of activity with regard to a piece of content.
BlogPostSearchQueryCriteria.BlogPostSortType	Represents how message blog post queries will be sorted
ContentRetrieval.ContentType	Enumeration of the primary three types of content elements in the system.
DocumentFieldType.DataType	Represents the XMPP data form field type.
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.
DocumentTypeElement.Type	Simple enumerated type for Document elements.
JiveContentObject.Field
JiveContentObject.Status
JiveInterceptor.Type	Represents the different ways a JiveInterceptor may be run
JiveObjectType	An enum for jive objects types
MessageSearchQueryCriteria.MessageSortType	Represents how message search queries will be sorted
Permissions.PermissionAtom
SearchQueryCriteria.SortOrder	Represents the order in which search results will be returned
SearchQueryCriteria.SortType	Represents how search results will be sorted
SearchQueryResult.ResultType	Represents the different types of results that can be queried upon
TagManager.Taggable	Enumeration of the primary three types of content elements in the system.
TaskSearchQueryCriteria.TaskSortType	Represents how task search queries will be sorted

Exception Summary

AnnouncementNotFoundException	Thrown if the specified Announcement was not found.
AttachmentException	Thrown if an error occurs uploading or updating an Attachment.
AttachmentNotFoundException	Thrown if the specified Attachment was not found.
AvatarException	Thrown if there are problems with creation of an Avatar
AvatarNotFoundException	Thrown if the specified Avatar was not found.
BanException	Thrown when a user performs an action that they have been banned from performing.
BinaryBodyException	Thrown if there are problems with creation or loading of a BinaryBody.
BlogNotFoundException	Thrown if the specified Blog was not found.
BlogPostNotFoundException	Thrown if the specified BlogPost was not found.
CommentNotFoundException	Thrown if the specified Comment was not found
CommunityNotFoundException	Thrown if the specified Community was not found
DocumentAlreadyExistsException	Thrown whenever a Document's title is set to be the same as a title to an existing published document.
DocumentObjectNotFoundException	Thrown if the specified Document was not found
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.
ForumMessageNotFoundException	Thrown if the specified ForumMessage was not found
ForumThreadNotFoundException	Thrown if the specified ForumThread was not found
ImageException	Thrown if there are problems with creation or loading of an Image.
InvalidLanguageException	Thrown when attempting to specify a language that is not among the list of allowed languages.
JiveException	Base exception class for all Jive exceptions.
JiveRuntimeException	Base exception class for all Jive runtime exceptions.
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.
PollException	A poll exception is thrown by methods in the Poll class.
PresenterTemplateException	Thrown if there are errors processing a presentation template
PrivateMessageFolderNotFoundException	Thrown if the specified PrivateMessageFolder was not found
PrivateMessageNotFoundException	Thrown when a PrivateMessage was not found
PrivateMessageRejectedException	Thrown when a PrivateMessage is prevented from being posted.
RejectedException	Thrown by a JiveInterceptor when a jive object is prevented from being posted.
StatusLevelAlreadyExistsException	Thrown when attempting to create a StatusLevel that already exists in the system
StatusLevelException	The StatusLevelException is thrown by the StatusLevel class.
StatusLevelNotFoundException	Thrown by StatusLevelManager when attempting to acquire or perform an operation on a status level that does not exist.

Annotation Types Summary

DefaultImplementation	Used to specify what the default implementation is on an interface of a JiveManager
Replaceable	Used to Mark a JiveManager as replaceable by the user and specifies the jive property key to find the manager implementation.

Package com.jivesoftware.community Description

Core interfaces and classes for Clearspace.