Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs

com.jivesoftware.forum.webservices
Interface ForumService


public interface ForumService

Provides the ability to manipulate forums. This service will allow you to create, delete, move and acquire forums.


Method Summary
 Forum createForum(java.lang.String name, java.lang.String description)
          Creates a new forum under the root category.
 Forum createForumUnderCategory(java.lang.String name, java.lang.String description, long categoryID)
          Creates a new forum under the specified category.
 Forum createRestrictedForumUnderCategory(java.lang.String name, java.lang.String description, long categoryID, long userID)
          Bundles calls associated with creation of a new forum that sets the user as the moderator and sets negative permission for anonymous and registered users.
 void deleteForum(long forumID)
          Used to delete a forum by its ID.
 void deleteProperty(java.lang.String name, long forumID)
          Delete a property with the given name from the forum with the given forum ID.
 Forum getForum(long forumID)
          Returns a Forum by its ID.
 int getForumCount()
          Returns the count of all forums in the system.
 int getForumCount(long categoryID)
          Returns the number of forums under the specified category.
 int getForumCountByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter)
          Returns an array of IDs for all forums under this category.
 Forum[] getForums()
          Returns the IDs of all forums under the root category.
 Forum[] getForumsByCategoryID(long categoryID)
          Returns an array of IDs for all forums under this category.
 Forum[] getForumsByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter)
          Returns an array of IDs for all forums under this category.
 Forum[] getPopularForums()
          Returns the IDs of all popular forums.
 Property[] getProperties(long forumID)
          Returns all tbe extended properties for the forum with the forum with specified ID.
 java.lang.String getProperty(java.lang.String name, long forumID)
          Returns the value for a given property name.
 int getRecursiveForumCount(long categoryID)
          Returns the count of all forums under the category with the specified ID.
 Forum[] getRecursiveForums(long categoryID)
          Returns an array of forum ids for all forums under the category with the specified ID recursively.
 void mergeForums(long forumID1, long forumID2)
          Merges the content of two forums by copying the threads from Forum with ID forumID2 to forum with ID forumID1.
 void moveForums(long forumID, long categoryID)
          Move the forum with the specified ID to the category with the specified ID.
 void setProperty(java.lang.String name, java.lang.String value, long forumID)
          Set an extended for the property with the given forum ID.
 void updateForum(Forum forum)
          Updates changes to a forum to the system.
 

Method Detail

getForum

Forum getForum(long forumID)
               throws ForumNotFoundException
Returns a Forum by its ID.

Parameters:
forumID - The ID of the forum.
Returns:
The Forum object matching the ID.
Throws:
ForumNotFoundException

getForums

Forum[] getForums()
Returns the IDs of all forums under the root category.

Returns:
The IDs of all forums under the root category.

getPopularForums

Forum[] getPopularForums()
Returns the IDs of all popular forums.

Returns:
The IDs of all popular forums.

getForumCount

int getForumCount()
Returns the count of all forums in the system.

Returns:
The count of all forums in the system.

deleteForum

void deleteForum(long forumID)
                 throws ForumNotFoundException
Used to delete a forum by its ID.

Parameters:
forumID - The ID of the forum to delete.
Throws:
ForumNotFoundException

mergeForums

void mergeForums(long forumID1,
                 long forumID2)
                 throws ForumNotFoundException
Merges the content of two forums by copying the threads from Forum with ID forumID2 to forum with ID forumID1. Forum with ID forumID2 will be deleted after all content is merged.

Parameters:
forumID1 - The Forum to merge threads into.
forumID2 - The Forum to move all threads from.
Throws:
ForumNotFoundException

moveForums

void moveForums(long forumID,
                long categoryID)
                throws ForumNotFoundException,
                       ForumCategoryNotFoundException
Move the forum with the specified ID to the category with the specified ID.

Parameters:
forumID - The ID of the forum to move.
categoryID - The ID of the category to move the forum to.
Throws:
ForumNotFoundException
ForumCategoryNotFoundException

getRecursiveForums

Forum[] getRecursiveForums(long categoryID)
                           throws ForumCategoryNotFoundException
Returns an array of forum ids for all forums under the category with the specified ID recursively.

Parameters:
categoryID - The ID of the category to get the ids of the forums.
Returns:
An array of forum IDs.
Throws:
ForumCategoryNotFoundException

getForumsByCategoryID

Forum[] getForumsByCategoryID(long categoryID)
                              throws ForumCategoryNotFoundException
Returns an array of IDs for all forums under this category. This returns only the direct children of the category, one level deep.

Parameters:
categoryID - The ID of the category to get the ids of the forums.
Returns:
An array of forum IDs for the category with the specified ID.
Throws:
ForumCategoryNotFoundException

getForumsByCategoryIDWithFilter

Forum[] getForumsByCategoryIDWithFilter(long categoryID,
                                        ResultFilter resultFilter)
                                        throws ForumCategoryNotFoundException
Returns an array of IDs for all forums under this category. This returns only the direct children of the category, one level deep. Filters on the resultFilter.

Parameters:
categoryID - The ID of the category to get the ids of the forums.
Returns:
An array of forum IDs for the category with the specified ID.
Throws:
ForumCategoryNotFoundException

getRecursiveForumCount

int getRecursiveForumCount(long categoryID)
                           throws ForumCategoryNotFoundException
Returns the count of all forums under the category with the specified ID.

Parameters:
categoryID - The ID of the forum to get the ids of the forums .
Returns:
The count of all forums under a category.
Throws:
ForumCategoryNotFoundException

getForumCountByCategoryIDWithFilter

int getForumCountByCategoryIDWithFilter(long categoryID,
                                        ResultFilter resultFilter)
                                        throws ForumCategoryNotFoundException
Returns an array of IDs for all forums under this category. This returns only the direct children of the category, one level deep. Filters on the resultFilter.

Parameters:
categoryID - The ID of the category to get the ids of the forums.
resultFilter - to filter on.
Returns:
An array of forum IDs for the category with the specified ID.
Throws:
ForumCategoryNotFoundException

getProperties

Property[] getProperties(long forumID)
                         throws ForumNotFoundException
Returns all tbe extended properties for the forum with the forum with specified ID.

Parameters:
forumID - The ID of the forum to retrieve properties for.
Returns:
An array of properties for the forum with the given ID.
Throws:
ForumNotFoundException

deleteProperty

void deleteProperty(java.lang.String name,
                    long forumID)
                    throws ForumNotFoundException
Delete a property with the given name from the forum with the given forum ID.

Parameters:
name - The name of the property to delete.
forumID - The ID of the forum to delete the property from.
Throws:
ForumNotFoundException

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value,
                 long forumID)
                 throws ForumNotFoundException
Set an extended for the property with the given forum ID.

Parameters:
name - The name of the property.
value - The value of the property.
forumID - The ID of the forum to set an extended property for.
Throws:
ForumNotFoundException

getProperty

java.lang.String getProperty(java.lang.String name,
                             long forumID)
                             throws ForumNotFoundException
Returns the value for a given property name.

Parameters:
name - the property name.
forumID - the ID of the forum to retrieve the propery for.
Returns:
the value of the property, null if the property is not found.
Throws:
ForumNotFoundException

getForumCount

int getForumCount(long categoryID)
                  throws ForumCategoryNotFoundException
Returns the number of forums under the specified category.

Parameters:
categoryID - The ID of the category.
Returns:
The number of forums of the category
Throws:
ForumCategoryNotFoundException - Thrown if the specified category does not exist.

createForum

Forum createForum(java.lang.String name,
                  java.lang.String description)
Creates a new forum under the root category.

Parameters:
name - The name of the forum.
description - A short description of the purpose of the forum.
Returns:
The newly created forum.

createForumUnderCategory

Forum createForumUnderCategory(java.lang.String name,
                               java.lang.String description,
                               long categoryID)
                               throws ForumCategoryNotFoundException
Creates a new forum under the specified category.

Parameters:
name - The name of the forum.
description - A short description of the purpose of the forum.
categoryID -
Returns:
The newly created forum.
Throws:
ForumCategoryNotFoundException - Thrown if the specified category does not exist.

updateForum

void updateForum(Forum forum)
                 throws ForumNotFoundException,
                        NameAlreadyExistsException
Updates changes to a forum to the system.

Parameters:
forum - The forum to update.
Throws:
ForumNotFoundException
NameAlreadyExistsException

createRestrictedForumUnderCategory

Forum createRestrictedForumUnderCategory(java.lang.String name,
                                         java.lang.String description,
                                         long categoryID,
                                         long userID)
                                         throws ForumCategoryNotFoundException,
                                                UserNotFoundException
Bundles calls associated with creation of a new forum that sets the user as the moderator and sets negative permission for anonymous and registered users.

Parameters:
name -
description -
categoryID -
userID -
Returns:
Throws:
ForumCategoryNotFoundException
UserNotFoundException

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.