Uses of Interface
com.jivesoftware.community.ForumMessage

Packages that use ForumMessage

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.util	Clearspace utility classes.

Uses of ForumMessage in com.jivesoftware.community

Methods in com.jivesoftware.community that return ForumMessage

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.
ForumMessage	TreeWalker.getChild(ForumMessage parent, int index) Returns the child of parent at index index in the parent's child array.
ForumMessage	Question.getCorrectAnswer() Returns the correct answer, or null if no correct answer has been set.
ForumMessage	ForumThread.getLatestMessage() Returns the most recently created messages in this thread.
ForumMessage	ForumManager.getLatestMessage(JiveContainer container) Returns the most recently created or edited message in this container (including all sub-containers if applicable).
ForumMessage	ForumManager.getLatestMessage(TagSet tagSet) Returns the most recently created or edited message in this tag set .
ForumMessage	ForumManager.getMessage(long messageID) Returns the forum message with the specified messageID.
ForumMessage	ForumThread.getMessage(long messageID) Returns a message from this thread based on its id.
ForumMessage	TreeWalker.getParent(ForumMessage child) Returns the parent of the child ForumMessage.
ForumMessage	ForumMessage.getParentMessage() Returns the parent message of this message or null if this message is the root message of a thread.
ForumMessage	TreeWalker.getRoot() Returns the root of the tree.
ForumMessage	ForumThread.getRootMessage() Returns the root message this thread.

Methods in com.jivesoftware.community that return types with arguments of type ForumMessage

JiveIterator<ForumMessage>	TreeWalker.getChildren(ForumMessage parent) Returns an Iterable for all the child messages of the parent.
Collection<ForumMessage>	Question.getHelpfulAnswers() Returns a read-only Collection of ForumMessage objects that have been marked as helpful.
JiveIterator<ForumMessage>	ForumThread.getMessages() Return an Iterable for all the messages in this thread.
List<ForumMessage>	OldModerationManager.getMessages() This method will return a list of messages where the user is a moderator.
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.
List<ForumMessage>	OldModerationManager.getMessages(ModerationFilter modFilter) This method will return a list of messages where the user is a moderator.
Iterable<ForumMessage>	OldModerationManager.getMessages(ModerationFilter modFilter, JiveContainer container) Gets a list of moderated messages for a particular container.
JiveIterator<ForumMessage>	ForumManager.getMessages(TagSet tagSet) Returns an Iterable for all the messages in the tag set.
JiveIterator<ForumMessage>	ForumManager.getMessages(TagSet tagSet, ThreadResultFilter resultFilter) Returns an Iterable for all the messages in the tag set that match the criteria specified by the ResultFilter.
JiveIterator<ForumMessage>	ForumThread.getMessages(ThreadResultFilter resultFilter) Returns a Iterable for all the messages in the thread that match the criteria specified by the ResultFilter.
JiveIterator<ForumMessage>	TreeWalker.getRecursiveChildren(ForumMessage parent) Returns an Iterable for all child messages (and sub-children, etc) of the parent.
JiveIterator<ForumMessage>	TreeWalker.getRecursiveMessages() Returns an Iterable for all messages in the thread in depth-first order.
JiveIterator<ForumMessage>	ReadTrackerManager.getUnreadMessages(User user, JiveContainer container) Returns an iterable for the unread messages in the community.
JiveIterator<ForumMessage>	ForumManager.getUserMessages(User user) Returns an iterable for all messages posted by a user.
JiveIterator<ForumMessage>	ForumManager.getUserMessages(User user, ThreadResultFilter resultFilter) Returns an iterable for all messages posted by a user that obey the parameters set by the specified ResultFilter.

Methods in com.jivesoftware.community with parameters of type ForumMessage

void	Question.addHelpfulAnswer(ForumMessage message) Marks the specified message as a helpful answer to this question.
void	ForumThread.addMessage(ForumMessage parentMessage, ForumMessage newMessage) Adds a new message to this thread.
void	ForumManager.addMessage(ForumThread thread, ForumMessage parentMessage, ForumMessage newMessage) Adds a new message to a given thread.
void	SearchManager.addToIndex(ForumMessage message) Adds an individual message to the index.
void	OldModerationManager.approve(ForumMessage message) Approve a moderated message
SearchQueryCriteria	SearchQueryManager.createSearchQueryCriteria(ForumMessage message) Returns a SearchQueryCriteria that can be used to query for other searchable items that are deemed similar to the provided message.
ForumThread	ForumManager.createThread(JiveContainer container, ForumMessage rootMessage) Factory method to create a new thread.
void	ForumThread.deleteMessage(ForumMessage message) Deletes a message in this thread.
void	ForumThread.deleteMessage(ForumMessage message, boolean deleteChildren) Deletes a message in this thread, optionally recusively deleting child messages.
void	ForumManager.deleteMessage(ForumThread thread, ForumMessage message) Deletes a message from the given thread.
void	ForumManager.deleteMessage(ForumThread thread, ForumMessage message, boolean deleteChildren) Deletes a message and (optionally) all of its child messages from the given thread.
void	OldModerationManager.editAndApprove(ForumMessage message, String subject, String body, String tags) Edit and approve a moderated message
ForumMessage	TreeWalker.getChild(ForumMessage parent, int index) Returns the child of parent at index index in the parent's child array.
int	TreeWalker.getChildCount(ForumMessage parent) Returns the number of children of parent.
JiveIterator<ForumMessage>	TreeWalker.getChildren(ForumMessage parent) Returns an Iterable for all the child messages of the parent.
int	TreeWalker.getIndexOfChild(ForumMessage parent, ForumMessage child) Returns the index of child in parent.
int	TreeWalker.getMessageDepth(ForumMessage message) Returns the depth of a message in the message tree hierarchy.
ForumMessage	TreeWalker.getParent(ForumMessage child) Returns the parent of the child ForumMessage.
int	ReadTrackerManager.getReadStatus(User user, ForumMessage message) Returns the read status on the specified message.
int	TreeWalker.getRecursiveChildCount(ForumMessage parent) Returns the total number of recursive children of a parent.
JiveIterator<ForumMessage>	TreeWalker.getRecursiveChildren(ForumMessage parent) Returns an Iterable for all child messages (and sub-children, etc) of the parent.
boolean	TreeWalker.hasParent(ForumMessage child) Returns true if the child message has a parent message.
boolean	Question.isCorrectAnswer(ForumMessage message) Returns true if the specified message is the correct answer.
boolean	Question.isHelpfulAnswer(ForumMessage message) Returns true if the specified message has been marked as a helpful answer to this question.
boolean	TreeWalker.isLeaf(ForumMessage node) Returns true if node is a leaf.
void	ReadTrackerManager.markRead(User user, ForumMessage message) Marks an individual message as read.
void	ForumManager.moveMessage(ForumMessage message, ForumThread newThread, long parentMessageID) Moves a message to another thread.
void	OldModerationManager.reject(ForumMessage message) Reject a moderated message
void	SearchManager.removeFromIndex(ForumMessage message) Removes an individual message from the index.
void	Question.setCorrectAnswer(ForumMessage message) Sets the specified message as the correct answer.
void	ForumManager.update(ForumMessage message) Persists message changes, and broadcasts changes across the cluster.
void	SearchManager.updateIndex(ForumMessage message) Update an individual message in the index.

Uses of ForumMessage in com.jivesoftware.community.event

Methods in com.jivesoftware.community.event that return ForumMessage

ForumMessage

MessageEvent.getMessage() Returns the ForumMessage that the event corresponds to.

Constructors in com.jivesoftware.community.event with parameters of type ForumMessage

MessageEvent(int eventType, ForumMessage message, JiveContainer container, Map<String,? extends Object> params)
Creates a new message event.

Uses of ForumMessage in com.jivesoftware.community.util

Methods in com.jivesoftware.community.util that return types with arguments of type ForumMessage

static Iterator<ForumMessage>

SkinUtils.filterPendingMessages(Iterator<ForumMessage> messages) Assumes index of iterator is at front of iterator (ie, iterator hasn't been used).

Methods in com.jivesoftware.community.util with parameters of type ForumMessage

static boolean

SkinUtils.isNew(ForumMessage message, Date time) Returns true if the forum message has been modified since the specified time.

Method parameters in com.jivesoftware.community.util with type arguments of type ForumMessage

static Iterator<ForumMessage>

SkinUtils.filterPendingMessages(Iterator<ForumMessage> messages) Assumes index of iterator is at front of iterator (ie, iterator hasn't been used).