com.sap.netweaver.coll.forums.api

Interface IForumThreadManager


public interface IForumThreadManager

Entry point for managing threads in the forum application.


Method Summary
 IForumThread createForumThread(long forumID, long messageID)
          Creates forum thread using existing message.
 IForumThread createForumThread(long forumID, String subject, String message)
          Creates thread in a forum
 void deleteForumThread(long threadID)
          Deletes forum thread
 IForumThread getForumThread(long threadID)
          Retrieves forum thread
 IForumMessage getForumThreadMessage(long threadID)
          Retrieves the root message of thread
 

Method Detail

getForumThreadMessage

IForumMessage getForumThreadMessage(long threadID)
                                    throws com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException
Retrieves the root message of thread

Parameters:
threadID - the thread unique identifier
Returns:
the root message
Throws:
com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException

getForumThread

IForumThread getForumThread(long threadID)
                            throws com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException
Retrieves forum thread

Parameters:
threadID - the thread unique identifier
Returns:
the thread
Throws:
com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException

deleteForumThread

void deleteForumThread(long threadID)
                       throws com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException,
                              com.sap.netweaver.coll.forums.exceptions.ForumThreadLockedException
Deletes forum thread

Parameters:
threadID - the thread unique identifier
Throws:
com.sap.netweaver.coll.forums.exceptions.ForumThreadNotFoundException
com.sap.netweaver.coll.forums.exceptions.ForumThreadLockedException

createForumThread

IForumThread createForumThread(long forumID,
                               String subject,
                               String message)
                               throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                      com.sap.netweaver.coll.forums.exceptions.MessageRejectedException
Creates thread in a forum

Parameters:
forumID - the forum unique identifier
subject - the subject of the thread
message - the message body of the thread
Returns:
the thread
Throws:
com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException
com.sap.netweaver.coll.forums.exceptions.MessageRejectedException

createForumThread

IForumThread createForumThread(long forumID,
                               long messageID)
                               throws com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException,
                                      com.sap.netweaver.coll.forums.exceptions.ForumMessageNotFoundException,
                                      com.sap.netweaver.coll.forums.exceptions.MessageRejectedException
Creates forum thread using existing message. Used to

Parameters:
forumID - the forum unique identifier
messageID - the message unique identifier
Returns:
the thread
Throws:
com.sap.netweaver.coll.forums.exceptions.ForumNotFoundException
com.sap.netweaver.coll.forums.exceptions.ForumMessageNotFoundException
com.sap.netweaver.coll.forums.exceptions.MessageRejectedException


Copyright 2011 SAP AG Complete Copyright Notice