|
Clearspace API (1.7.0) Core Javadocs | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use JiveObject | |
|---|---|
| com.jivesoftware.base | Base APIs and classes for Jive Software products. |
| com.jivesoftware.community | Core interfaces and classes for Clearspace. |
| com.jivesoftware.community.event | Provides mechanisms to be notified of actions in the system such as new messages being created. |
| 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.widget | |
| Uses of JiveObject in com.jivesoftware.base |
|---|
| Subinterfaces of JiveObject in com.jivesoftware.base | |
|---|---|
interface |
Group
Organizes users into a group for easier permissions management. |
interface |
IntrospectiveGroup
This Group subinterface adds the ability to query what optional capabilities are supported in this Group implementation. |
interface |
IntrospectiveUser
This User subinterface adds the ability to query what optional capabilities are supported in this User implementation. |
interface |
User
The User interface provides information about and services for users of the system. |
| Uses of JiveObject in com.jivesoftware.community |
|---|
| Classes in com.jivesoftware.community with type parameters of type JiveObject | |
|---|---|
interface |
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. |
| Subinterfaces of JiveObject in com.jivesoftware.community | |
|---|---|
interface |
Announcement
Alerts users to important information. |
interface |
Attachment
An object that encapsulates an attachment. |
interface |
Avatar
An object that represents a user's avatar. |
interface |
BinaryBody
An object that encapsulates a binary document body. |
interface |
Blog
A container for a list of blog postings by a user or group of users. |
interface |
BlogPost
A container for blog post data and for a hierarchy of blog comments. |
interface |
Comment
A comment provides a way for users to annotate or give feedback on a JiveContentObject. |
interface |
Community
A container for threads, documents and a hierarchy of other communities. |
interface |
ContentTag
Container for tags associated with a taggable object. |
interface |
Document
A Document object encapsulates a document in Clearspace. |
interface |
DocumentField
The DocumentType interface allows for an arbitrary number of document fields to be created for each document type. |
interface |
DocumentFieldOption
Container object for document field options. |
interface |
DocumentFieldType
Type information that can be associated with a DocumentField. |
interface |
DocumentPresenter
Similar to the DocumentBuilder interface, document presenters allow for organizing the fields of a document type into an optimal layout for display. |
interface |
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. |
interface |
DocumentTypeElement
This class gives the DocumentType the ability to handle kinds entities (DocumentFields, document, and summaries). |
interface |
DocumentTypeLabelElement
Used to specify labels in the DocumentCreation process |
interface |
DocumentTypeSectionElement
Used to specify a Section of Elements in the Document creation process. |
interface |
Draft
A container for a draft of a message of any type. |
interface |
ForumMessage
A ForumMessage encapsulates message data. |
interface |
ForumThread
A ForumThread is a container for a hierarchy of ForumMessages. |
interface |
Image
An object that encapsulates an image. |
interface |
JiveContentObject
A base container object that most content objects in Clearspace implement. |
interface |
MultiOptionDocumentField
An extension of the document field interface to support multi optioned field types such as radio and selection lists. |
interface |
Poll
A poll can be attached to any object in the system or can exist at the global level. |
interface |
PrivateMessage
Private messages are used for user to user communication. |
interface |
PrivateMessageFolder
Holds private messages. |
interface |
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. |
interface |
SearchQuery
Encapsulates a search for message, document or blog post content. |
interface |
StatusLevel
Represents a status Level in the system. |
interface |
TagSet
A TagSet is a named collection of ContentTags used to build filtered content views. |
interface |
Trackback
A container for jive trackback data. |
| Methods in com.jivesoftware.community with type parameters of type JiveObject | ||
|---|---|---|
|
WatchManager.getAllWatches(User user)
Returns an iterable for all objects that a user is watching. |
|
|
WatchManager.getAllWatches(User user,
int objectType)
Returns an iterable for all objects of a particular type that a user is watching. |
|
| Methods in com.jivesoftware.community that return JiveObject | |
|---|---|
JiveObject |
Activity.getContainerObject()
Returns the parent object of the piece of content this activity pertains to, or null if no parent exists. |
JiveObject |
Activity.getJiveObject()
Returns the jive object this activity pertains to. |
JiveObject |
Comment.getJiveObject()
Returns the parent JiveContentObject of the comment. |
JiveObject |
RejectedException.getJiveObject()
Returns the jive object that triggered the exception. |
JiveObject |
CommunityManager.getJiveObject(int objectType,
long objectID)
Returns the JiveObject with the supplied objectType and objectID or null if the
specified objectType is not a valid JiveObject. |
static JiveObject |
JiveGlobals.getJiveObjectFromURL(JiveContext jiveContext,
java.lang.String url)
Returns a JiveObject that matches the specified url or null if no object matches
the specified url. |
| Methods in com.jivesoftware.community that return types with arguments of type JiveObject | |
|---|---|
JiveIterator<JiveObject> |
WatchManager.getWatches(User user,
Community community)
Returns an Iterable for all the Community objects a user is watching in a community. |
| Methods in com.jivesoftware.community with parameters of type JiveObject | |
|---|---|
void |
CommentManager.addComment(JiveObject contentObject,
Comment newComment)
Adds a new comment (no parent) to the object. |
void |
CommentManager.addComment(JiveObject contentObject,
Comment parentComment,
Comment newComment)
Adds a new comment having a parent comment to the object. |
void |
StatusLevelManager.addPoints(User user,
Community community,
JiveObject object,
long points,
java.lang.String code)
Rewards points to a user. |
void |
RatingManager.addRating(User user,
JiveObject contentObject,
Rating rating)
Add a rating to the JiveContentObject. |
void |
TagManager.addTag(ContentTag tag,
JiveObject contentObject)
Associates a tag with this object |
boolean |
RatingManager.canRate(User user,
JiveObject contentObject)
Returns whether the user can rate the JiveContentObject or not. |
Comment |
CommentManager.createComment(JiveObject contentObject,
User user,
java.lang.String body)
Create a new comment. |
Watch |
WatchManager.createWatch(User user,
JiveObject jiveObject)
Create a watch on a jive object for the specified user. |
void |
CommentManager.deleteAllComments(JiveObject contentObject)
Deletes all comments on the object. |
void |
CommentManager.deleteComment(JiveObject contentObject,
Comment comment)
Deletes a comment in the object. |
void |
CommentManager.deleteComment(JiveObject contentObject,
Comment comment,
boolean recursive)
Deletes a comment in the object. |
static java.lang.String |
TagManagerFactory.getCacheKey(JiveObject contentObject)
Returns a tag content cache key. |
Comment |
CommentManager.getComment(JiveObject contentObject,
long commentID)
Returns a comment from the object based on its id. |
int |
CommentManager.getCommentCount(JiveObject contentObject)
Returns the number of comments in the object. |
int |
CommentManager.getCommentCount(JiveObject contentObject,
CommentResultFilter resultFilter)
Returns the number of comments in the object based on the specified ResultFilter. |
JiveIterator<Comment> |
CommentManager.getComments(JiveObject contentObject)
Returns an iterable for all the comments in the object. |
JiveIterator<Comment> |
CommentManager.getComments(JiveObject contentObject,
CommentResultFilter resultFilter)
Returns an Iterable for all the comments in the object that match the criteria specified by the ResultFilter. |
java.util.Date |
CommentManager.getCommentsCreationDate(JiveObject contentObject)
Convenience method that return the date that the first comment was created. |
java.util.Date |
CommentManager.getCommentsModificationDate(JiveObject contentObject)
Convenience method that returns the date of the latest comment modification in the object. |
CommentTreeWalker |
CommentManager.getCommentTreeWalker(JiveObject contentObject)
Returns a CommentTreeWalker for the comments in the object. |
static java.lang.String |
JiveGlobals.getJiveObjectURL(JiveObject jiveObject)
Returns the full (including domain name as set in the jiveURL jive property ) URL to this JiveObject or the default base url if the jive content object does not have
a specific url. |
JiveIterator<JiveContentObject> |
LinkManager.getLinkingObjects(JiveObject targetContentObject)
Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject. |
java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> |
LinkManager.getLinks(JiveObject sourceJiveObject)
Retrieve all the links in a particular jive object (With the exception of internal anchor links). |
double |
RatingManager.getMeanRating(JiveObject contentObject)
A convenience method which returns a geometric mean average of all the ratings given to the JiveContentObject. |
Rating |
RatingManager.getRating(User user,
JiveObject contentObject)
Returns the rating associated with the user, or null if this user hasn't rated the JiveContentObject. |
int |
RatingManager.getRatingCount(JiveObject contentObject)
Returns the total number of ratings given to the JiveContentObject. |
java.lang.Iterable<Rating> |
RatingManager.getRatings(JiveObject contentObject)
Returns an Iterable of all the ratings given to the JiveContentObject. |
JiveIterator<ContentTag> |
TagManager.getTags(JiveObject contentObject)
Return an Iterable for all the tags associated with this manager. |
Watch |
WatchManager.getWatch(User user,
JiveObject jiveObject)
Returns a watch on a particular JiveObject, or null if there isn't a watch. |
boolean |
RatingManager.hasRated(User user,
JiveObject contentObject)
Returns whether the user has rated the JiveContentObject or not. |
void |
JiveInterceptor.invokeInterceptor(JiveObject jiveObject,
JiveInterceptor.Type type)
Invokes the interceptor on the specified jive object. |
boolean |
WatchManager.isWatched(User user,
JiveObject jiveObject)
Returns true if the user is watching the specified jive object. |
void |
RatingManager.removeAllRatings(JiveObject contentObject)
Remove all ratings from the specified content object |
void |
TagManager.removeAllTags(JiveObject contentObject)
Disassociates this object with all tags. |
void |
RatingManager.removeRating(User user,
JiveObject contentObject)
Removes a rating to the JiveContentObject. |
void |
TagManager.removeTag(ContentTag tag,
JiveObject contentObject)
Disassociates this object with the given tag. |
void |
CommentManager.updateComment(JiveObject contentObject,
Comment comment)
Updates an existing comment. |
void |
LinkManager.updateLinks(JiveObject sourceJiveObject,
java.util.List<com.jivesoftware.community.renderer.filter.wiki.link.Link> links)
Updates all stored link for the provided source object. |
| Constructors in com.jivesoftware.community with parameters of type JiveObject | |
|---|---|
RejectedException(java.lang.String rejectionMessage,
JiveObject object)
|
|
RejectedException(java.lang.Throwable nestedThrowable,
JiveObject object)
|
|
| Uses of JiveObject in com.jivesoftware.community.event |
|---|
| Methods in com.jivesoftware.community.event that return JiveObject | |
|---|---|
JiveObject |
DocumentEvent.getIdentifiedObject()
Return an Identifier if document is null and documentID is not. |
JiveObject |
MessageEvent.getIdentifiedObject()
Return an Identifier if message is null and messageID is not. |
JiveObject |
ThreadEvent.getIdentifiedObject()
Return an Identifier if thread is null and threadID is not. |
JiveObject |
AttachmentEvent.getJiveObject()
|
JiveObject |
ImageEvent.getJiveObject()
|
| Constructors in com.jivesoftware.community.event with parameters of type JiveObject | |
|---|---|
AttachmentEvent(int eventType,
JiveObject jiveObject,
Attachment attachment,
java.util.Map<java.lang.String,? extends java.lang.Object> params)
|
|
AttachmentEvent(int eventType,
JiveObject jiveObject,
Attachment attachment,
java.util.Map<java.lang.String,? extends java.lang.Object> params,
java.io.File file)
|
|
AttachmentEvent(int eventType,
JiveObject jiveObject,
Attachment attachment,
java.util.Map<java.lang.String,? extends java.lang.Object> params,
java.io.File file,
AttachmentManager attachmentManager)
|
|
ImageEvent(int eventType,
JiveObject jiveObject,
Image image,
java.util.Map<java.lang.String,? extends java.lang.Object> params)
|
|
| Uses of JiveObject in com.jivesoftware.community.renderer |
|---|
| Methods in com.jivesoftware.community.renderer that return JiveObject | |
|---|---|
JiveObject |
RenderContext.getSourceObject()
Returns the source object for which we're filtering a string from. |
| Methods in com.jivesoftware.community.renderer with parameters of type JiveObject | |
|---|---|
java.lang.String |
RenderManager.render(JiveObject source,
RenderType renderType,
RenderStrategy strategy,
java.lang.String string)
Applies filters to the specified string. |
java.lang.String |
RenderManager.render(JiveObject source,
RenderType renderType,
java.lang.String string)
Applies filters to the specified string. |
| Uses of JiveObject in com.jivesoftware.community.search.opensearch |
|---|
| Subinterfaces of JiveObject in com.jivesoftware.community.search.opensearch | |
|---|---|
interface |
SearchEngine
A SearchEngine is an external source that can be searched. |
| Uses of JiveObject in com.jivesoftware.community.widget |
|---|
| Methods in com.jivesoftware.community.widget with parameters of type JiveObject | |
|---|---|
void |
WidgetManager.copyWidgetFrames(JiveObject sourceObject,
JiveObject destinationObject)
Copies the WidgetFrames from the source JiveObject to the destination JiveObject. |
void |
WidgetManager.discardWidgetFrames(JiveObject jiveObject)
Discards the draft WidgetFrames for the specified parent JiveObject. |
java.util.Map<java.lang.Integer,java.util.List<com.jivesoftware.community.widget.WidgetFrame>> |
WidgetManager.getPublishedWidgetFrames(JiveObject jiveObject)
Returns the map containing all the published WidgetFrames for the specified parent
JiveObject. |
java.util.Map<java.lang.Integer,java.util.List<com.jivesoftware.community.widget.WidgetFrame>> |
WidgetManager.getWidgetFrames(JiveObject object)
Returns the map containing all the draft WidgetFrames for the specified parent JiveObject. |
void |
WidgetManager.publishWidgetFrames(JiveObject jiveObject)
Publishes the WidgetFrames for the specified parent JiveObject. |
void |
WidgetManager.updateWidgetFrames(JiveObject jiveObject,
java.util.List<com.jivesoftware.community.widget.WidgetFrame> widgetFrames)
Updates the list of WidgetFrames. |
|
Clearspace Project Page | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||