blackboard.persist.course
Interface GroupMembershipDbLoader

All Superinterfaces:
Loader

public interface GroupMembershipDbLoader
extends Loader

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

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

Since:
Bb 6.0
Version:
$Revision: #1 $ $Date: 2005/06/27 $

Nested Class Summary
static class GroupMembershipDbLoader.Default
          A utility class that provides quick access to the GroupMembershipDbLoader 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
 BbList loadByCourseId(Id courseId)
          Load the list of GroupMembership objects belonging to all groups defined within 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 GroupMembership objects belonging to all groups defined within the given course (identified by id) using the supplied connection.
 GroupMembership loadByGroupAndUserId(Id groupId, Id userId)
          Load the GroupMembership with the given user and group id from the database using a connection obtained through this object's database context.
 GroupMembership loadByGroupAndUserId(Id groupId, Id userId, java.sql.Connection con)
          Load the GroupMembership with the given user and group id from the database using the supplied connection.
 BbList loadByGroupId(Id groupId)
          Load the list of GroupMembership objects belonging to the given group (identified by id) using a connection obtained through this object's database context.
 BbList loadByGroupId(Id groupId, java.sql.Connection con)
          Load the list of GroupMembership objects belonging to the given group (identified by id) using the supplied connection.
 GroupMembership loadById(Id id)
          Load the GroupMembership with the given Id from the database using a connection obtained through this object's database context.
 GroupMembership loadById(Id id, java.sql.Connection con)
          Load the GroupMembership with the given Id 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

GroupMembership loadById(Id id)
                         throws KeyNotFoundException,
                                PersistenceException
Load the GroupMembership with the given Id from the database using a connection obtained through this object's database context.

Throws:
KeyNotFoundException - if there is no GroupMembership in the database with the given id
PersistenceException - if some other error occurs while loading the object

loadById

GroupMembership loadById(Id id,
                         java.sql.Connection con)
                         throws KeyNotFoundException,
                                PersistenceException
Load the GroupMembership with the given Id from the database using the supplied connection.

Throws:
KeyNotFoundException - if there is no GroupMembership in the database with the given id
PersistenceException - if some other error occurs while loading the object

loadByCourseId

BbList loadByCourseId(Id courseId)
                      throws KeyNotFoundException,
                             PersistenceException
Load the list of GroupMembership objects belonging to all groups defined within the given course (identified by id) using a connection obtained through this object's database context.

Throws:
KeyNotFoundException - if the provided course id is invalid
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 GroupMembership objects belonging to all groups defined within the given course (identified by id) using the supplied connection.

Throws:
KeyNotFoundException - if the provided course id is invalid
PersistenceException - if some other error occurs while loading the User

loadByGroupId

BbList loadByGroupId(Id groupId)
                     throws KeyNotFoundException,
                            PersistenceException
Load the list of GroupMembership objects belonging to the given group (identified by id) using a connection obtained through this object's database context.

Throws:
KeyNotFoundException - if the provided group id is invalid
PersistenceException - if some other error occurs while loading the User

loadByGroupId

BbList loadByGroupId(Id groupId,
                     java.sql.Connection con)
                     throws KeyNotFoundException,
                            PersistenceException
Load the list of GroupMembership objects belonging to the given group (identified by id) using the supplied connection.

Throws:
KeyNotFoundException - if the provided group id is invalid
PersistenceException - if some other error occurs while loading the User

loadByGroupAndUserId

GroupMembership loadByGroupAndUserId(Id groupId,
                                     Id userId)
                                     throws KeyNotFoundException,
                                            PersistenceException
Load the GroupMembership with the given user and group id from the database using a connection obtained through this object's database context.

Throws:
KeyNotFoundException - if there is no GroupMembership in the database with the given group and user id
PersistenceException - if some other error occurs while loading the object

loadByGroupAndUserId

GroupMembership loadByGroupAndUserId(Id groupId,
                                     Id userId,
                                     java.sql.Connection con)
                                     throws KeyNotFoundException,
                                            PersistenceException
Load the GroupMembership with the given user and group id from the database using the supplied connection.

Throws:
KeyNotFoundException - if there is no GroupMembership in the database with the given group and user id
PersistenceException - if some other error occurs while loading the object


Copyright © 2003 Blackboard, Inc. All Rights Reserved.