|
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 |
java.lang.Objectcom.jivesoftware.forum.webservices.server.ForumThreadServiceImpl
public class ForumThreadServiceImpl
Constructor Summary | |
---|---|
ForumThreadServiceImpl()
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ForumThreadServiceImpl()
Method Detail |
---|
public ForumThread getForumThread(long threadID) throws ForumThreadNotFoundException
ForumThreadService
ForumThread
by its ID.
getForumThread
in interface ForumThreadService
threadID
- The ID of the thread.
ForumThreadNotFoundException
public ForumThread[] getPopularThreads()
ForumThreadService
getPopularThreads
in interface ForumThreadService
public ForumThread[] getPopularThreadsByForumID(long forumID) throws ForumNotFoundException
ForumThreadService
getPopularThreadsByForumID
in interface ForumThreadService
forumID
- The ID of the forum to find the popular threads for.
ForumNotFoundException
public ForumThread[] getPopularThreadsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumThreadService
getPopularThreadsByCategoryID
in interface ForumThreadService
categoryID
- The id of the category.
ForumCategoryNotFoundException
- Thrown if the specified category does not exist.public ForumThread[] getThreadsByForumID(long forumID) throws ForumNotFoundException
ForumThreadService
WSConstants.MAX_THREAD_RESULTS
the threads up to
WSConstants.MAX_THREAD_RESULTS
will be returned.
getThreadsByForumID
in interface ForumThreadService
forumID
- The ID of the forum to grab threads for.
ForumNotFoundException
public ForumThread[] getThreadsByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
ForumThreadService
getThreadsByForumIDAndFilter
in interface ForumThreadService
forumID
- The forum to grab threads for.filter
- The result filter to filter the results with.
ForumNotFoundException
public ForumThread[] getThreadsByForumIDAndFilter(long forumID, ResultFilter filter, boolean reduceData) throws ForumNotFoundException
ForumThreadService
getThreadsByForumIDAndFilter
in interface ForumThreadService
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
public int getThreadCountByForumID(long forumID) throws ForumNotFoundException
ForumThreadService
getThreadCountByForumID
in interface ForumThreadService
forumID
- ID of the forum to find the thread count for
ForumNotFoundException
public int getThreadCountByForumIDAndFilter(long forumID, ResultFilter filter) throws ForumNotFoundException
ForumThreadService
getThreadCountByForumIDAndFilter
in interface ForumThreadService
forumID
- The ID of the forum to find the thread count for.filter
- The result filter to filter results with.
ForumNotFoundException
public ForumThread[] getThreadsByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumThreadService
WSConstants.MAX_THREAD_RESULTS
the threads up to
WSConstants.MAX_THREAD_RESULTS
will be returned.
getThreadsByCategoryID
in interface ForumThreadService
categoryID
- The ID of the category to grab threds for.
ForumCategoryNotFoundException
public ForumThread[] getThreadsByCategoryIDAndFilter(long categoryID, ResultFilter filter) throws ForumCategoryNotFoundException
ForumThreadService
getThreadsByCategoryIDAndFilter
in interface ForumThreadService
categoryID
- The ID of the category to grab threds for.
ForumCategoryNotFoundException
public int getThreadCountByCategoryID(long categoryID) throws ForumCategoryNotFoundException
ForumThreadService
getThreadCountByCategoryID
in interface ForumThreadService
categoryID
- The ID of the category to check the thread count for.
ForumCategoryNotFoundException
public int getThreadCountByCategoryIDAndFilter(long CategoryID, ResultFilter filter) throws ForumCategoryNotFoundException
ForumThreadService
getThreadCountByCategoryIDAndFilter
in interface ForumThreadService
CategoryID
- The ID of the category to check the thread count for.filter
- The filter to filter out results with.
ForumCategoryNotFoundException
public void deleteThread(long threadID) throws ForumThreadNotFoundException
ForumThreadService
deleteThread
in interface ForumThreadService
threadID
- The ID of thread to delete.
ForumThreadNotFoundException
public void moveThread(long threadID, long forumID) throws ForumThreadNotFoundException, ForumNotFoundException
ForumThreadService
moveThread
in interface ForumThreadService
threadID
- The ID of the thread to move.forumID
- The ID of the forum to move the thread to.
ForumThreadNotFoundException
ForumNotFoundException
public Property[] getProperties(long threadID) throws ForumThreadNotFoundException
ForumThreadService
getProperties
in interface ForumThreadService
threadID
- The ID of the thread to retrieve properties for.
ForumThreadNotFoundException
public void setProperty(java.lang.String name, java.lang.String value, long threadID) throws ForumThreadNotFoundException
ForumThreadService
setProperty
in interface ForumThreadService
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
public java.lang.String getProperty(java.lang.String name, long threadID) throws ForumThreadNotFoundException
ForumThreadService
getProperty
in interface ForumThreadService
name
- The name of the propery.threadID
- The ID of the thread to retrieve the property for.
ForumThreadNotFoundException
public void deleteProperty(java.lang.String name, long threadID) throws ForumThreadNotFoundException
ForumThreadService
deleteProperty
in interface ForumThreadService
name
- The name of the property to delete.threadID
- The ID of the thread to delete the property from.
ForumThreadNotFoundException
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |