|
Clearspace API (2.5.29) Core Javadocs | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use JiveContainer | |
|---|---|
| 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.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.socialgroup | |
| com.jivesoftware.community.xmpp | XMPP integration classes to integrate XMPP with Clearspace. |
| Uses of JiveContainer in com.jivesoftware.community |
|---|
| Subinterfaces of JiveContainer in com.jivesoftware.community | |
|---|---|
interface |
Blog
A container for a list of blog postings by a user or group of users. |
interface |
Community
A container for threads, documents and a hierarchy of other communities. |
interface |
JiveHierarchicalContainer
A base container object that jive container objects that can be nested will implement |
| Methods in com.jivesoftware.community that return JiveContainer | |
|---|---|
JiveContainer |
Blog.getJiveContainer()
Returns the parent container to which this blog belongs. |
JiveContainer |
Comment.getJiveContainer()
Returns the container object of the document. |
JiveContainer |
Document.getJiveContainer()
Returns the container object of the document. |
JiveContainer |
ForumMessage.getJiveContainer()
Returns the container object of the message. |
JiveContainer |
ForumThread.getJiveContainer()
Returns the container object of the thread. |
JiveContainer |
TagSet.getJiveContainer()
Returns the JiveContainer to which this TagSet is bound. |
static JiveContainer |
JiveGlobals.jiveContainerFor(JiveObject source)
|
| Methods in com.jivesoftware.community that return types with arguments of type JiveContainer | |
|---|---|
Map<JiveContainer,Long> |
StatusLevelManager.getAllPointLevels(User user)
Returns a map of community -> status level points for all the communities the user has points in. |
List<JiveContainer> |
OldModerationManager.getContainers()
This method will return a list of containers where the user is a moderator. |
| Methods in com.jivesoftware.community with parameters of type JiveContainer | |
|---|---|
void |
DocumentManager.addDocument(JiveContainer container,
Document document,
Map parameters)
Add a document as a child of a container. |
void |
DocumentManager.addDocument(JiveContainer container,
Document document,
com.jivesoftware.community.impl.PermissionsBundle permBundle,
Map parameters)
Add a document as a child of the container with permissions defined by the provided permission bundle. |
void |
DocumentManager.addDocumentApprover(JiveContainer container,
User user)
Add the user as a document approver for this entire container. |
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 |
ForumManager.addThread(JiveContainer container,
ForumThread thread)
Adds a new thread to the container. |
Announcement |
AnnouncementManager.createAnnouncement(User user,
JiveContainer jiveContainer)
Creates a new community announcement. |
Blog |
BlogManager.createBlog(JiveContainer container)
Creates a new blog. |
ForumMessage |
ForumManager.createMessage(JiveContainer container)
Factory method to create a message with an anonymous author. |
ForumMessage |
ForumManager.createMessage(JiveContainer container,
User user)
Factory method to create a message as the specified user. |
TagSet |
TagSetManager.createTagSet(String name,
String description,
com.jivesoftware.util.LongList tagIDs,
JiveContainer container)
Creates a new TagSet with the supplied name, description, and tags. |
ForumThread |
ForumManager.createThread(JiveContainer container,
ForumMessage rootMessage)
Factory method to create a new thread. |
int |
AnnouncementManager.getAnnouncementCount(JiveContainer jiveContainer)
Returns the count of all currently viewable announcements in a container. |
int |
AnnouncementManager.getAnnouncementCount(JiveContainer jiveContainer,
boolean recursive)
Returns the count of all currently viewable announcements in a container. |
int |
AnnouncementManager.getAnnouncementCount(JiveContainer jiveContainer,
Date startDate,
Date endDate)
Returns the count of all announcements in a container that are viewable within the specified date range. |
JiveIterator<Announcement> |
AnnouncementManager.getAnnouncements(JiveContainer jiveContainer)
Returns all currently viewable announcements in a container. |
JiveIterator<Announcement> |
AnnouncementManager.getAnnouncements(JiveContainer jiveContainer,
Date startDate,
Date endDate)
Returns the announcements in a container that are viewable within a specified date range. |
Blog |
BlogManager.getBlog(JiveContainer container)
Returns the blog for the given container. |
int |
BlogManager.getBlogPostCount(JiveContainer container)
Returns the number of blog posts associated with this container. |
int |
BlogManager.getBlogPostCount(JiveContainer container,
BlogPostResultFilter resultFilter)
Returns the number of blog posts in all blogs associated with the container based on the specified ResultFilter. |
JiveIterator<BlogPost> |
BlogManager.getBlogPosts(JiveContainer container)
Returns the blog posts associated with this container. |
JiveIterator<BlogPost> |
BlogManager.getBlogPosts(JiveContainer container,
BlogPostResultFilter resultFilter)
Returns the blog posts in all blogs associated with the container based on the specified ResultFilter. |
JiveIterator<JiveContentObject> |
CommunityManager.getCombinedContent(JiveContainer container,
ContentRetrieval.ContentType... contentTypes)
Returns an Iterable for all threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument. |
JiveIterator<JiveContentObject> |
CommunityManager.getCombinedContent(JiveContainer container,
ResultFilter filter,
ContentRetrieval.ContentType... contentTypes)
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. |
int |
CommunityManager.getCombinedContentCount(JiveContainer container,
ContentRetrieval.ContentType... contentTypes)
Returns the combined number of threads, documents, and blog posts in the container, depending on which ContentRetrieval.ContentTypes are supplied as an argument. |
int |
CommunityManager.getCombinedContentCount(JiveContainer container,
ResultFilter filter,
ContentRetrieval.ContentType... contentTypes)
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. |
Document |
DocumentManager.getDocument(JiveContainer container,
String subject)
Returns a document from a container based on its subject. |
Collection<User> |
DocumentManager.getDocumentApprovers(JiveContainer container)
Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state. |
int |
DocumentManager.getDocumentCount(JiveContainer container)
Returns the number of published documents in the container. |
int |
DocumentManager.getDocumentCount(JiveContainer container,
DocumentResultFilter resultFilter)
Returns the number of documents in the container {and possibly all child containers (if the container is a community)} based on the specified ResultFilter. |
JiveIterator<Document> |
DocumentManager.getDocuments(JiveContainer container)
Returns an Iterable for all the published documents in the container. |
JiveIterator<Document> |
DocumentManager.getDocuments(JiveContainer container,
DocumentResultFilter resultFilter)
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. |
JiveIterator<Document> |
DocumentManager.getDocumentsUnderEdit(JiveContainer container)
Returns the count of the number of documents currently being editted in the container. |
int |
DocumentManager.getDocumentsUnderEditCount(JiveContainer container)
Returns an Iterable of documents currently being editted in the container. |
Document |
DocumentManager.getLatestDocument(JiveContainer container)
Returns the most recently created or edited document in this container (including all sub-communities). |
ForumMessage |
ForumManager.getLatestMessage(JiveContainer container)
Returns the most recently created or edited message in this container (including all sub-containers if applicable). |
long[] |
StatusLevelCalculator.getLeaderIds(JiveContainer container,
int startIndex,
int numResults)
Returns a long array of user ids of community leaders given a start index and desired number of results. |
Iterable<User> |
StatusLevelManager.getLeaders(JiveContainer container)
Returns an Iterable of leaders for a specific container |
Iterable<User> |
StatusLevelManager.getLeaders(JiveContainer container,
int startIndex,
int numResults)
Returns an Iterable of leaders for a specific container |
int |
ForumManager.getMessageCount(JiveContainer container)
Acquire the count of all messages for a specified container. |
int |
OldModerationManager.getMessageCount(JiveContainer container)
Gets the number of moderated messages in a container |
int |
ForumManager.getMessageCount(JiveContainer container,
ThreadResultFilter resultFilter)
The account of messages for the JiveContainer with the ThreadResultFilter applied. |
int |
OldModerationManager.getMessageCount(ModerationFilter modFilter,
JiveContainer container)
Gets the number of moderated messages in a container |
JiveIterator<ForumMessage> |
ForumManager.getMessages(JiveContainer container)
Returns an Iterable for all the messages in the container. |
Iterable<ForumMessage> |
OldModerationManager.getMessages(JiveContainer container)
Gets a list of moderated messages for a particular container. |
JiveIterator<ForumMessage> |
ForumManager.getMessages(JiveContainer container,
ThreadResultFilter resultFilter)
Returns an Iterable for all the messages in the container that match the criteria specified by the ResultFilter. |
Iterable<ForumMessage> |
OldModerationManager.getMessages(ModerationFilter modFilter,
JiveContainer container)
Gets a list of moderated messages for a particular container. |
long |
StatusLevelCalculator.getPointLevel(User user,
JiveContainer container)
Returns the status level points for a user in regards to a specific community |
long |
StatusLevelManager.getPointLevel(User user,
JiveContainer container)
Returns the status level points for a user in regards to a specific container |
JiveIterator<Document> |
ActivityManager.getPopularDocuments(JiveContainer jiveContainer)
Returns a JiveIterator of popular documents for the container in popularity order. |
JiveIterator<Document> |
DocumentManager.getPopularDocuments(JiveContainer c)
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. |
JiveIterator<ForumThread> |
ActivityManager.getPopularThreads(JiveContainer jiveContainer)
Returns a JiveIterator of popular threads for the container in popularity order. |
int |
QuestionManager.getQuestionCount(JiveContainer container)
Returns the count of all questions in a container. |
int |
QuestionManager.getQuestionCount(JiveContainer container,
QuestionFilter questionFilter)
Returns the count of questions in a container that pass the specified question filter. |
JiveIterator<Question> |
QuestionManager.getQuestions(JiveContainer container)
Returns an iterable for all questions in a container. |
JiveIterator<Question> |
QuestionManager.getQuestions(JiveContainer container,
QuestionFilter questionFilter)
Returns an iterable for all questions in a categetory that pass the specified question filter. |
boolean |
ReadTrackerManager.getReadStatus(JiveContainer c,
User user,
int type)
Returns true if the user has the specified read status on the object, false otherwise. |
Iterable<Activity> |
ActivityManager.getRecentActivity(JiveContainer jiveContainer)
Returns all the recent activities that have occurred in the specified container and all subcontainers. |
Iterable<Activity> |
ActivityManager.getRecentActivity(JiveContainer jiveContainer,
com.google.common.base.Predicate<com.jivesoftware.community.ActivityBean> predicate)
Returns all the recent activities matching the provided predicate that have occurred in the specified container and all subcontainers. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecentContent(JiveContainer jiveContainer)
Returns all the recent content for the specified container. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecentContent(JiveContainer jiveContainer,
ContentRetrieval.ContentType[] contentTypes)
Returns the recent content matching the provided content types for the specified container. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecentContent(JiveContainer jiveContainer,
ContentRetrieval.ContentType[] contentTypes,
com.google.common.base.Predicate<com.jivesoftware.community.RecentContentBean> predicate)
Returns the recent content matching the provided content types and predicate for the specified container. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecentContent(JiveContainer jiveContainer,
com.google.common.base.Predicate<com.jivesoftware.community.RecentContentBean> predicate)
Returns all the recent content that pass the provided predicate for the specified container. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecursiveRecentContent(JiveContainer jiveContainer)
Returns all the recent content for the specified container and all subcontainers. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecursiveRecentContent(JiveContainer jiveContainer,
ContentRetrieval.ContentType[] contentTypes)
Returns the recent content matching the provided content types for the specified container and all subcontainers. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecursiveRecentContent(JiveContainer jiveContainer,
ContentRetrieval.ContentType[] contentTypes,
com.google.common.base.Predicate<com.jivesoftware.community.RecentContentBean> predicate)
Returns the recent content matching the provided content types and predicate for the specified container and all subcontainers. |
JiveIterator<JiveContentObject> |
RecentContentManager.getRecursiveRecentContent(JiveContainer jiveContainer,
com.google.common.base.Predicate<com.jivesoftware.community.RecentContentBean> predicate)
Returns all the recent content that pass the provided predicate for the specified container and all subcontainers. |
StatusLevel |
StatusLevelManager.getStatusLevel(User user,
JiveContainer container)
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. |
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. |
int |
TagManager.getTaggableContentCount(JiveContainer container)
Returns a count of taggable jive objects for the specific container. |
int |
TagManager.getTaggableContentCount(JiveContainer container,
ResultFilter resultFilter,
TagManager.Taggable... taggableTypes)
Returns a cout of taggable jive objects for the specific container. |
Map<String,Integer> |
TagManager.getTagMap(JiveContainer container)
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. |
Map<String,Integer> |
TagManager.getTagMap(JiveContainer container,
TagResultFilter resultFilter,
TagManager.Taggable... types)
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. |
JiveIterator<TagSet> |
TagSetManager.getTagSets(JiveContainer container)
Returns all TagSets which are defined for the specified JiveContainer. |
int |
ForumManager.getThreadCount(JiveContainer container)
Returns the number of threads in the container. |
int |
ForumManager.getThreadCount(JiveContainer container,
ThreadResultFilter resultFilter)
Returns the number of threads in the container based on the specified ResultFilter. |
JiveIterator<ForumThread> |
ForumManager.getThreads(JiveContainer container)
Returns an Iterable for all the threads in the container. |
JiveIterator<ForumThread> |
ForumManager.getThreads(JiveContainer container,
ThreadResultFilter resultFilter)
Returns an Iterable for all the threads in the container that match the criteria specified by the ResultFilter. |
int |
ReadTrackerManager.getUnreadMessageCount(User user,
JiveContainer container)
Returns the count of unread messages that the user has in the community. |
JiveIterator<ForumMessage> |
ReadTrackerManager.getUnreadMessages(User user,
JiveContainer container)
Returns an iterable for the unread messages in the community. |
int |
ReadTrackerManager.getUnreadThreadCount(User user,
JiveContainer container)
Returns the count of unread threads that the user has in the community. |
JiveIterator<ForumThread> |
ReadTrackerManager.getUnreadThreads(User user,
JiveContainer container)
Returns an iterable for the unread threads in the community. |
int |
WatchManager.getWatchCount(User user,
JiveContainer container)
Return the count of all watches in a particular container for the given user. |
JiveIterator<JiveObject> |
WatchManager.getWatches(User user,
JiveContainer container)
Returns an Iterable for all the objects a user is watching in a container. |
void |
BlogManager.mapBlogToContainer(JiveContainer container,
Blog blog)
Associates the specified Blog with a container. |
void |
ReadTrackerManager.markRead(User user,
JiveContainer container)
Marks an entire continer as read up until the current instant in time. |
void |
BlogManager.moveBlog(Blog blog,
JiveContainer destination)
Moves a blog from it's current container to a new container. |
void |
DocumentManager.moveDocument(Document document,
JiveContainer destinationContainer)
Moves a document from it's current container to another. |
void |
ForumManager.moveThread(ForumThread thread,
JiveContainer newContainer)
Moves a thread from one container to another. |
void |
DocumentManager.removeDocumentApprover(JiveContainer container,
User user)
Remove this user as a document approver for this container. |
void |
Blog.setJiveContainer(JiveContainer container)
Adds or moves the parent container of the blog. |
void |
BlogManager.unmapContainerBlog(JiveContainer container,
Blog blog)
Disassociates the specified Blog from this containter. |
| Uses of JiveContainer in com.jivesoftware.community.action |
|---|
| Methods in com.jivesoftware.community.action that return JiveContainer | |
|---|---|
JiveContainer |
JiveActionSupport.loadJiveContainer(int objectType,
long objectID)
|
| Uses of JiveContainer in com.jivesoftware.community.event |
|---|
| Methods in com.jivesoftware.community.event that return JiveContainer | |
|---|---|
JiveContainer |
DocumentEvent.getJiveContainer()
|
JiveContainer |
MessageEvent.getJiveContainer()
|
JiveContainer |
PollEvent.getJiveContainer()
|
JiveContainer |
TaskEvent.getJiveContainer()
|
JiveContainer |
ThreadEvent.getJiveContainer()
|
| Constructors in com.jivesoftware.community.event with parameters of type JiveContainer | |
|---|---|
DocumentEvent(int eventType,
Document document,
JiveContainer container,
Map<String,? extends Object> params)
|
|
MessageEvent(int eventType,
ForumMessage message,
JiveContainer container,
Map<String,? extends Object> params)
Creates a new message event. |
|
PollEvent(int eventType,
Poll poll,
JiveContainer container,
Map<String,? extends Object> params)
Creates a new message event. |
|
TaskEvent(int eventType,
com.jivesoftware.community.project.Task task,
JiveContainer container,
Map<String,Object> params)
Creates a new task event. |
|
ThreadEvent(int eventType,
ForumThread thread,
JiveContainer container,
Map<String,? extends Object> params)
Creates a new thread event. |
|
| Uses of JiveContainer in com.jivesoftware.community.moderation |
|---|
| Methods in com.jivesoftware.community.moderation with parameters of type JiveContainer | |
|---|---|
boolean |
JiveObjectModerator.isModerationEnabled(JiveContainer jiveContainer,
int objectType,
User user)
Determines if moderation is enabled for the given JiveContainer and object Type. |
boolean |
ModerationStrategy.shouldModerate(JiveContainer jiveContainer,
int objectType,
User user)
Determines if moderation is enabled for the given JiveContainer and object Type. |
| Uses of JiveContainer in com.jivesoftware.community.project |
|---|
| Subinterfaces of JiveContainer in com.jivesoftware.community.project | |
|---|---|
interface |
Project
A container for threads, documents and tasks. |
| Methods in com.jivesoftware.community.project with parameters of type JiveContainer | |
|---|---|
Project |
ProjectManager.create(JiveContainer container,
String name,
String description,
User user,
List<CheckPoint> checkPoints,
Date dueDate)
Creates a new project as a child of the parent container |
| Uses of JiveContainer in com.jivesoftware.community.renderer |
|---|
| Methods in com.jivesoftware.community.renderer with parameters of type JiveContainer | |
|---|---|
RenderManager |
RenderManager.getRenderManager(JiveContainer container)
Returns the RenderManager associated with the container. |
| Uses of JiveContainer in com.jivesoftware.community.socialgroup |
|---|
| Subinterfaces of JiveContainer in com.jivesoftware.community.socialgroup | |
|---|---|
interface |
SocialGroup
The container representing social groups in Clearspace. |
| Uses of JiveContainer in com.jivesoftware.community.xmpp |
|---|
| Methods in com.jivesoftware.community.xmpp with parameters of type JiveContainer | |
|---|---|
boolean |
IMManager.isChatEnabled(JiveContainer container)
Returns true if Chat functionality is enabled for a container. |
|
Clearspace Project Page | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||