com.sap.netweaver.coll.forums.api

Interface IForumCategoryManager

public interface IForumCategoryManager

Entry point for managing categories in forums application.

Method Summary

IForumCategory	createForumCategory(String name) Creates forum category under the context root.
IForumCategory	createForumCategory(String name, String description) Creates forum category under the context root
void	deleteForumCategory(long categoryID) Deletes forum category.
IForumCategory	getForumCategory(long categoryID) Return forum category.
IForumCategory	getParentForumCategory(long categoryID) Returns the parent category of a category
IForumCategory	getRootForumCategory() Returns the root forum category of the context

Method Detail

getForumCategory

IForumCategory getForumCategory(long categoryID)
                                throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Return forum category.

Parameters:

categoryID - the category unique identifier

Returns:

category

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

deleteForumCategory

void deleteForumCategory(long categoryID)

Deletes forum category.

Parameters:

categoryID - the category unique identifier

createForumCategory

IForumCategory createForumCategory(String name)
                                   throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException,
                                          com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Creates forum category under the context root.

Parameters:

name - the name of the category.

Returns:

the created category

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

See Also:

ForumContext

createForumCategory

IForumCategory createForumCategory(String name,
                                   String description)
                                   throws com.sap.netweaver.coll.forums.exceptions.UnauthorizedException,
                                          com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Creates forum category under the context root

Parameters:

name - the name of the category

description - the description of the category

Returns:

the created category

Throws:

com.sap.netweaver.coll.forums.exceptions.UnauthorizedException

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

See Also:

ForumContext

getParentForumCategory

IForumCategory getParentForumCategory(long categoryID)
                                      throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Returns the parent category of a category

Parameters:

categoryID - the category unique identifier

Returns:

the parent category

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

getRootForumCategory

IForumCategory getRootForumCategory()
                                    throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Returns the root forum category of the context

Returns:

the root category

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

See Also:

ForumContext