com.jivesoftware.forum.webservices.server
Class ForumCategoryServiceImpl

java.lang.Object
  com.jivesoftware.forum.webservices.server.ForumCategoryServiceImpl

All Implemented Interfaces:

ForumCategoryService

public class ForumCategoryServiceImpl
extends java.lang.Object
implements ForumCategoryService

Constructor Summary

ForumCategoryServiceImpl()

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForumCategoryServiceImpl

public ForumCategoryServiceImpl()

Method Detail

getForumCategory

public ForumCategory getForumCategory(long categoryID)
                               throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns a ForumCategory by its id

Specified by:

getForumCategory in interface ForumCategoryService

Parameters:

categoryID - id of the category

Returns:

the ForumCategory object the id

Throws:

ForumCategoryNotFoundException

createCategory

public ForumCategory createCategory(java.lang.String name,
                                    java.lang.String description)

Description copied from interface: ForumCategoryService

Creates a new ForumCategory as a sub-category of the root category using the name and description.

Specified by:

createCategory in interface ForumCategoryService

Parameters:

name - the name of the new category.

description - the description of the new category.

Returns:

a new ForumCategory.

createSubCategory

public ForumCategory createSubCategory(java.lang.String name,
                                       java.lang.String description,
                                       long categoryID)
                                throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Creates a new ForumCategory as a sub-category off of the specified category.

Specified by:

createSubCategory in interface ForumCategoryService

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

public void deleteCategory(long categoryID)
                    throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Used to delete the specified category

Specified by:

deleteCategory in interface ForumCategoryService

Parameters:

categoryID - the id of the category to delete

Throws:

ForumCategoryNotFoundException

updateCategory

public void updateCategory(ForumCategory category)
                    throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Update a ForumCategory

Specified by:

updateCategory in interface ForumCategoryService

Parameters:

category - forum category to update

Throws:

ForumCategoryNotFoundException

getProperties

public Property[] getProperties(long categoryID)
                         throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns all tbe extended properties for the category with the specified id.

Specified by:

getProperties in interface ForumCategoryService

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

public void setProperty(java.lang.String name,
                        java.lang.String value,
                        long categoryID)
                 throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Set an extended propery for the category with the given category id.

Specified by:

setProperty in interface ForumCategoryService

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

public java.lang.String getProperty(java.lang.String name,
                                    long categoryID)
                             throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns the extended property value for the specified name.

Specified by:

getProperty in interface ForumCategoryService

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

public void deleteProperty(java.lang.String name,
                           long categoryID)
                    throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Delete a property with the given name from the category with the given id.

Specified by:

deleteProperty in interface ForumCategoryService

Parameters:

name - the name of the property to delete.

categoryID - id of the category to delete the property from.

Throws:

ForumCategoryNotFoundException

getCategoriesByCategoryID

public ForumCategory[] getCategoriesByCategoryID(long categoryID)
                                          throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns the child categories of the category with the given id. This is not recursive.

Specified by:

getCategoriesByCategoryID in interface ForumCategoryService

Parameters:

categoryID - the id of the category.

Returns:

the child catetogories for the given category.

Throws:

ForumCategoryNotFoundException

getRecursiveCategoryCount

public int getRecursiveCategoryCount()

Description copied from interface: ForumCategoryService

Returns a count of all the categories in the system.

Specified by:

getRecursiveCategoryCount in interface ForumCategoryService

Returns:

count of the categories

getRecursiveCategoryCountByCategoryID

public int getRecursiveCategoryCountByCategoryID(long categoryID)
                                          throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns a count of all the categories under a category

Specified by:

getRecursiveCategoryCountByCategoryID in interface ForumCategoryService

Parameters:

categoryID - The id of the category.

Returns:

count of the categories

Throws:

ForumCategoryNotFoundException

getRecursiveCategories

public ForumCategory[] getRecursiveCategories()

Description copied from interface: ForumCategoryService

Returns all of the categories in the system recursively.

Specified by:

getRecursiveCategories in interface ForumCategoryService

Returns:

all of the categories in the system recursively.

getRecursiveCategoriesByCategoryID

public ForumCategory[] getRecursiveCategoriesByCategoryID(long categoryID)
                                                   throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns all of the categories under the specified category recursively.

Specified by:

getRecursiveCategoriesByCategoryID in interface ForumCategoryService

Parameters:

categoryID - The id of the category.

Returns:

All of the categories under the category.

Throws:

ForumCategoryNotFoundException

getRecursiveForums

public Forum[] getRecursiveForums()

Description copied from interface: ForumCategoryService

Returns all of the forums in the system recursively.

Specified by:

getRecursiveForums in interface ForumCategoryService

Returns:

all of the forums in the system recursively.

getRecursiveForumsByCategoryID

public Forum[] getRecursiveForumsByCategoryID(long categoryID)
                                       throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns all of the forums under the specified category recursively.

Specified by:

getRecursiveForumsByCategoryID in interface ForumCategoryService

Parameters:

categoryID - the id of the category.

Returns:

All of the forums under the category

Throws:

ForumCategoryNotFoundException

getRecursiveForumsByCategoryIDWithFilter

public Forum[] getRecursiveForumsByCategoryIDWithFilter(long categoryID,
                                                        ResultFilter resultFilter)
                                                 throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns all of the forums under the specified category recursively. Filters on the resultFilter.

Specified by:

getRecursiveForumsByCategoryIDWithFilter in interface ForumCategoryService

Parameters:

categoryID - the id of the category.

resultFilter - to filter on

Returns:

All of the forums under the category

Throws:

ForumCategoryNotFoundException

getRecursiveForumCount

public int getRecursiveForumCount()

Description copied from interface: ForumCategoryService

Returns a count of all the forums in the system.

Specified by:

getRecursiveForumCount in interface ForumCategoryService

Returns:

a count of all the forums in the system.

getRecursiveForumCountByCategoryID

public int getRecursiveForumCountByCategoryID(long categoryID)
                                       throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns a count of all the forums under a category.

Specified by:

getRecursiveForumCountByCategoryID in interface ForumCategoryService

Returns:

Throws:

ForumCategoryNotFoundException

getRecursiveForumCountByCategoryIDWithFilter

public int getRecursiveForumCountByCategoryIDWithFilter(long categoryID,
                                                        ResultFilter resultFilter)
                                                 throws ForumCategoryNotFoundException

Description copied from interface: ForumCategoryService

Returns a count of all the forums under a category. Filters on the resultFilter.

Specified by:

getRecursiveForumCountByCategoryIDWithFilter in interface ForumCategoryService

Parameters:

categoryID - * @param resultFilter to filter on

Returns:

Throws:

ForumCategoryNotFoundException

createRestrictedSubCategory

public ForumCategory createRestrictedSubCategory(java.lang.String name,
                                                 java.lang.String description,
                                                 long categoryID,
                                                 long userID)
                                          throws ForumCategoryNotFoundException,
                                                 UserNotFoundException

Description copied from interface: ForumCategoryService

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.

Specified by:

createRestrictedSubCategory in interface ForumCategoryService

Returns:

Throws:

ForumCategoryNotFoundException

UserNotFoundException