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

com.jivesoftware.forum.webservices
Interface ForumCategoryService


public interface ForumCategoryService

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


Method Summary
 ForumCategory createCategory(java.lang.String name, java.lang.String description)
          Creates a new ForumCategory as a sub-category of the root category using the name and description.
 ForumCategory createRestrictedSubCategory(java.lang.String name, java.lang.String description, long categoryID, long userID)
          Bundles calls associated with creation of a new sub category that sets the user as the category admin and sets negative permission for anonymous and registered users.
 ForumCategory createSubCategory(java.lang.String name, java.lang.String description, long categoryID)
          Creates a new ForumCategory as a sub-category off of the specified category.
 void deleteCategory(long categoryID)
          Used to delete the specified category
 void deleteProperty(java.lang.String name, long categoryID)
          Delete a property with the given name from the category with the given id.
 ForumCategory[] getCategoriesByCategoryID(long categoryID)
          Returns the child categories of the category with the given id.
 ForumCategory getForumCategory(long categoryID)
          Returns a ForumCategory by its id
 Property[] getProperties(long categoryID)
          Returns all tbe extended properties for the category with the specified id.
 java.lang.String getProperty(java.lang.String name, long categoryID)
          Returns the extended property value for the specified name.
 ForumCategory[] getRecursiveCategories()
          Returns all of the categories in the system recursively.
 ForumCategory[] getRecursiveCategoriesByCategoryID(long categoryID)
          Returns all of the categories under the specified category recursively.
 int getRecursiveCategoryCount()
          Returns a count of all the categories in the system.
 int getRecursiveCategoryCountByCategoryID(long categoryID)
          Returns a count of all the categories under a category
 int getRecursiveForumCount()
          Returns a count of all the forums in the system.
 int getRecursiveForumCountByCategoryID(long categoryID)
          Returns a count of all the forums under a category.
 int getRecursiveForumCountByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter)
          Returns a count of all the forums under a category.
 Forum[] getRecursiveForums()
          Returns all of the forums in the system recursively.
 Forum[] getRecursiveForumsByCategoryID(long categoryID)
          Returns all of the forums under the specified category recursively.
 Forum[] getRecursiveForumsByCategoryIDWithFilter(long categoryID, ResultFilter resultFilter)
          Returns all of the forums under the specified category recursively.
 void setProperty(java.lang.String name, java.lang.String value, long categoryID)
          Set an extended propery for the category with the given category id.
 void updateCategory(ForumCategory category)
          Update a ForumCategory
 

Method Detail

getForumCategory

ForumCategory getForumCategory(long categoryID)
                               throws ForumCategoryNotFoundException
Returns a ForumCategory by its id

Parameters:
categoryID - id of the category
Returns:
the ForumCategory object the id
Throws:
ForumCategoryNotFoundException

createCategory

ForumCategory createCategory(java.lang.String name,
                             java.lang.String description)
Creates a new ForumCategory as a sub-category of the root category using the name and description.

Parameters:
name - the name of the new category.
description - the description of the new category.
Returns:
a new ForumCategory.

createSubCategory

ForumCategory createSubCategory(java.lang.String name,
                                java.lang.String description,
                                long categoryID)
                                throws ForumCategoryNotFoundException
Creates a new ForumCategory as a sub-category off of the specified category.

Parameters:
name - the name of the new category.
description - the description of the new category.
categoryID - Category to use as the parent
Returns:
a new ForumCategory.
Throws:
ForumCategoryNotFoundException

deleteCategory

void deleteCategory(long categoryID)
                    throws ForumCategoryNotFoundException
Used to delete the specified category

Parameters:
categoryID - the id of the category to delete
Throws:
ForumCategoryNotFoundException

updateCategory

void updateCategory(ForumCategory category)
                    throws ForumCategoryNotFoundException
Update a ForumCategory

Parameters:
category - forum category to update
Throws:
ForumCategoryNotFoundException

getProperties

Property[] getProperties(long categoryID)
                         throws ForumCategoryNotFoundException
Returns all tbe extended properties for the category with the specified id.

Parameters:
categoryID - id of the category to retrieve properties for.
Returns:
an array of properties for the category with the given id.
Throws:
ForumCategoryNotFoundException

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value,
                 long categoryID)
                 throws ForumCategoryNotFoundException
Set an extended propery for the category with the given category id.

Parameters:
name - The name of the property.
value - The value of the property.
categoryID - The ID of the category to set an extended property for.
Throws:
ForumCategoryNotFoundException

getProperty

java.lang.String getProperty(java.lang.String name,
                             long categoryID)
                             throws ForumCategoryNotFoundException
Returns the extended property value for the specified name.

Parameters:
name - the name of the extended property
categoryID - the ID of the category to retrieve the propery for.
Returns:
the property value, null if the property is not found.
Throws:
ForumCategoryNotFoundException

deleteProperty

void deleteProperty(java.lang.String name,
                    long categoryID)
                    throws ForumCategoryNotFoundException
Delete a property with the given name from the category with the given id.

Parameters:
name - the name of the property to delete.
categoryID - id of the category to delete the property from.
Throws:
ForumCategoryNotFoundException

getCategoriesByCategoryID

ForumCategory[] getCategoriesByCategoryID(long categoryID)
                                          throws ForumCategoryNotFoundException
Returns the child categories of the category with the given id. This is not recursive.

Parameters:
categoryID - the id of the category.
Returns:
the child catetogories for the given category.
Throws:
ForumCategoryNotFoundException

getRecursiveCategories

ForumCategory[] getRecursiveCategories()
Returns all of the categories in the system recursively.

Returns:
all of the categories in the system recursively.

getRecursiveCategoriesByCategoryID

ForumCategory[] getRecursiveCategoriesByCategoryID(long categoryID)
                                                   throws ForumCategoryNotFoundException
Returns all of the categories under the specified category recursively.

Parameters:
categoryID - The id of the category.
Returns:
All of the categories under the category.
Throws:
ForumCategoryNotFoundException

getRecursiveCategoryCount

int getRecursiveCategoryCount()
Returns a count of all the categories in the system.

Returns:
count of the categories

getRecursiveCategoryCountByCategoryID

int getRecursiveCategoryCountByCategoryID(long categoryID)
                                          throws ForumCategoryNotFoundException
Returns a count of all the categories under a category

Parameters:
categoryID - The id of the category.
Returns:
count of the categories
Throws:
ForumCategoryNotFoundException

getRecursiveForums

Forum[] getRecursiveForums()
Returns all of the forums in the system recursively.

Returns:
all of the forums in the system recursively.

getRecursiveForumsByCategoryID

Forum[] getRecursiveForumsByCategoryID(long categoryID)
                                       throws ForumCategoryNotFoundException
Returns all of the forums under the specified category recursively.

Parameters:
categoryID - the id of the category.
Returns:
All of the forums under the category
Throws:
ForumCategoryNotFoundException

getRecursiveForumsByCategoryIDWithFilter

Forum[] getRecursiveForumsByCategoryIDWithFilter(long categoryID,
                                                 ResultFilter resultFilter)
                                                 throws ForumCategoryNotFoundException
Returns all of the forums under the specified category recursively. Filters on the resultFilter.

Parameters:
categoryID - the id of the category.
resultFilter - to filter on
Returns:
All of the forums under the category
Throws:
ForumCategoryNotFoundException

getRecursiveForumCount

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

Returns:
a count of all the forums in the system.

getRecursiveForumCountByCategoryID

int getRecursiveForumCountByCategoryID(long categoryID)
                                       throws ForumCategoryNotFoundException
Returns a count of all the forums under a category.

Parameters:
categoryID -
Returns:
Throws:
ForumCategoryNotFoundException

getRecursiveForumCountByCategoryIDWithFilter

int getRecursiveForumCountByCategoryIDWithFilter(long categoryID,
                                                 ResultFilter resultFilter)
                                                 throws ForumCategoryNotFoundException
Returns a count of all the forums under a category. Filters on the resultFilter.

Parameters:
categoryID - * @param resultFilter to filter on
Returns:
Throws:
ForumCategoryNotFoundException

createRestrictedSubCategory

ForumCategory createRestrictedSubCategory(java.lang.String name,
                                          java.lang.String description,
                                          long categoryID,
                                          long userID)
                                          throws ForumCategoryNotFoundException,
                                                 UserNotFoundException
Bundles calls associated with creation of a new sub category that sets the user as the category admin 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.