|
Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ForumMessageService
Provides the ability to manipulate forum messages. This service will allow you to delete, move and acquire forum messages.
Method Summary | |
---|---|
void |
addAttachmentToMessage(java.lang.String name,
javax.activation.DataSource source,
long messageID)
Adds an attachment to the message with the specified ID. |
void |
deleteMessage(long messageID)
Delete the message with the following id. |
void |
deleteMessageAndChildren(long messageID,
boolean deleteChildren)
Delete the message with the specified id. |
void |
deleteProperty(java.lang.String name,
long messageID)
Delete a property with the given name from the message with the given ID. |
javax.activation.DataSource[] |
getAttachmentsByMessageID(long messageID)
Returns an array of attachments that are attached to the specified message. |
ForumMessage |
getChild(long messageID,
int index)
Returns the child of parent at index index in the parent's child array. |
int |
getChildCount(long messageID)
Returns the number of children of parent. |
ForumMessage[] |
getChildren(long messageID)
Returns an array of all the child messages of the parent. |
ForumMessage |
getForumMessage(long messageID)
Returns a ForumMessage by its ID. |
int |
getIndexOfChild(long parentID,
long messageID)
Returns the index of child in parent. |
int |
getMessageCountByCategoryID(long categoryID)
Returns the number of messages that are in the category. |
int |
getMessageCountByCategoryIDAndFilter(long categoryID,
ResultFilter filter)
Returns the number of messages that are in the category with the specified id after the specified filter has been applied. |
int |
getMessageCountByThreadID(long threadID)
Returns the number of messages that are in the thread. |
int |
getMessageCountByThreadIDAndFilter(long threadID,
ResultFilter filter)
Returns the number of messages that are in the thread with the specified id after the specified filter has been applied. |
int |
getMessageCountsByForumID(long forumID)
Returns the number of messages that are in the forum. |
int |
getMessageCountsByForumIDAndFilter(long forumID,
ResultFilter filter)
Returns the number of messages that are in the forum with the specified id after the specified filter has been applied. |
int |
getMessageDepth(long messageID)
Returns the depth of a message in the message tree hierarchy. |
long[] |
getMessageIDsByCategoryID(long categoryID)
Returns all of the message IDs for all of the message that are in the category. |
long[] |
getMessageIDsByCategoryIDAndFilter(long categoryID,
ResultFilter filter)
Returns all of the message IDs for all of the message that are in the category with the specified ID, filtered by the the specified result filter. |
long[] |
getMessageIDsByForumID(long forumID)
Returns all of the message IDs for all of the message that are in the forum. |
long[] |
getMessageIDsByForumIDAndFilter(long forumID,
ResultFilter filter)
Returns all of the message IDs for all of the message that are in the forum with the specified ID, filtered by the the specified ResultFilter |
long[] |
getMessageIDsByThreadID(long threadID)
Returns the IDs of the messages that are in the thread. |
long[] |
getMessageIDsByThreadIDAndFilter(long threadID,
ResultFilter filter)
Returns all of the message IDs for all of the message that are in the thread after the specified filter has been applied. |
ForumMessage[] |
getMessagesByCategoryID(long categoryID)
Returns all of the messages that are in the category. |
ForumMessage[] |
getMessagesByCategoryIDAndFilter(long categoryID,
ResultFilter filter)
Returns all of the messages that are in the category with the specified ID, filtered by the the specified result filter. |
ForumMessage[] |
getMessagesByForumID(long forumID)
Returns all of the messages in the forum. |
ForumMessage[] |
getMessagesByForumIDAndFilter(long forumID,
ResultFilter filter)
Returns all of the messages in the forum with the specified ID, filtered by the the specified ResultFilter |
ForumMessage[] |
getMessagesByThreadID(long threadID)
Returns the messages that are in the thread. |
ForumMessage[] |
getMessagesByThreadIDAndFilter(long threadID,
ResultFilter filter)
Returns all of the messages that are in the thread after the specified filter has been applied. |
ForumMessage |
getParent(long messageID)
Returns the parent of the child ForumMessage. |
Property[] |
getProperties(long messageID)
Returns all tbe extended properties for the message with the specified ID. |
java.lang.String |
getProperty(java.lang.String name,
long messageID)
Returns the value of the extended property for the message with the specified ID. |
int |
getRecursiveChildCount(long messageID)
Returns the total number of recursive children of a parent. |
ForumMessage[] |
getRecursiveChildren(long messageID)
Returns an array for all child messages (and sub-children, etc) of the parent. |
ForumMessage[] |
getRecursiveMessages(long threadID)
Returns an array for all messages in the thread in depth-first order. |
ForumMessage |
getRootMessage(long threadID)
Returns the root of a thread. |
Property[] |
getUnfilteredProperties(long messageID)
Returns the properties without applying filters to them first. |
boolean |
hasParent(long messageID)
Returns true if the child message has a parent message. |
boolean |
isLeaf(long messageID)
Returns true if node is a leaf. |
void |
setProperty(java.lang.String name,
java.lang.String value,
long messageID)
Set an extended for the property with the given message id. |
void |
updateForumMessage(ForumMessage message)
Used to update the subject and body of a ForumMessage |
Method Detail |
---|
ForumMessage getForumMessage(long messageID) throws ForumMessageNotFoundException
ForumMessage
by its ID.
messageID
- id of the message.
ForumMessageNotFoundException
void deleteMessage(long messageID) throws ForumMessageNotFoundException
messageID
- the id of the message to delete.
ForumMessageNotFoundException
void deleteMessageAndChildren(long messageID, boolean deleteChildren) throws ForumMessageNotFoundException
messageID
- The ID of the message to delete.deleteChildren
- Whether or not to delete the children of this message.
ForumMessageNotFoundException
Property[] getProperties(long messageID)
messageID
- The ID of the message to retrieve properties for.
void setProperty(java.lang.String name, java.lang.String value, long messageID) throws ForumMessageNotFoundException
name
- The name of the property.value
- The value of the property.messageID
- The ID of the message to set an extended property for.
ForumMessageNotFoundException
java.lang.String getProperty(java.lang.String name, long messageID) throws ForumMessageNotFoundException
name
- The name of the property.messageID
- The ID of the message to retrieve the property for.
ForumMessageNotFoundException
void deleteProperty(java.lang.String name, long messageID) throws ForumMessageNotFoundException
name
- The name of the property to delete.messageID
- The ID of the message to delete the property from.
ForumMessageNotFoundException
Property[] getUnfilteredProperties(long messageID) throws ForumMessageNotFoundException
messageID
- The ID of the message to return unfiltered properties for.
ForumMessageNotFoundException
javax.activation.DataSource[] getAttachmentsByMessageID(long messageID) throws ForumMessageNotFoundException
messageID
- The ID of the message to acquire attachments for.
ForumMessageNotFoundException
void addAttachmentToMessage(java.lang.String name, javax.activation.DataSource source, long messageID) throws AttachmentException, ForumMessageNotFoundException, java.io.IOException
name
- The name of the attachment.source
- The content for the attachment.messageID
- The ID of the message.
AttachmentException
ForumMessageNotFoundException
java.io.IOException
long[] getMessageIDsByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
ResultFilter
forumID
- The ID of the forum to find messages for.filter
- The filter to be apply to the results.
ForumNotFoundException
long[] getMessageIDsByForumID(long forumID) throws ForumNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
forumID
- The ID of the forum to find messages for.
ForumNotFoundException
long[] getMessageIDsByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
categoryID
- The id of the category to find messages for.filter
- Filter to be apply to the results.
ForumCategoryNotFoundException
long[] getMessageIDsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
categoryID
- The ID of the category to find messages for.
ForumCategoryNotFoundException
int getMessageCountsByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
forumID
- The ID of the forum to find the message count for.filter
- Filter that can be applied to filter out results.
ForumNotFoundException
int getMessageCountsByForumID(long forumID) throws ForumNotFoundException
forumID
- The ID of the forum to find the message count for.
ForumNotFoundException
int getMessageCountByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to find the message count for.filter
- The filter that can be applied to filter out results.
ForumCategoryNotFoundException
int getMessageCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to find the message count for.
ForumCategoryNotFoundException
long[] getMessageIDsByThreadIDAndFilter(long threadID, ResultFilter filter) throws ForumThreadNotFoundException
threadID
- The ID of the thread to find messages for.filter
- The filter to apply to the results.
ForumThreadNotFoundException
long[] getMessageIDsByThreadID(long threadID) throws ForumThreadNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
threadID
- The ID of the thread to find message IDs for.
ForumThreadNotFoundException
int getMessageCountByThreadIDAndFilter(long threadID, ResultFilter filter) throws ForumThreadNotFoundException
threadID
- The ID of the thread to find the message count for.filter
- The filter that can be applied to filter out results.
ForumThreadNotFoundException
int getMessageCountByThreadID(long threadID) throws ForumThreadNotFoundException
threadID
- The ID of the thread to find the message count for.
ForumThreadNotFoundException
ForumMessage[] getMessagesByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
ResultFilter
forumID
- The ID of the forum to find messages for.filter
- The filter to be apply to the results.
ForumNotFoundException
ForumMessage[] getMessagesByForumID(long forumID) throws ForumNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
forumID
- The ID of the forum to find messages for.
ForumNotFoundException
ForumMessage[] getMessagesByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
categoryID
- The id of the category to find messages for.filter
- Filter to be apply to the results.
ForumCategoryNotFoundException
ForumMessage[] getMessagesByCategoryID(long categoryID) throws ForumCategoryNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
categoryID
- The ID of the category to find messages for.
ForumCategoryNotFoundException
ForumMessage[] getMessagesByThreadIDAndFilter(long threadID, ResultFilter filter) throws ForumThreadNotFoundException
threadID
- The ID of the thread to find messages for.filter
- The filter to apply to the results.
ForumThreadNotFoundException
ForumMessage[] getMessagesByThreadID(long threadID) throws ForumThreadNotFoundException
WSConstants.MAX_MESSAGE_RESULTS
than then message IDs up to
WSConstants.MAX_MESSAGE_RESULTS
will be returned.
threadID
- The ID of the thread to find message IDs for.
ForumThreadNotFoundException
ForumMessage getRootMessage(long threadID) throws ForumThreadNotFoundException
threadID
- The ID of the thread.
ForumThreadNotFoundException
boolean hasParent(long messageID) throws ForumMessageNotFoundException
child
message has a parent message.
messageID
- the message.
ForumMessageNotFoundException
ForumMessage getParent(long messageID) throws ForumMessageNotFoundException
child
ForumMessage.
messageID
- The ID of the message to find the parent for.
ForumMessageNotFoundException
- if child does not have a parent,
or if the parent message could not be loaded for any other reason.ForumMessage getChild(long messageID, int index) throws ForumMessageNotFoundException
index
>= 0, and
index
< getChildCount(parent). If the index is not valid,
or if the child could not be loaded for any other reason, a
ForumMessageNotFoundException will be thrown.
messageID
- The ID of the parent message.index
- the index of the child.
ForumMessageNotFoundException
- if the index was invalid or the
child could not be loaded for any other reason.ForumMessage[] getChildren(long messageID) throws ForumMessageNotFoundException
getRecursiveChildren(long)
method.
messageID
- The parent message.
ForumMessageNotFoundException
ForumMessage[] getRecursiveChildren(long messageID) throws ForumMessageNotFoundException
1 |-- 3 |-- |-- 4 |-- |-- |-- 7 |-- |-- |-- |-- 10 |-- |-- 6 |-- |-- 8 |-- 5Calling getRecursiveChildren(3) on the tree above would return the sequence 4, 7, 10, 6, 8. This method is a powerful way to show all children of a message, especially in combination with the
getMessageDepth(long)
method.
messageID
- The ID of the parent message.
ForumMessageNotFoundException
boolean isLeaf(long messageID) throws ForumMessageNotFoundException
messageID
- A node in the thread, obtained from this data source.
ForumMessageNotFoundException
int getRecursiveChildCount(long messageID) throws ForumMessageNotFoundException
messageID
- The ID of the message.
parent
.
ForumMessageNotFoundException
int getIndexOfChild(long parentID, long messageID) throws ForumMessageNotFoundException
4 |-- 2 |-- |-- 1 |-- |-- 6 |-- |-- 8 |-- 5In this example, getIndexOfChild(4, 2) would return 0, getIndexOfChild(4, 5) would return 1, and getIndexOfChild(2, 8) would return 2. getIndexOfChild(4, 8) -- NOT VALID
parentID
- The ID of the parent message.messageID
- The ID of the child message to get the index for.
ForumMessageNotFoundException
int getMessageDepth(long messageID) throws ForumMessageNotFoundException
1 |-- 3 |-- |-- 4 |-- |-- |-- 7The depth of message 4 is 2, the depth of message 7 is 3, etc. This method is useful in combination with the
getRecursiveChildren(long)
array to build a UI of hierarchical messages.
messageID
- The ID of the message to determine the depth of.
ForumMessageNotFoundException
int getChildCount(long messageID) throws ForumMessageNotFoundException
messageID
- The ID the message.
ForumMessageNotFoundException
ForumMessage[] getRecursiveMessages(long threadID) throws ForumThreadNotFoundException
1 |-- 3 |-- |-- 4 |-- |-- |-- 7 |-- |-- |-- |-- 10 |-- |-- 6 |-- |-- 8 |-- 5Calling getRecursiveMessages() on the tree above would return the sequence 1, 3, 4, 7, 10, 6, 8, 5. This method is a powerful way to show the full tree of messages, especially in combination with the
getMessageDepth(long)
method.
threadID
- The ID of the thread.
ForumThreadNotFoundException
void updateForumMessage(ForumMessage message) throws ForumMessageNotFoundException, MessageRejectedException
ForumMessage
message
- The message to update
ForumMessageNotFoundException
- Thrown if the forum message does not exist
MessageRejectedException
- Thrown if the forum message has been rejected by a message interceptor
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |