com.sap.netweaver.coll.forums.api

Interface IForumManager

public interface IForumManager

Entry point for accessing forums in the forum application.

Method Summary

IForum	createForum(long categoryID, String name, String description) Creates forum under another category part of the context.
IForum	createForum(String name) Creates forum under context root category.
IForum	createForum(String name, String description) Creates forum under context root category.
void	deleteForum(long forumID) Deletes forum.
IForum	getForum(com.sap.netweaver.coll.forums.ejb.api.Forum forum) Retrieves forum from transfer object passed by EJB layer.
IForum	getForum(long forumID) Retrieves forum.
void	merge(long sourceForumID, long destinationForumID) Merges the content of two forums.

Method Detail

getForum

IForum getForum(long forumID)
                throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

Retrieves forum.

Parameters:

forumID -

Returns:

retrieved forum

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException - when forum is not found

createForum

IForum createForum(String name,
                   String description)

Creates forum under context root category.

Parameters:

name - the name of the forum

description - the description of the forum

Returns:

created forum

See Also:

ForumContext

createForum

IForum createForum(String name)

Creates forum under context root category.

Parameters:

name - the name of the forum

Returns:

created forum

See Also:

ForumContext

deleteForum

void deleteForum(long forumID)
                 throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

Deletes forum.

Parameters:

forumID - the unique identifier of the forum to be deleted.

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException - when forum is not found

getForum

IForum getForum(com.sap.netweaver.coll.forums.ejb.api.Forum forum)

Retrieves forum from transfer object passed by EJB layer.

Parameters:

forum -

Returns:

forum

merge

void merge(long sourceForumID,
           long destinationForumID)
           throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException

Merges the content of two forums. Merges the content of two forums by copying the threads from sourceForumID to destinationForumID. sourceForumID will be deleted after all content is merged.

Parameters:

sourceForumID - copy threads from this forum

destinationForumID - copy threads to this forum

Throws:

com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException - when forum is not found

createForum

IForum createForum(long categoryID,
                   String name,
                   String description)
                   throws com.sap.netweaver.coll.forums.exceptions.ForumCategoryNotFoundException

Creates forum under another category part of the context.

Parameters:

categoryID - the root of the forum

name - the name of the forum

description - the description of the forum

Returns:

created forum

Throws:

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