blackboard.persist.course
Interface CourseMembershipDbLoader

All Superinterfaces:

Loader

public interface CourseMembershipDbLoader
extends Loader

This interface describes the set of methods that all database loaders for CourseMembership objects must implement.

Loading methods are named according to the criteria used for loading and the type of load that is performed.

Since:

Bb 5.5

Version:

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

Nested Class Summary

static class

CourseMembershipDbLoader.Default A utility class that provides quick access to the CourseMembershipDbLoader 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

CourseMembership	loadByCourseAndUserId(Id courseId, Id userId) Load the CourseMembership with the given user and course id from the database using a connection obtained through this object's database context.
CourseMembership	loadByCourseAndUserId(Id courseId, Id userId, java.sql.Connection con) Load the CourseMembership with the given user and course id from the database using the supplied connection.
CourseMembership	loadByCourseAndUserId(Id courseId, Id userId, java.sql.Connection con, boolean withUser) Load the CourseMembership with the given user and course id from the database using the supplied connection.
BbList	loadByCourseId(Id courseId) Load the list of CourseMembership objects belonging to the given course (identified by id) using a connection obtained through this object's database context.
BbList	loadByCourseId(Id courseId, java.sql.Connection con) Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.
BbList	loadByCourseId(Id courseId, java.sql.Connection con, boolean withUser) Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.
BbList	loadByCourseIdAndRole(Id courseId, CourseMembership.Role role) Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using a connection obtained through this object's database context.
BbList	loadByCourseIdAndRole(Id courseId, CourseMembership.Role role, java.sql.Connection con) Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection.
BbList	loadByCourseIdAndRole(Id courseId, CourseMembership.Role role, java.sql.Connection con, boolean withUser) Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection.
BbList	loadByCourseIdWithUserInfo(Id courseId) Load the list of CourseMembership objects belonging to the given course (identified by id) using a connection obtained through this object's database context.
BbList	loadByCourseIdWithUserInfo(Id courseId, java.sql.Connection con) Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.
CourseMembership	loadById(Id id) Load the CourseMembership with the given Id from the database using a connection obtained through this object's database context.
CourseMembership	loadById(Id id, java.sql.Connection con) Load the CourseMembership with the given Id from the database using the supplied connection.
CourseMembership	loadById(Id id, java.sql.Connection con, boolean withUser) Load the CourseMembership with the given Id from the database using the supplied connection.
BbList	loadByUserId(Id userId) Load the list of CourseMembership objects belonging to the given user (identified by id) using a connection obtained through this object's database context.
BbList	loadByUserId(Id userId, java.sql.Connection con) Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection.
BbList	loadByUserId(Id userId, java.sql.Connection con, boolean withUser) Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection.
java.util.Map	loadInstructorsByUser(Id userId) Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using a connection obtained through this object's database context.
java.util.Map	loadInstructorsByUser(Id userId, java.sql.Connection con) Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using the supplied 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

CourseMembership loadById(Id id)
                          throws KeyNotFoundException,
                                 PersistenceException

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

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadById

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

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

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadById

CourseMembership loadById(Id id,
                          java.sql.Connection con,
                          boolean withUser)
                          throws KeyNotFoundException,
                                 PersistenceException

Load the CourseMembership with the given Id from the database using the supplied connection. Attaches the actual User object, without any of the user's heavyweight attributes.

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList loadByUserId(Id userId)
                    throws KeyNotFoundException,
                           PersistenceException

Load the list of CourseMembership objects belonging to the given user (identified by id) using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the User

loadByUserId

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

Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByUserId

BbList loadByUserId(Id userId,
                    java.sql.Connection con,
                    boolean withUser)
                    throws KeyNotFoundException,
                           PersistenceException

Load the list of CourseMembership objects belonging to the given user (identified by id) using the supplied connection. Attaches the actual User object, without any of the user's heavyweight attributes.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseId

BbList loadByCourseId(Id courseId)
                      throws KeyNotFoundException,
                             PersistenceException

Load the list of CourseMembership objects belonging to the given course (identified by id) using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseId

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

Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseId

BbList loadByCourseId(Id courseId,
                      java.sql.Connection con,
                      boolean withUser)
                      throws KeyNotFoundException,
                             PersistenceException

Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection. Attaches the actual User object, without any of the user's heavyweight attributes.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseIdWithUserInfo

BbList loadByCourseIdWithUserInfo(Id courseId)
                                  throws KeyNotFoundException,
                                         PersistenceException

Load the list of CourseMembership objects belonging to the given course (identified by id) using a connection obtained through this object's database context. Only basic user information is included in the results: pk1, user_id, firstname, middlename, lastname, and title. This makes for more lightweight result lists.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseIdWithUserInfo

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

Load the list of CourseMembership objects belonging to the given course (identified by id) using the supplied connection. Only basic user information is included in the results: pk1, user_id, firstname, middlename, lastname, and title. This makes for more lightweight result lists.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

loadByCourseIdAndRole

BbList loadByCourseIdAndRole(Id courseId,
                             CourseMembership.Role role)
                             throws KeyNotFoundException,
                                    PersistenceException

Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

Since:

Bb 6.0.9

loadByCourseIdAndRole

BbList loadByCourseIdAndRole(Id courseId,
                             CourseMembership.Role role,
                             java.sql.Connection con)
                             throws KeyNotFoundException,
                                    PersistenceException

Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

Since:

Bb 6.0.9

loadByCourseIdAndRole

BbList loadByCourseIdAndRole(Id courseId,
                             CourseMembership.Role role,
                             java.sql.Connection con,
                             boolean withUser)
                             throws KeyNotFoundException,
                                    PersistenceException

Load the list of CourseMembership objects which have the given role within the specified course (identified by id) using the supplied connection. Attaches the actual User object, without any of the user's heavyweight attributes.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the User

Since:

Bb 6.0.9

loadByCourseAndUserId

CourseMembership loadByCourseAndUserId(Id courseId,
                                       Id userId)
                                       throws KeyNotFoundException,
                                              PersistenceException

Load the CourseMembership with the given user and course id from the database using a connection obtained through this object's database context.

Throws:

KeyNotFoundException - not thrown. The method returns a list of 0 or more elements and therefore will not throw a KeyNotFoundException.

PersistenceException - if some other error occurs while loading the object

loadByCourseAndUserId

CourseMembership loadByCourseAndUserId(Id courseId,
                                       Id userId,
                                       java.sql.Connection con)
                                       throws KeyNotFoundException,
                                              PersistenceException

Load the CourseMembership with the given user and course id from the database using the supplied connection.

Throws:

KeyNotFoundException - if there is no CourseMembership in the database with the given course and user id

PersistenceException - if some other error occurs while loading the object

loadByCourseAndUserId

CourseMembership loadByCourseAndUserId(Id courseId,
                                       Id userId,
                                       java.sql.Connection con,
                                       boolean withUser)
                                       throws KeyNotFoundException,
                                              PersistenceException

Load the CourseMembership with the given user and course id from the database using the supplied connection. Attaches the actual User object, without any of the user's heavyweight attributes.

Throws:

KeyNotFoundException - if there is no CourseMembership in the database with the given course and user id

PersistenceException - if some other error occurs while loading the object

loadInstructorsByUser

java.util.Map loadInstructorsByUser(Id userId)
                                    throws PersistenceException

Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using a connection obtained through this object's database context.

Throws:

PersistenceException - if some other error occurs while loading the object

loadInstructorsByUser

java.util.Map loadInstructorsByUser(Id userId,
                                    java.sql.Connection con)
                                    throws PersistenceException

Load a Map of courseId to List of full Instructor names as a String for all courses in which the specified user is a member from the database using the supplied connection.

Throws:

PersistenceException - if some other error occurs while loading the object