|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ForumThreadService
Provides the ability to manipulate forum threads. This service will allow you to delete, move and acquire forum threads.
Method Summary | |
---|---|
void |
deleteProperty(java.lang.String name,
long threadID)
Delete a property with the given name from the thread with the given ID. |
void |
deleteThread(long threadID)
Deletes a thread with the specified ID. |
ForumThread |
getForumThread(long threadID)
Returns a ForumThread by its ID. |
ForumThread[] |
getPopularThreads()
Returns an array of thread IDs for all the popular threads in the system. |
ForumThread[] |
getPopularThreadsByCategoryID(long categoryID)
Returns an array of popular threads by category. |
ForumThread[] |
getPopularThreadsByForumID(long forumID)
Returns an array of threadIDs for all the popular threads for a specific forum. |
Property[] |
getProperties(long threadID)
Returns all tbe extended properties for the thread with the specified ID. |
java.lang.String |
getProperty(java.lang.String name,
long threadID)
Returns the value of an extended property for the thread with the specified ID. |
int |
getThreadCountByCategoryID(long categoryID)
Returns the number of threads in the specified category. |
int |
getThreadCountByCategoryIDAndFilter(long categoryID,
ResultFilter filter)
Returns the number of threads in the specified category after being filtered by the specified filter. |
int |
getThreadCountByForumID(long forumID)
Returns a count of all threads under the forum. |
int |
getThreadCountByForumIDAndFilter(long forumID,
ResultFilter filter)
Returns a count of all threads under the forum filtered by the specified result filter. |
ForumThread[] |
getThreadsByCategoryID(long categoryID)
Returns all of the IDs for threads a category. |
ForumThread[] |
getThreadsByCategoryIDAndFilter(long categoryID,
ResultFilter filter)
Returns all of the IDs for threads a category has filtered by the specified result filter. |
ForumThread[] |
getThreadsByForumID(long forumID)
Returns all of the IDs for threads a forum has. |
ForumThread[] |
getThreadsByForumIDAndFilter(long forumID,
ResultFilter filter)
Returns all of the IDs for threads a forum has filtered by the specified result filter. |
ForumThread[] |
getThreadsByForumIDAndFilter(long forumID,
ResultFilter filter,
boolean reduceData)
Returns all threads in a forum filtered by the specified result filter, with option to set forum name, unfilteredSubject, and unfilteredBody to null to reduce response size. |
void |
moveThread(long threadID,
long forumID)
Moves the thread with the specified ID to the forum with the specified ID. |
void |
setProperty(java.lang.String name,
java.lang.String value,
long threadID)
Set an extended for the property for the thread with the given ID. |
Method Detail |
---|
ForumThread getForumThread(long threadID) throws ForumThreadNotFoundException
ForumThread
by its ID.
threadID
- The ID of the thread.
ForumThreadNotFoundException
ForumThread[] getPopularThreads()
ForumThread[] getPopularThreadsByForumID(long forumID) throws ForumNotFoundException
forumID
- The ID of the forum to find the popular threads for.
ForumNotFoundException
int getThreadCountByForumID(long forumID) throws ForumNotFoundException
forumID
- ID of the forum to find the thread count for
ForumNotFoundException
int getThreadCountByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
forumID
- The ID of the forum to find the thread count for.filter
- The result filter to filter results with.
ForumNotFoundException
void deleteThread(long threadID) throws ForumThreadNotFoundException
threadID
- The ID of thread to delete.
ForumThreadNotFoundException
void moveThread(long threadID, long forumID) throws ForumThreadNotFoundException, ForumNotFoundException
threadID
- The ID of the thread to move.forumID
- The ID of the forum to move the thread to.
ForumThreadNotFoundException
ForumNotFoundException
Property[] getProperties(long threadID) throws ForumThreadNotFoundException
threadID
- The ID of the thread to retrieve properties for.
ForumThreadNotFoundException
void setProperty(java.lang.String name, java.lang.String value, long threadID) throws ForumThreadNotFoundException
name
- The name of the property.value
- The value of the property.threadID
- The ID of the thread to set an extended property for.
ForumThreadNotFoundException
java.lang.String getProperty(java.lang.String name, long threadID) throws ForumThreadNotFoundException
name
- The name of the propery.threadID
- The ID of the thread to retrieve the property for.
ForumThreadNotFoundException
void deleteProperty(java.lang.String name, long threadID) throws ForumThreadNotFoundException
name
- The name of the property to delete.threadID
- The ID of the thread to delete the property from.
ForumThreadNotFoundException
ForumThread[] getThreadsByForumID(long forumID) throws ForumNotFoundException
WSConstants.MAX_THREAD_RESULTS
the threads up to
WSConstants.MAX_THREAD_RESULTS
will be returned.
forumID
- The ID of the forum to grab threads for.
ForumNotFoundException
ForumThread[] getThreadsByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
forumID
- The forum to grab threads for.filter
- The result filter to filter the results with.
ForumNotFoundException
ForumThread[] getThreadsByForumIDAndFilter(long forumID, ResultFilter filter, boolean reduceData) throws ForumNotFoundException
forumID
- The forum to grab threads for.filter
- The result filter to filter the results with.reduceData
- Whether or not to set forum name, unfiltered subject and unfiltered body to null.
ForumNotFoundException
ForumThread[] getThreadsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
WSConstants.MAX_THREAD_RESULTS
the threads up to
WSConstants.MAX_THREAD_RESULTS
will be returned.
categoryID
- The ID of the category to grab threds for.
ForumCategoryNotFoundException
ForumThread[] getThreadsByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to grab threds for.
ForumCategoryNotFoundException
int getThreadCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to check the thread count for.
ForumCategoryNotFoundException
int getThreadCountByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
categoryID
- The ID of the category to check the thread count for.filter
- The filter to filter out results with.
ForumCategoryNotFoundException
ForumThread[] getPopularThreadsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
categoryID
- The id of the category.
ForumCategoryNotFoundException
- Thrown if the specified category does not exist.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |