blackboard.persist.discussionboard
Interface ForumDbLoader

All Superinterfaces:

Loader

public interface ForumDbLoader
extends Loader

ForumDbLoader

Since:

Bb 5.5

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 obtain an instance of the class configured to provide the implementation for this interface.

Method Summary

Forum	copySingleForum(Id conferenceId, java.lang.Boolean ifCopyAll) Deprecated. Since 9.0
Id	forumSingleCopy(Id s_forum_id, Id t_conference_id, boolean ifCopyAll, boolean copyAlignments, java.lang.String session_id, java.lang.String forum_name) Copies a selected forum to a conference.
Id	forumSingleCopy(Id s_forum_id, Id t_conference_id, boolean ifCopyAll, java.lang.String session_id, java.lang.String forum_name) Deprecated. Since 9.1. Use forumSingleCopy(Id, Id, boolean, boolean, String, String)
blackboard.persist.DataList<Forum>	loadAllByCourseId(Id courseId, boolean includeGroups, java.sql.Connection con) Loads the Forums for the given course (identified by id) from the database using the supplied connection.
BbList<Forum>	loadByConferenceId(Id confId) Load a blackboard.base.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<Forum>	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	loadByForumIdAndGradedForumDeletedStatus(Id forumId, boolean deleted) Load the forum by id and the deleted status of the associated GradableItem.
Forum	loadByForumIdAndGradedThreadDeletedStatus(Id forumId, boolean deleted) Loads the forum which has threads with the specified deleted status for the associated GradableItem.
java.util.List<Forum>	loadByForumIdsAndGradedForumDeletedStatus(Id courseId, Id[] forumIds, boolean deleted) Loads a list of forums which has the specified deleted status for the associated GradableItem.
java.util.List<Forum>	loadByForumIdsAndGradedThreadDeletedStatus(Id[] forumIds, boolean deleted) Loads the list of forums which has threads with the specified deleted status for the associated GradableItem.
java.util.List<Forum>	loadByGroupIdAndGradedForumStatus(Id courseId, Id groupId, boolean deleted) Load the list of forums which belongs to a group and have associated GradableItem with specified deleted flag.
java.util.List<Forum>	loadByGroupIdAndGradedThreadStatus(Id courseId, Id groupId, boolean deleted) Load the list of forums which belongs to a group and has threads that have associated GradableItem with specified deleted flag.
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<Forum>	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<Forum>	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 conference id and user id from the database using the specified connection.
java.util.List<Forum>	loadForumsWithGradableThreadsByGroupId(Id courseId, Id groupId) Load the list of forums which belongs to a group and has threads that have associated GradableItem
java.util.List<Forum>	loadForumsWithStatus(Id conferenceId, Id userId) Deprecated. Since 7.3. Use loadForumsByConferenceId instead
java.util.List<Forum>	loadForumsWithStatus(Id conferenceId, Id userId, java.sql.Connection con) Deprecated. Since 7.3. Use loadForumsByConferenceId instead
java.util.List<Forum>	loadGradableForumsByGroupId(Id courseId, Id groupId) Load the list of forums which belongs to a group and have associated GradableItem
Id	loadIdByForumOrThreadLinkRefId(Id courseId, java.lang.String linkrefid) Load the Forum Id for which the linkrefid belongs, either directly or to one of its threads if the forum is actually set to be graded by thread
Id	loadIdByForumOrThreadLinkRefId(Id courseId, java.lang.String linkrefid, java.sql.Connection con) Load the Forum Id for which the linkrefid belongs, either directly or to one of its threads if the forum is actually set to be graded by thread
java.util.List<Conference>	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<Conference>	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 obtain 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<Forum> loadByConferenceId(Id confId)
                                 throws KeyNotFoundException,
                                        PersistenceException

Load a blackboard.base.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 - not thrown

PersistenceException - if some other error occurs while loading the object

loadByConferenceId

BbList<Forum> 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 - not thrown

PersistenceException - if some other error occurs while loading the object

loadEnabledByCourseIdAndUserId

BbList<Forum> 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 - not thrown

PersistenceException - if some other error occurs while loading the object

loadEnabledByCourseIdAndUserId

BbList<Forum> 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 - not thrown

PersistenceException - if some other error occurs while loading the object

copySingleForum

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

Deprecated. Since 9.0

Parameters:

conferenceId - not used

ifCopyAll - not used

Throws:

KeyNotFoundException - not thrown

PersistenceException - not thrown

loadForumsWithStatus

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

Deprecated. Since 7.3. 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 - not thrown

PersistenceException - if some other error occurs while loading the object

loadForumsWithStatus

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

Deprecated. Since 7.3. 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 - not thrown

PersistenceException - if some other error occurs while loading the object

loadIdByForumOrThreadLinkRefId

Id loadIdByForumOrThreadLinkRefId(Id courseId,
                                  java.lang.String linkrefid,
                                  java.sql.Connection con)
                                  throws PersistenceException

Load the Forum Id for which the linkrefid belongs, either directly or to one of its threads if the forum is actually set to be graded by thread

Returns:

null if no Id found

Throws:

PersistenceException

loadIdByForumOrThreadLinkRefId

Id loadIdByForumOrThreadLinkRefId(Id courseId,
                                  java.lang.String linkrefid)
                                  throws PersistenceException

Load the Forum Id for which the linkrefid belongs, either directly or to one of its threads if the forum is actually set to be graded by thread

Returns:

null if no Id found

Throws:

PersistenceException

forumSingleCopy

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

Deprecated. Since 9.1. Use forumSingleCopy(Id, Id, boolean, boolean, String, String)

Copies a selected forum to a conference.

Throws:

PersistenceException - if some other error occurs while copying the object

forumSingleCopy

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

Copies a selected forum to a conference.

Throws:

PersistenceException - if some other error occurs while copying the object

MsgCountByForumIdOrThreadId

java.util.List<Conference> 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:

KeyNotFoundException - not thrown

PersistenceException - if some other error occurs while loading the object

MsgCountByForumIdOrThreadId

java.util.List<Conference> 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:

KeyNotFoundException - not thrown

PersistenceException - if some other error occurs while loading the object

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 - not thrown

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 conference id and user id from the database using the specified connection. Returned forum objects will have their ForumStatus object attribute set

Throws:

KeyNotFoundException - not thrown

PersistenceException - if some other error occurs while loading the object

loadByGroupIdAndGradedForumStatus

java.util.List<Forum> loadByGroupIdAndGradedForumStatus(Id courseId,
                                                        Id groupId,
                                                        boolean deleted)
                                                        throws PersistenceException

Load the list of forums which belongs to a group and have associated GradableItem with specified deleted flag.

Parameters:

courseId - id of the course to which the forum belongs.

groupId - groupId id of the group to which the forum belongs.

deleted - the deleted flag of the GradableItem associated to the forums.

Throws:

PersistenceException

loadGradableForumsByGroupId

java.util.List<Forum> loadGradableForumsByGroupId(Id courseId,
                                                  Id groupId)
                                                  throws PersistenceException

Load the list of forums which belongs to a group and have associated GradableItem

Parameters:

courseId - id of the course to which the forums belongs.

groupId - groupId id of the group to which the forum belongs.

Throws:

PersistenceException

loadByGroupIdAndGradedThreadStatus

java.util.List<Forum> loadByGroupIdAndGradedThreadStatus(Id courseId,
                                                         Id groupId,
                                                         boolean deleted)
                                                         throws PersistenceException

Load the list of forums which belongs to a group and has threads that have associated GradableItem with specified deleted flag.

Parameters:

courseId - id of the course to which the thread belongs.

groupId - id of the group to which the forum belongs.

deleted - the deleted flag of the GradableItem associated to the threads under the forum.

Throws:

PersistenceException

loadForumsWithGradableThreadsByGroupId

java.util.List<Forum> loadForumsWithGradableThreadsByGroupId(Id courseId,
                                                             Id groupId)
                                                             throws PersistenceException

Load the list of forums which belongs to a group and has threads that have associated GradableItem

Parameters:

courseId - id of the course to which the threads belongs.

groupId - id of the group to which the forum belongs.

Throws:

PersistenceException

loadByForumIdAndGradedForumDeletedStatus

Forum loadByForumIdAndGradedForumDeletedStatus(Id forumId,
                                               boolean deleted)
                                               throws PersistenceException

Load the forum by id and the deleted status of the associated GradableItem.

Parameters:

forumId - id of the forum

deleted - the deleted flag of the GradableItem associated to the forum.

Throws:

PersistenceException

loadByForumIdsAndGradedForumDeletedStatus

java.util.List<Forum> loadByForumIdsAndGradedForumDeletedStatus(Id courseId,
                                                                Id[] forumIds,
                                                                boolean deleted)
                                                                throws PersistenceException

Loads a list of forums which has the specified deleted status for the associated GradableItem.

Throws:

PersistenceException

loadByForumIdAndGradedThreadDeletedStatus

Forum loadByForumIdAndGradedThreadDeletedStatus(Id forumId,
                                                boolean deleted)
                                                throws PersistenceException

Loads the forum which has threads with the specified deleted status for the associated GradableItem.

Throws:

PersistenceException

loadByForumIdsAndGradedThreadDeletedStatus

java.util.List<Forum> loadByForumIdsAndGradedThreadDeletedStatus(Id[] forumIds,
                                                                 boolean deleted)
                                                                 throws PersistenceException

Loads the list of forums which has threads with the specified deleted status for the associated GradableItem.

Throws:

PersistenceException

loadAllByCourseId

blackboard.persist.DataList<Forum> loadAllByCourseId(Id courseId,
                                                     boolean includeGroups,
                                                     java.sql.Connection con)
                                                     throws PersistenceException

Loads the Forums for the given course (identified by id) from the database using the supplied connection.

Throws:

PersistenceException