Clearspace API (2.5.29) Core Javadocs

Uses of Interface
com.jivesoftware.community.JiveObject

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.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.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.util Clearspace utility classes. 
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 User
          The User interface provides information about and services for users of the system.
 

Classes in com.jivesoftware.base that implement JiveObject
 class UserTemplate
          Value Object implementation of the user interface, optimized for Jive's internal caching mechanism.
 

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 AttachmentContentResource
          A marker interface to denote objects that support attachments.
 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 com.jivesoftware.community.CommentContentResource
           
 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 JiveContainer
          A base container object that most jive container objects will implement
 interface JiveContentObject
          A base object that most content objects in Clearspace implement.
 interface JiveHierarchicalContainer
          A base container object that jive container objects that can be nested will 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.
 interface com.jivesoftware.community.VersionableAttachmentContentResource
           
 interface VersionableContentObject
          An interface for objects which implement a versionID.
 

Classes in com.jivesoftware.community that implement JiveObject
 class Ban
          Represents a ban object.
 class EntityDescriptor
          An object that describes a specific entity.
 

Methods in com.jivesoftware.community with type parameters of type JiveObject
<A extends JiveObject>
Iterable<A>
WatchManager.getAllWatches(User user)
          Returns an iterable for all objects that a user is watching.
<A extends JiveObject>
Iterable<A>
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 AbuseReport.getJiveObject()
          Gets the forum message that caused this abuse report.
 JiveObject Activity.getJiveObject()
          Returns the jive object this activity pertains to.
 JiveObject RejectedException.getJiveObject()
          Returns the jive object that triggered the exception.
 JiveObject SearchQueryResult.getJiveObject()
          This method returns a JiveContentObject this query result pertains to.
 

Methods in com.jivesoftware.community that return types with arguments of type JiveObject
 JiveIterator<JiveObject> TagManager.getTaggableContent(JiveContainer container)
          Returns an iterator of taggable jive objects for the specific container.
 JiveIterator<JiveObject> TagManager.getTaggableContent(JiveContainer container, ResultFilter resultFilter, TagManager.Taggable... taggableTypes)
          Returns an iterator of taggable jive objects for the specific container.
 JiveIterator<JiveObject> WatchManager.getWatches(User user, JiveContainer container)
          Returns an Iterable for all the objects a user is watching in a container.
 

Methods in com.jivesoftware.community with parameters of type JiveObject
 void ActivityManager.addActivity(JiveObject object, JiveObject parent, User user, Activity.Type activityType)
          Adds a new activity to the ActivityManager
 void StatusLevelManager.addPoints(User user, JiveContainer container, JiveObject object, long points, String code)
          Rewards points to a user.
 void StatusLevelManager.addPoints(User user, JiveContainer container, JiveObject jiveObject, String scenarioCode)
          Give points to a user using the specified scenerio code.
 void RatingManager.addRating(User user, JiveObject contentObject, Rating rating)
          Add a rating to the JiveContentObject.
 void TagManager.addTag(ContentTag tag, JiveObject jiveObject)
          Associates a tag with this object
 boolean RatingManager.canRate(User user, JiveObject contentObject)
          Returns whether the user can rate the JiveContentObject or not.
 int StatusLevelManager.countTimesAwarded(User user, JiveObject target)
          Counts the number of times a user has been awarded against a particular object.
 Watch WatchManager.createWatch(User user, JiveObject jiveObject)
          Create a watch on a jive object for the specified user.
 List<AbuseReport> AbuseManager.getAbuseReports(JiveObject message)
          Gets a list of open abuse reports for a particular message
 JiveIterator<JiveContentObject> LinkManager.getLinkingObjects(JiveObject targetContentObject)
          Returns a list of unique JiveContentObjects which link to the supplied target JiveContentObject.
 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.
 int AbuseManager.getNumberOfAbuseReports(JiveObject message)
          Gets the number of abuse reports for a particular message
 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.
 Iterable<Rating> RatingManager.getRatings(JiveObject contentObject)
          Returns an Iterable of all the ratings given to the JiveContentObject.
 int TagManager.getTagCount(JiveObject jiveObject)
          Return a count of all the tags associated with this jive object.
static TagManager.Taggable TagManager.Taggable.getTaggableType(JiveObject object)
           
 JiveIterator<ContentTag> TagManager.getTags(JiveObject jiveObject)
          Return an Iterable for all the tags associated with this jive object.
 String TagManager.getTagsAsString(JiveObject jiveObject)
          Return a String for all the tags associated with this jive object.
 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.
 boolean AbuseManager.hasUserReportedAbuse(JiveObject message, User user)
          Checks if a user has already reported abuse for a particular message.
 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.
static JiveContainer JiveGlobals.jiveContainerFor(JiveObject source)
           
 void RatingManager.removeAllRatings(JiveObject contentObject)
          Remove all ratings from the specified content object
 void TagManager.removeAllTags(JiveObject jiveObject)
          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 jiveObject)
          Disassociates this object with the given tag.
 void AbuseManager.resolveAbuseReports(JiveObject message)
          REsolves all abuse reports for a particular message
 void AbuseReport.setJiveObject(JiveObject jiveObject)
          Sets the forum message that caused this abuse report.
 void TagManager.setTags(String tags, JiveObject jiveObject)
          Sets tags for the specified jive object.
 void LinkManager.updateLinks(JiveObject sourceJiveObject, 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
EntityDescriptor(JiveObject bean)
          Creates an EntityDescriptor instance from an existing JiveObject.
RejectedException(String rejectionMessage, JiveObject object)
           
RejectedException(Throwable nestedThrowable, JiveObject object)
           
 

Uses of JiveObject in com.jivesoftware.community.action
 

Methods in com.jivesoftware.community.action with parameters of type JiveObject
 Document JiveActionSupport.unknownContentToJiveDoc(String rawText, JiveObject contentObject)
           
 

Uses of JiveObject in com.jivesoftware.community.event
 

Methods in com.jivesoftware.community.event that return JiveObject
 JiveObject DocumentEvent.getIdentifiedObject()
          Return an EntityDescriptor if document is null and documentID is not.
 JiveObject MessageEvent.getIdentifiedObject()
          Return an EntityDescriptor if message is null and messageID is not.
 JiveObject TaskEvent.getIdentifiedObject()
          Return an EntityDescriptor if thread is null and threadID is not.
 JiveObject ThreadEvent.getIdentifiedObject()
          Return an EntityDescriptor if thread is null and threadID is not.
 JiveObject ImageEvent.getJiveObject()
           
 

Constructors in com.jivesoftware.community.event with parameters of type JiveObject
ImageEvent(int eventType, JiveObject jiveObject, Image image, Map<String,? extends Object> params)
           
 

Uses of JiveObject in com.jivesoftware.community.impl.dao
 

Methods in com.jivesoftware.community.impl.dao with parameters of type JiveObject
 List<com.jivesoftware.community.impl.dao.ApprovalWorkflowNote> ApprovalDAO.getResponseNotes(JiveObject jiveObject, JiveObjectModerator.Type queueType, JiveObjectModerator.Type... queueTypes)
          Return a list of response notes for a given object.
 com.jivesoftware.community.impl.dao.ApprovalWorkflowBean ApprovalDAO.getWorkflowBean(JiveObject jiveObject, long approverUserId, JiveObjectModerator.Type queueType, JiveObjectModerator.Type... queueTypes)
          Returns a specific workflow according to the object and the user approving the workflow's user ID.
 List<com.jivesoftware.community.impl.dao.ApprovalWorkflowBean> ApprovalDAO.getWorkflowBeans(JiveObject jiveObject, JiveObjectModerator.Type queueType, JiveObjectModerator.Type... queueTypes)
          Returns a list of ApprovalWorkflowBean by typeID and objectID of a given JiveObject
 

Uses of JiveObject in com.jivesoftware.community.moderation
 

Methods in com.jivesoftware.community.moderation that return JiveObject
 JiveObject ModerationStrategy.finishCallback(Long workflowID, JiveObject jiveObject)
          Handles the finish call back.
 

Methods in com.jivesoftware.community.moderation with parameters of type JiveObject
 void ModerationStrategy.approvalCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the approval callback.
 void JiveObjectModerator.approve(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Approves the workflow for the given workflow ID and JiveObject.
 void ModerationStrategy.approve(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Approves the workflow for the given workflow ID and JiveObject.
 JiveObject ModerationStrategy.finishCallback(Long workflowID, JiveObject jiveObject)
          Handles the finish call back.
 Set<Long> ModerationStrategy.getModerators(JiveObject jiveObject)
          Retrieves a list of unique User IDs representing the available moderators for a given JiveObject.
 void JiveObjectModerator.handleApprovalCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the approval callback.
 void JiveObjectModerator.handleFinishCallback(Long workflowID, JiveObject jiveObject)
          Handles the finish call back.
 void JiveObjectModerator.handleNewCallback(User user, long entryID, JiveObject jiveObject, Set<Long> moderators, String requestMessage)
          Handles the new callback.
 void JiveObjectModerator.handleRejectedCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the rejection callback.
 void JiveObjectModerator.handleStateChangeCallback(JiveObject jiveObject, JiveContentObject.Status status)
          Handles any state changes for a given object.
 boolean JiveObjectModerator.isModerationEnabled(JiveObject jiveObject, User user)
          Determines if moderation for the given JiveObject is enabled.
 boolean JiveObjectModerator.isModerator(JiveObject jiveObject, User user)
          Determines if the given User is a moderator for the given JiveObject.
 void JiveObjectModerator.moderate(JiveObject jiveObject, User user)
          Puts the JiveObject into the moderation queue.
 void ModerationStrategy.newCallback(User user, long entryID, JiveObject jiveObject, Set<Long> moderators, String requestMessage)
          Handles the new callback.
 void JiveObjectModerator.notificationCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the notification callback.
 void ModerationStrategy.notificationCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the notification callback.
 void JiveObjectModerator.reject(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Rejects the workflow for the given workflow ID and JiveObject.
 void ModerationStrategy.reject(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Rejects the workflow for the given workflow ID and JiveObject.
 void ModerationStrategy.rejectionCallback(Long workflowID, JiveObject jiveObject, User user, String responseMessage)
          Handles the rejection callback.
 boolean ModerationStrategy.shouldModerate(JiveObject jiveObject, User user)
          Determines if moderation for the given JiveObject is enabled.
 void ModerationStrategy.startWorkflow(JiveObject jiveObject, User user, String requestMessage)
          Puts the JiveObject into the moderation queue.
 void ModerationStrategy.stateChangeCallback(JiveObject jiveObject, JiveContentObject.Status status)
          Handles any state changes for a given object.
 

Uses of JiveObject in com.jivesoftware.community.project
 

Subinterfaces of JiveObject in com.jivesoftware.community.project
 interface Project
          A container for threads, documents and tasks.
 

Classes in com.jivesoftware.community.project that implement JiveObject
 class CheckPoint
           
 

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
 String RenderManager.render(JiveObject source, RenderStrategy strategy, Document doc)
          Applies filters to the specified string.
 String RenderManager.render(JiveObject source, RenderStrategy strategy, 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.socialgroup
 

Subinterfaces of JiveObject in com.jivesoftware.community.socialgroup
 interface SocialGroup
          The container representing social groups in Clearspace.
 

Uses of JiveObject in com.jivesoftware.community.util
 

Methods in com.jivesoftware.community.util with parameters of type JiveObject
 String IconGenerator.getIcon(JiveObject object, boolean returnAsCssClass, int type)
          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.
static String SkinUtils.getJiveObjectIcon(JiveObject object, boolean returnAsCssClass, int type)
          Returns an icon path or a css class name for the icon to associate with the given jive object.
 

Uses of JiveObject in com.jivesoftware.community.widget
 

Methods in com.jivesoftware.community.widget that return JiveObject
 JiveObject WidgetFrame.getParentObject()
          Gets the parent JiveObject of this frame
 

Methods in com.jivesoftware.community.widget with parameters of type JiveObject
 void WidgetManager.addWidgetLayout(JiveObject jiveObject, WidgetLayout layout)
          Creates a new draft WidgetLayout for the specified JiveObject.
 void WidgetManager.discardWidgetFrames(JiveObject jiveObject)
          Discards the draft WidgetFrames for the specified parent JiveObject.
 void WidgetManager.discardWidgetLayout(JiveObject jiveObject)
          Discards the draft WidgetLayout for the specified parent JiveObject.
 void WidgetManager.duplicateWidgetFrames(JiveObject sourceObject, JiveObject destinationObject)
          Duplicates the WidgetFrames from the source JiveObject to the destination JiveObject.
 Map<Integer,List<WidgetFrame>> WidgetManager.getPublishedWidgetFrames(JiveObject jiveObject)
          Returns the map containing all the published WidgetFrames for the specified parent JiveObject.
 WidgetLayout WidgetManager.getPublishedWidgetLayout(JiveObject jiveObject)
          Returns the published WidgetLayout for the specified parent JiveObject.
 Map<Integer,List<WidgetFrame>> WidgetManager.getWidgetFrames(JiveObject object)
          Returns the map containing all the draft WidgetFrames for the specified parent JiveObject.
 WidgetLayout WidgetManager.getWidgetLayout(JiveObject jiveObject)
          Returns the draft WidgetLayout for the specified parent JiveObject.
 void WidgetManager.publishWidgetFrames(JiveObject jiveObject)
          Publishes the WidgetFrames for the specified parent JiveObject.
 void WidgetManager.publishWidgetLayout(JiveObject jiveObject)
          Publishes the WidgetLayout for the specified parent JiveObject.
 void WidgetFrame.setParentObject(JiveObject parentObject)
          Sets the parent JiveObject of this frame
 void WidgetManager.updateWidgetFrames(JiveObject jiveObject, List<WidgetFrame> widgetFrames)
          Updates the list of WidgetFrames.
 


Clearspace Project Page

Copyright © 1999-2007 Jive Software.