|
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 ContentService
Provides a way to get handles on content objects. Content objects are strictly categories, forums, threads or messages. Once you have a handle on that object you can use the other services (ie, ForumService or MessageService) to do other operations).
Method Summary | |
---|---|
int |
countMessageSearchResults(Query query)
Returns the number of possible results for the specified query. |
int |
countMessageSearchResultsByCategoryID(long categoryID,
Query query)
Returns the number of possible results for the specified query by category. |
int |
countMessageSearchResultsByForumID(long forumID,
Query query)
Returns the number of results for the specified query for a forum. |
int |
countQuickMessageSearchResults(java.lang.String query)
Returns the number of possible results for the specified query. |
int |
countQuickMessageSearchResultsByCategoryID(long categoryID,
java.lang.String query)
Returns the number of possible results for the specified query. |
ForumMessage |
createMessage(java.lang.String subject,
java.lang.String body,
long threadID,
long userID)
Creates a new message on the given thread. |
ForumMessage |
createReplyMessage(java.lang.String subject,
java.lang.String body,
long messageID,
long userID)
Creates a new message that is a direct response to a given message. |
ForumThread |
createThread(java.lang.String subject,
java.lang.String body,
long forumID,
long userID)
Creates a new thread. |
Forum |
getForum(long forumID)
Returns a Forum by its id. |
ForumCategory |
getForumCategory(long categoryID)
Returns a ForumCategory by its id. |
ForumMessage |
getForumMessage(long messageID)
Returns a ForumMessage by its id. |
ForumThread |
getForumThread(long threadID)
Returns a ForumThread by its id. |
int |
getMessageCountByUserID(long userID)
Returns the number of messages for created by the given userID. |
ForumMessage[] |
getMessagesByUserID(long userID)
Returns all the messages created by the given userID. |
long[] |
messageSearch(Query query,
int startIndex,
int numResults)
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. |
long[] |
messageSearchByCategories(long categoryID,
Query query,
int startIndex,
int numResults)
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category. |
ForumMessage[] |
messageSearchByCategoriesForObjects(long categoryID,
Query query,
int startIndex,
int numResults)
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category. |
long[] |
messageSearchByForum(long forumID,
Query query,
int startIndex,
int numResults)
Provides the ability to perform a search query for messages within a forum. |
ForumMessage[] |
messageSearchByForumForObjects(long forumID,
Query query,
int startIndex,
int numResults)
Provides the ability to perform a search query for messages within a forum. |
ForumMessage[] |
messageSearchForObjects(Query query,
int startIndex,
int numResults)
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. |
long[] |
quickMessageSearch(java.lang.String query,
int startIndex,
int numResults)
Provides the ability to do quick search queries based on the provided string. |
long[] |
quickMessageSearchByCategoryID(long categoryID,
java.lang.String query,
int startIndex,
int numResults)
Provides the ability to do quick search queries based on the provided string. |
ForumMessage[] |
quickMessageSearchByCategoryIDForObjects(long categoryID,
java.lang.String query,
int startIndex,
int numResults)
Provides the ability to do quick search queries based on the provided string. |
ForumMessage[] |
quickMessageSearchForObjects(java.lang.String query,
int startIndex,
int numResults)
Provides the ability to do quick search queries based on the provided string. |
Method Detail |
---|
Forum getForum(long forumID) throws ForumNotFoundException
Forum
by its id.
forumID
- the id of the forum.
ForumNotFoundException
ForumCategory getForumCategory(long categoryID) throws ForumCategoryNotFoundException
ForumCategory
by its id.
categoryID
- id of the category.
ForumCategoryNotFoundException
ForumThread getForumThread(long threadID) throws ForumThreadNotFoundException
ForumThread
by its id.
threadID
- id of the thread.
ForumThreadNotFoundException
ForumMessage getForumMessage(long messageID) throws ForumMessageNotFoundException
ForumMessage
by its id.
messageID
- id of the message.
ForumMessageNotFoundException
ForumThread createThread(java.lang.String subject, java.lang.String body, long forumID, long userID) throws UserNotFoundException, ForumNotFoundException, MessageRejectedException
subject
- Subject used in creation of the thread.body
- Body used in creation of the thread.forumID
- The forum to create a new thread in.userID
- The user to create this message as. Use a number less than zero for anonymous.
UserNotFoundException
ForumNotFoundException
MessageRejectedException
ForumMessage createMessage(java.lang.String subject, java.lang.String body, long threadID, long userID) throws ForumThreadNotFoundException, UserNotFoundException, MessageRejectedException
subject
- Subject used in creation of the thread.body
- Body used in creation of the thread.threadID
- Thread to create the message too.userID
- The user to create this message as. Use a number less than zero for anonymous.
ForumThreadNotFoundException
UserNotFoundException
MessageRejectedException
ForumMessage createReplyMessage(java.lang.String subject, java.lang.String body, long messageID, long userID) throws ForumMessageNotFoundException, MessageRejectedException, UserNotFoundException
subject
- Subject used in creation of the thread.body
- Body used in creation of the thread.messageID
- The id of the message to respond too.userID
- The user to create this message as. Use a number less than zero for anonymous.
ForumMessageNotFoundException
MessageRejectedException
UserNotFoundException
long[] messageSearch(Query query, int startIndex, int numResults) throws UserNotFoundException
query
- The query objects.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
UserNotFoundException
ForumMessage[] messageSearchForObjects(Query query, int startIndex, int numResults) throws ForumNotFoundException, ForumMessageNotFoundException, UserNotFoundException
query
- The query objects.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumNotFoundException
ForumMessageNotFoundException
UserNotFoundException
long[] quickMessageSearch(java.lang.String query, int startIndex, int numResults)
query
- The query string.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumMessage[] quickMessageSearchForObjects(java.lang.String query, int startIndex, int numResults) throws ForumMessageNotFoundException
query
- The query string.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumMessageNotFoundException
int countMessageSearchResults(Query query) throws UserNotFoundException
query
- The query to find the number of results for.
UserNotFoundException
int countQuickMessageSearchResults(java.lang.String query)
query
- The query to find the number of results for.
long[] messageSearchByCategories(long categoryID, Query query, int startIndex, int numResults) throws ForumCategoryNotFoundException, UserNotFoundException
categoryID
- The id of the categoryquery
- The query objects.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumCategoryNotFoundException
- Thrown if the category does not exist
UserNotFoundException
ForumMessage[] messageSearchByCategoriesForObjects(long categoryID, Query query, int startIndex, int numResults) throws ForumNotFoundException, ForumMessageNotFoundException, ForumCategoryNotFoundException, UserNotFoundException
categoryID
- The id of the categoryquery
- The query objects.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumCategoryNotFoundException
- Thrown if the category does not exist
ForumNotFoundException
ForumMessageNotFoundException
UserNotFoundException
int countMessageSearchResultsByCategoryID(long categoryID, Query query) throws ForumCategoryNotFoundException, UserNotFoundException
categoryID
- The id of the category.query
- The query to find the number of results for.
ForumCategoryNotFoundException
UserNotFoundException
long[] quickMessageSearchByCategoryID(long categoryID, java.lang.String query, int startIndex, int numResults) throws ForumCategoryNotFoundException
categoryID
- The id of the category.query
- The query string.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumCategoryNotFoundException
ForumMessage[] quickMessageSearchByCategoryIDForObjects(long categoryID, java.lang.String query, int startIndex, int numResults) throws ForumCategoryNotFoundException, ForumMessageNotFoundException
categoryID
- The id of the category.query
- The query string.startIndex
- Starting point of results to grab.numResults
- Ending point of results to grab.
ForumCategoryNotFoundException
ForumMessageNotFoundException
int countQuickMessageSearchResultsByCategoryID(long categoryID, java.lang.String query) throws ForumCategoryNotFoundException
categoryID
- The id of the category.query
- The query to find the number of results for.
ForumCategoryNotFoundException
int getMessageCountByUserID(long userID) throws UserNotFoundException
userID
- The id of the user.
UserNotFoundException
ForumMessage[] getMessagesByUserID(long userID) throws UserNotFoundException
userID
- The id of the user.
UserNotFoundException
long[] messageSearchByForum(long forumID, Query query, int startIndex, int numResults) throws ForumNotFoundException, UserNotFoundException
forumID
- The id of the forum.query
- The query object.startIndex
- Starting point of results to return.numResults
- Ending point of results to return.
ForumNotFoundException
- Thrown if the forum does not exist
UserNotFoundException
ForumMessage[] messageSearchByForumForObjects(long forumID, Query query, int startIndex, int numResults) throws ForumNotFoundException, ForumMessageNotFoundException, UserNotFoundException
forumID
- The id of the forum.query
- The query object.startIndex
- Starting point of results to return.numResults
- Ending point of results to return.
ForumNotFoundException
- Thrown if the forum does not exist
ForumMessageNotFoundException
UserNotFoundException
int countMessageSearchResultsByForumID(long forumID, Query query) throws ForumNotFoundException, UserNotFoundException
forumID
- The id of the forum.query
- The query object.
ForumNotFoundException
- Thrown if the forum does not exist
UserNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |