blackboard.persist.gradebook
Interface ScoreDbLoader

All Superinterfaces:
Loader

public interface ScoreDbLoader
extends Loader

The ScoreDbLoader interface provides a standard set of methods used to load Scores and ScoreLists from the Blackboard 5 database schema.

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

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 loadByCourseMembershipId(Id id)
          Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using a connection obtained through this object's database context.
 BbList loadByCourseMembershipId(Id id, java.sql.Connection con)
          Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using the provided connection.
 Score loadByCourseMembershipIdAndLineitemId(Id cmId, Id liId)
          Loads the Score for a given Lineitem and CourseMembership combination using a connection obtained through this object's database context.
 Score loadByCourseMembershipIdAndLineitemId(Id cmId, Id liId, java.sql.Connection con)
          Loads the Score for a given Lineitem and CourseMembership combination using the provided connection.
 Score loadById(Id id)
          Loads the Score with the given Id from the database using a connection obtained through this object's database context.
 Score loadById(Id id, java.sql.Connection con)
          Loads the Score with the given Id from the database using the provided connection.
 BbList loadByLineitemId(Id id)
          Loads a list of Score objects associated with the lineitem whose Id is provided, using a connection obtained through this object's database context.
 BbList loadByLineitemId(Id id, java.sql.Connection con)
          Loads a list of Score objects associated with the Lineitem whose Id is provided, using the provided 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

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

Parameters:
id - The Id of the desired Score
Returns:
The Score referenced by the Id provided
Throws:
KeyNotFoundException - If there is no Score in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadById

Score loadById(Id id,
               java.sql.Connection con)
               throws KeyNotFoundException,
                      PersistenceException
Loads the Score with the given Id from the database using the provided connection.

Parameters:
id - The Id of the desired Score
con - A connection supplied by the caller's database context
Returns:
The Score referenced by the Id provided
Throws:
KeyNotFoundException - If there is no Score in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadByCourseMembershipId

BbList loadByCourseMembershipId(Id id)
                                throws KeyNotFoundException,
                                       PersistenceException
Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using a connection obtained through this object's database context.

Parameters:
id - The Id of the CourseMembership record
Returns:
The ScoreList containing all Score objects associated with the CourseMembership record
Throws:
KeyNotFoundException - If there is no CourseMembership record in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadByCourseMembershipId

BbList loadByCourseMembershipId(Id id,
                                java.sql.Connection con)
                                throws KeyNotFoundException,
                                       PersistenceException
Loads a list of Score objects associated with the CourseMembership record whose Id is provided, using the provided connection.

Parameters:
id - The Id of the CourseMembership record
con - A connection supplied by the caller's database context
Returns:
The ScoreList containing all Score objects associated with the CourseMembership record
Throws:
KeyNotFoundException - If there is no CourseMembership record in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadByLineitemId

BbList loadByLineitemId(Id id)
                        throws KeyNotFoundException,
                               PersistenceException
Loads a list of Score objects associated with the lineitem whose Id is provided, using a connection obtained through this object's database context.

Parameters:
id - The Id of the Lineitem
Returns:
The ScoreList containing all Score objects associated with the Lineitem
Throws:
KeyNotFoundException - If there is no Lineitem in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadByLineitemId

BbList loadByLineitemId(Id id,
                        java.sql.Connection con)
                        throws KeyNotFoundException,
                               PersistenceException
Loads a list of Score objects associated with the Lineitem whose Id is provided, using the provided connection.

Parameters:
id - The Id of the Lineitem
Returns:
The ScoreList containing all Score objects associated with the Lineitem
Throws:
KeyNotFoundException - If there is no Lineitem in the database with the given Id
PersistenceException - If a general persistence level exception occurs

loadByCourseMembershipIdAndLineitemId

Score loadByCourseMembershipIdAndLineitemId(Id cmId,
                                            Id liId)
                                            throws KeyNotFoundException,
                                                   PersistenceException
Loads the Score for a given Lineitem and CourseMembership combination using a connection obtained through this object's database context.

Parameters:
cmId - The Id of the CourseMembership record
liId - The Id of the Lineitem that this score represents a record for
Returns:
The Score referenced by the Ids provided
Throws:
KeyNotFoundException - If neither of the Ids provided exist in the database
PersistenceException - If a general persistence level exception occurs

loadByCourseMembershipIdAndLineitemId

Score loadByCourseMembershipIdAndLineitemId(Id cmId,
                                            Id liId,
                                            java.sql.Connection con)
                                            throws KeyNotFoundException,
                                                   PersistenceException
Loads the Score for a given Lineitem and CourseMembership combination using the provided connection.

Parameters:
cmId - The Id of the CourseMembership record
liId - The Id of the Lineitem that this score represents a record for
con - A connection supplied by the caller's database context
Returns:
The Score referenced by the Ids provided
Throws:
KeyNotFoundException - If neither of the Ids provided exist in the database
PersistenceException - If a general persistence level exception occurs


Copyright © 2003 Blackboard, Inc. All Rights Reserved.