com.jivesoftware.forum.webservices
Interface ForumThreadService

All Known Implementing Classes:

ForumThreadServiceImpl

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.
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

getForumThread

ForumThread getForumThread(long threadID)
                           throws ForumThreadNotFoundException

Returns a ForumThread by its ID.

Parameters:

threadID - The ID of the thread.

Returns:

The ForumThread object by the ID.

Throws:

ForumThreadNotFoundException

getPopularThreads

ForumThread[] getPopularThreads()

Returns an array of thread IDs for all the popular threads in the system.

Returns:

An array of popular thread IDs in the system.

getPopularThreadsByForumID

ForumThread[] getPopularThreadsByForumID(long forumID)
                                         throws ForumNotFoundException

Returns an array of threadIDs for all the popular threads for a specific forum.

Parameters:

forumID - The ID of the forum to find the popular threads for.

Returns:

An array of IDs for all the popular threads for a specific forum.

Throws:

ForumNotFoundException

getThreadCountByForumID

int getThreadCountByForumID(long forumID)
                            throws ForumNotFoundException

Returns a count of all threads under the forum.

Parameters:

forumID - ID of the forum to find the thread count for

Returns:

a count of all threads under the forum.

Throws:

ForumNotFoundException

getThreadCountByForumIDAndFilter

int getThreadCountByForumIDAndFilter(long forumID,
                                     ResultFilter filter)
                                     throws ForumNotFoundException

Returns a count of all threads under the forum filtered by the specified result filter.

Parameters:

forumID - The ID of the forum to find the thread count for.

filter - The result filter to filter results with.

Returns:

A count of all threads under the forum.

Throws:

ForumNotFoundException

deleteThread

void deleteThread(long threadID)
                  throws ForumThreadNotFoundException

Deletes a thread with the specified ID.

Parameters:

threadID - The ID of thread to delete.

Throws:

ForumThreadNotFoundException

moveThread

void moveThread(long threadID,
                long forumID)
                throws ForumThreadNotFoundException,
                       ForumNotFoundException

Moves the thread with the specified ID to the forum with the specified ID.

Parameters:

threadID - The ID of the thread to move.

forumID - The ID of the forum to move the thread to.

Throws:

ForumThreadNotFoundException

ForumNotFoundException

getProperties

Property[] getProperties(long threadID)
                         throws ForumThreadNotFoundException

Returns all tbe extended properties for the thread with the specified ID.

Parameters:

threadID - The ID of the thread to retrieve properties for.

Returns:

An array of extended properties for the thread with the given ID.

Throws:

ForumThreadNotFoundException

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value,
                 long threadID)
                 throws ForumThreadNotFoundException

Set an extended for the property for the thread with the given ID.

Parameters:

name - The name of the property.

value - The value of the property.

threadID - The ID of the thread to set an extended property for.

Throws:

ForumThreadNotFoundException

getProperty

java.lang.String getProperty(java.lang.String name,
                             long threadID)
                             throws ForumThreadNotFoundException

Returns the value of an extended property for the thread with the specified ID.

Parameters:

name - The name of the propery.

threadID - The ID of the thread to retrieve the property for.

Returns:

the value of the property, null if not found for the given thread ID.

Throws:

ForumThreadNotFoundException

deleteProperty

void deleteProperty(java.lang.String name,
                    long threadID)
                    throws ForumThreadNotFoundException

Delete a property with the given name from the thread with the given ID.

Parameters:

name - The name of the property to delete.

threadID - The ID of the thread to delete the property from.

Throws:

ForumThreadNotFoundException

getThreadsByForumID

ForumThread[] getThreadsByForumID(long forumID)
                                  throws ForumNotFoundException

Returns all of the IDs for threads a forum has. If the number of threads exceeds WSConstants.MAX_THREAD_RESULTS the threads up to WSConstants.MAX_THREAD_RESULTS will be returned.

Parameters:

forumID - The ID of the forum to grab threads for.

Returns:

An array of thread IDs for a forum.

Throws:

ForumNotFoundException

getThreadsByForumIDAndFilter

ForumThread[] getThreadsByForumIDAndFilter(long forumID,
                                           ResultFilter filter)
                                           throws ForumNotFoundException

Returns all of the IDs for threads a forum has filtered by the specified result filter.

Parameters:

forumID - The forum to grab threads for.

filter - The result filter to filter the results with.

Returns:

An array of thread IDs for a forum.

Throws:

ForumNotFoundException

getThreadsByCategoryID

ForumThread[] getThreadsByCategoryID(long categoryID)
                                     throws ForumCategoryNotFoundException

Returns all of the IDs for threads a category. If the number of threads exceeds WSConstants.MAX_THREAD_RESULTS the threads up to WSConstants.MAX_THREAD_RESULTS will be returned.

Parameters:

categoryID - The ID of the category to grab threds for.

Returns:

An array of thread IDs for a category.

Throws:

ForumCategoryNotFoundException

getThreadsByCategoryIDAndFilter

ForumThread[] getThreadsByCategoryIDAndFilter(long categoryID,
                                              ResultFilter filter)
                                              throws ForumCategoryNotFoundException

Returns all of the IDs for threads a category has filtered by the specified result filter.

Parameters:

categoryID - The ID of the category to grab threds for.

Returns:

An array of threads for a category.

Throws:

ForumCategoryNotFoundException

getThreadCountByCategoryID

int getThreadCountByCategoryID(long categoryID)
                               throws ForumCategoryNotFoundException

Returns the number of threads in the specified category.

Parameters:

categoryID - The ID of the category to check the thread count for.

Returns:

The number of threads in the category.

Throws:

ForumCategoryNotFoundException

getThreadCountByCategoryIDAndFilter

int getThreadCountByCategoryIDAndFilter(long categoryID,
                                        ResultFilter filter)
                                        throws ForumCategoryNotFoundException

Returns the number of threads in the specified category after being filtered by the specified filter.

Parameters:

categoryID - The ID of the category to check the thread count for.

filter - The filter to filter out results with.

Returns:

The number of threads in the category after the filter has been applied.

Throws:

ForumCategoryNotFoundException

getPopularThreadsByCategoryID

ForumThread[] getPopularThreadsByCategoryID(long categoryID)
                                            throws ForumCategoryNotFoundException

Returns an array of popular threads by category.

Parameters:

categoryID - The id of the category.

Returns:

An array of threads for a category.

Throws:

ForumCategoryNotFoundException - Thrown if the specified category does not exist.