blackboard.persist.gradebook
Interface GradeRecordDbLoader

All Superinterfaces:

Loader

public interface GradeRecordDbLoader
extends Loader

The GradeReportDbLoader interface provides a standard set of methods used to load GradeRecord and GradeRecordList 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	loadByCourse(ReportingPeriod period, Course crs) Loads the GradeRecordList with the given ReportingPeriod and Course from the database using a connection obtained through this object's database context.
BbList	loadByCourse(ReportingPeriod period, Course crs, java.sql.Connection con) Loads the GradeRecordList with the given ReportingPeriod and Course using the supplied connection.
void	loadByCourse(ReportingPeriod period, Course crs, java.io.OutputStream output) Produces a report for all the courses associated with the given course and reporting period into output.
BbList	loadByCourseList(ReportingPeriod period, BbList cList) Loads the GradeRecordList with the given ReportingPeriod and CourseList from the database using a connection obtained through this object's database context.
BbList	loadByCourseList(ReportingPeriod period, BbList cList, java.sql.Connection con) Loads the GradeRecordList with the given ReportingPeriod and CourseList using the supplied connection.
void	loadByCourseList(ReportingPeriod period, BbList cList, java.io.OutputStream output) Produces a report for all the courses associated with the given course list and reporting period into output.
BbList	loadBySourceKey(ReportingPeriod period, java.lang.String dsKey) Loads the GradeRecordList with the given ReportingPeriod and data source key from the database using a connection obtained through this object's database context.
BbList	loadBySourceKey(ReportingPeriod period, java.lang.String dsKey, java.sql.Connection con) Loads the GradeRecordList with the given ReportingPeriod and data source key using the supplied connection.
void	loadBySourceKey(ReportingPeriod period, java.lang.String dsKey, java.io.OutputStream output) Produces a report for all the courses associated with the given data source key and repoting period into output.

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

loadByCourse

BbList loadByCourse(ReportingPeriod period,
                    Course crs)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and Course from the database using a connection obtained through this object's database context.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

crs - The Course of the desired GradeRecord

Returns:

the list of grades for all students in the given course for the given report period.

Throws:

KeyNotFoundException - If there is no course in the database with the given Course

PersistenceException - If a general persistence level exception occurs

loadByCourse

BbList loadByCourse(ReportingPeriod period,
                    Course crs,
                    java.sql.Connection con)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and Course using the supplied connection.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

crs - The Course of the desired GradeRecord

Returns:

the list of grades for all students in the given course for the given report period.

Throws:

KeyNotFoundException - If there is no course in the database with the given Course

PersistenceException - If a general persistence level exception occurs

loadByCourseList

BbList loadByCourseList(ReportingPeriod period,
                        BbList cList)
                        throws PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and CourseList from the database using a connection obtained through this object's database context.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

crs - The Course of the desired GradeRecord

Throws:

KeyNotFoundException - If there are no courses in the database with the given CourseList

PersistenceException - If a general persistence level exception occurs Returns the list of grades for all students in the given list of courses for the given report period.

loadByCourseList

BbList loadByCourseList(ReportingPeriod period,
                        BbList cList,
                        java.sql.Connection con)
                        throws PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and CourseList using the supplied connection.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

crs - The Course of the desired GradeRecord

Throws:

KeyNotFoundException - If there are no courses in the database with the given CourseList

PersistenceException - If a general persistence level exception occurs Returns the list of grades for all students in the given list of courses for the given report period.

loadBySourceKey

BbList loadBySourceKey(ReportingPeriod period,
                       java.lang.String dsKey)
                       throws KeyNotFoundException,
                              PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and data source key from the database using a connection obtained through this object's database context.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

data - source key The String of the desired GradeRecord

Throws:

KeyNotFoundException - If there is no course in the database with the given data source key

PersistenceException - If a general persistence level exception occurs Returns the list of grades for all students of the given data source for the given report period.

loadBySourceKey

BbList loadBySourceKey(ReportingPeriod period,
                       java.lang.String dsKey,
                       java.sql.Connection con)
                       throws KeyNotFoundException,
                              PersistenceException

Loads the GradeRecordList with the given ReportingPeriod and data source key using the supplied connection.

Parameters:

period - The ReportingPeriod of the desired GradeRecord

data - source key The String of the desired GradeRecord

Throws:

KeyNotFoundException - If there is no course in the database with the given data source key

PersistenceException - If a general persistence level exception occurs Returns the list of grades for all students of the given data source for the given report period.

loadByCourse

void loadByCourse(ReportingPeriod period,
                  Course crs,
                  java.io.OutputStream output)
                  throws java.io.IOException,
                         KeyNotFoundException,
                         PersistenceException

Produces a report for all the courses associated with the given course and reporting period into output.

Throws:

java.io.IOException

KeyNotFoundException

PersistenceException

loadByCourseList

void loadByCourseList(ReportingPeriod period,
                      BbList cList,
                      java.io.OutputStream output)
                      throws java.io.IOException,
                             PersistenceException

Produces a report for all the courses associated with the given course list and reporting period into output.

Throws:

java.io.IOException

PersistenceException

loadBySourceKey

void loadBySourceKey(ReportingPeriod period,
                     java.lang.String dsKey,
                     java.io.OutputStream output)
                     throws java.io.IOException,
                            KeyNotFoundException,
                            PersistenceException

Produces a report for all the courses associated with the given data source key and repoting period into output.

Throws:

java.io.IOException

KeyNotFoundException

PersistenceException