blackboard.persist.discussionboard
Interface ForumDbLoader

All Superinterfaces:

Loader

public interface ForumDbLoader
extends Loader

ForumDbLoader

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/06/27 $

Nested Class Summary

static class

ForumDbLoader.Default A utility class that provides quick access to the ForumDbLoader instance associated with the default instance of the database BbPersistenceManager.

Field Summary

static java.lang.String

TYPE Type used to obt ain an instance of the class configured to provide the implementation for this interface.

Method Summary

Forum	copySingleForum(Id conferenceId, java.lang.Boolean ifCopyAll)
void	dashboardManagerForumNumber(Id course_id) Calculate number of forums per user in a course on the given Id from the database using a connection obtained through this object's database contex.
void	dashboardManagerForumNumber(Id course_id, java.sql.Connection con) Calculate number of forums per user in a course on the given Id from the database using the specified connection.
Id	forumSingleCopy(Id s_forum_id, Id t_conference_id, boolean ifCopyAll, java.lang.String session_id, java.lang.String forum_name) Copys a selected forum to a conference.
BbList	loadByConferenceId(Id confId) Load a BbList containing the Forums in the Conference with the given Id from the database using a connection obtained through this object's database context.
BbList	loadByConferenceId(Id confId, java.sql.Connection con) Load a Forum with the given Id, and load top level messages contained in the forum from the database using the supplied connection.
Forum	loadById(Id id) Load the Forum with the given Id from the database using a connection obtained through this object's database context.
Forum	loadById(Id id, java.sql.Connection con) Load the Forum with the given Id from the database using the supplied connection.
BbList	loadEnabledByCourseIdAndUserId(Id courseId, Id userId) Load a list of Forums within the given course and enabled for the given user Ids, from the database using the supplied connection obtained through this object's database context.
BbList	loadEnabledByCourseIdAndUserId(Id courseId, Id userId, java.sql.Connection con) Load a list of Forums within the given course and enabled for the given user Ids, from the database using the supplied connection.
java.util.List<Forum>	loadForumsByConferenceIdWithStatus(Id conferenceId, Id userId) Loads a list of forums on the given conferenec id and user id from the database using a connection obtained through this object's database context.
java.util.List<Forum>	loadForumsByConferenceIdWithStatus(Id conferenceId, Id userId, java.sql.Connection con) Loads a list of forums on the given conferenec id and user id from the database using the specified connection.
java.util.List	loadForumsWithStatus(Id conferenceId, Id userId) Deprecated. use loadForumsByConferenceId instead
java.util.List	loadForumsWithStatus(Id conferenceId, Id userId, java.sql.Connection con) Deprecated. use loadForumsByConferenceId instead
java.util.List	MsgCountByForumIdOrThreadId(Id forum_id, Id thread_id) Calculate number of message per forum or thread in a course on the given Id from the database using a connection obtained through this object's database context.
java.util.List	MsgCountByForumIdOrThreadId(Id forum_id, Id thread_id, java.sql.Connection con) Calculate number of message per forum or thread in a course on the given Id using the specified connection.

Methods inherited from interface blackboard.persist.Loader

getAppVersion, init

Field Detail

TYPE

static final java.lang.String TYPE

Type used to obt ain an instance of the class configured to provide the implementation for this interface. Used when making a call to BbPersistenceManager.getLoader(String)

See Also:

Constant Field Values

Method Detail

loadById

Forum loadById(Id id)
               throws KeyNotFoundException,
                      PersistenceException

Load the Forum with the given Id from the database using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - if there is no Forum in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadById

Forum loadById(Id id,
               java.sql.Connection con)
               throws KeyNotFoundException,
                      PersistenceException

Load the Forum with the given Id from the database using the supplied connection.

Throws:

KeyNotFoundException - if there is no Forum in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadByConferenceId

BbList loadByConferenceId(Id confId)
                          throws KeyNotFoundException,
                                 PersistenceException

Load a BbList containing the Forums in the Conference with the given Id from the database using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - if the provided conference id is invalid

PersistenceException - if some other error occurs while loading the object

loadByConferenceId

BbList loadByConferenceId(Id confId,
                          java.sql.Connection con)
                          throws KeyNotFoundException,
                                 PersistenceException

Load a Forum with the given Id, and load top level messages contained in the forum from the database using the supplied connection.

Throws:

KeyNotFoundException - if the provided conference id is invalid

PersistenceException - if some other error occurs while loading the object

loadEnabledByCourseIdAndUserId

BbList loadEnabledByCourseIdAndUserId(Id courseId,
                                      Id userId)
                                      throws KeyNotFoundException,
                                             PersistenceException

Load a list of Forums within the given course and enabled for the given user Ids, from the database using the supplied connection obtained through this object's database context.

Throws:

KeyNotFoundException - if the provided conference id is invalid

PersistenceException - if some other error occurs while loading the object

loadEnabledByCourseIdAndUserId

BbList loadEnabledByCourseIdAndUserId(Id courseId,
                                      Id userId,
                                      java.sql.Connection con)
                                      throws KeyNotFoundException,
                                             PersistenceException

Load a list of Forums within the given course and enabled for the given user Ids, from the database using the supplied connection.

Throws:

KeyNotFoundException - if the provided conference id is invalid

PersistenceException - if some other error occurs while loading the object

copySingleForum

Forum copySingleForum(Id conferenceId,
                      java.lang.Boolean ifCopyAll)
                      throws KeyNotFoundException,
                             PersistenceException

Throws:

KeyNotFoundException

PersistenceException

loadForumsWithStatus

java.util.List loadForumsWithStatus(Id conferenceId,
                                    Id userId,
                                    java.sql.Connection con)
                                    throws KeyNotFoundException,
                                           PersistenceException

Deprecated. use loadForumsByConferenceId instead

Loads a list of forums on the given conferenec id and user id from the database using the specified connection.

Throws:

KeyNotFoundException - if the provided conference id or user id is invalid

PersistenceException - if some other error occurs while loading the object

loadForumsWithStatus

java.util.List loadForumsWithStatus(Id conferenceId,
                                    Id userId)
                                    throws KeyNotFoundException,
                                           PersistenceException

Deprecated. use loadForumsByConferenceId instead

Loads a list of forums on the given conferenec id and user id from the database using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - if the provided conference id or user id is invalid

PersistenceException - if some other error occurs while loading the object

forumSingleCopy

Id forumSingleCopy(Id s_forum_id,
                   Id t_conference_id,
                   boolean ifCopyAll,
                   java.lang.String session_id,
                   java.lang.String forum_name)
                   throws PersistenceException

Copys a selected forum to a conference.

Throws:

PersistenceException - if some other error occurs while copying the object

dashboardManagerForumNumber

void dashboardManagerForumNumber(Id course_id)
                                 throws PersistenceException

Calculate number of forums per user in a course on the given Id from the database using a connection obtained through this object's database contex.

Throws:

PersistenceException - if some other error occurs while loading the object

dashboardManagerForumNumber

void dashboardManagerForumNumber(Id course_id,
                                 java.sql.Connection con)
                                 throws PersistenceException

Calculate number of forums per user in a course on the given Id from the database using the specified connection.

Throws:

PersistenceException - if some other error occurs while loading the object

MsgCountByForumIdOrThreadId

java.util.List MsgCountByForumIdOrThreadId(Id forum_id,
                                           Id thread_id)
                                           throws KeyNotFoundException,
                                                  PersistenceException

Calculate number of message per forum or thread in a course on the given Id from the database using a connection obtained through this object's database context.

Throws:

PersistenceException - if some other error occurs while loading the object

KeyNotFoundException

MsgCountByForumIdOrThreadId

java.util.List MsgCountByForumIdOrThreadId(Id forum_id,
                                           Id thread_id,
                                           java.sql.Connection con)
                                           throws KeyNotFoundException,
                                                  PersistenceException

Calculate number of message per forum or thread in a course on the given Id using the specified connection.

Throws:

PersistenceException - if some other error occurs while loading the object

KeyNotFoundException

loadForumsByConferenceIdWithStatus

java.util.List<Forum> loadForumsByConferenceIdWithStatus(Id conferenceId,
                                                         Id userId)
                                                         throws KeyNotFoundException,
                                                                PersistenceException

Loads a list of forums on the given conferenec id and user id from the database using a connection obtained through this object's database context. Returned forum objects will have their ForumStatus object attribute set

Throws:

KeyNotFoundException - if the provided conference id or user id is invalid

PersistenceException - if some other error occurs while loading the object

loadForumsByConferenceIdWithStatus

java.util.List<Forum> loadForumsByConferenceIdWithStatus(Id conferenceId,
                                                         Id userId,
                                                         java.sql.Connection con)
                                                         throws KeyNotFoundException,
                                                                PersistenceException

Loads a list of forums on the given conferenec id and user id from the database using the specified connection. Returned forum objects will have their ForumStatus object attribute set

Throws:

KeyNotFoundException - if the provided conference id or user id is invalid

PersistenceException - if some other error occurs while loading the object