blackboard.persist.gradebook
Interface LineitemDbLoader

All Superinterfaces:

Loader

public interface LineitemDbLoader
extends Loader

The LineitemDbLoader interface provides a standard set of methods used to load Lineitem objects and lists of Lineitems from the Blackboard database.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/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	loadByCourseId(Id courseId) Loads a list of Lineitem objects associated with the Course whose Id is provided, using a connection obtained through this object's database context.
BbList	loadByCourseId(Id courseId, java.sql.Connection con) Loads a list of Lineitem objects associated with the Course whose Id is provided, using the supplied connection.
BbList	loadByCourseIdAndLineitemName(Id courseId, java.lang.String name) Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using a connection obtained through this object's database context.
BbList	loadByCourseIdAndLineitemName(Id courseId, java.lang.String name, java.sql.Connection con) Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using the supplied connection.
Lineitem	loadById(Id id) Loads the Lineitem with the given Id from the database using a connection obtained through this object's database context.
Lineitem	loadById(Id id, java.sql.Connection con) Loads the Lineitem 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

Lineitem loadById(Id id)
                  throws KeyNotFoundException,
                         PersistenceException

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

Parameters:

id - The Id of the desired Lineitem

Returns:

The Lineitem referenced by the Id

Throws:

KeyNotFoundException - If there is no Lineitem in the database with the given Id

PersistenceException - If a general persistence level exception occurs

loadById

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

Loads the Lineitem with the given Id from the database using the supplied connection.

Parameters:

id - The Id of the desired Lineitem

con - A connection supplied by the caller's database context

Returns:

The Lineitem referenced by the Id

Throws:

KeyNotFoundException - If there is no Lineitem in the database with the given Id

PersistenceException - If a general persistence level exception occurs

loadByCourseId

BbList loadByCourseId(Id courseId)
                      throws KeyNotFoundException,
                             PersistenceException

Loads a list of Lineitem objects associated with the Course whose Id is provided, using a connection obtained through this object's database context.

Parameters:

id - The Id of the Course to load Lineitems from

Returns:

The LwLineitemList containing all Lineitem objects associated with the Course

Throws:

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

PersistenceException - If a general persistence level exception occurs

loadByCourseId

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

Loads a list of Lineitem objects associated with the Course whose Id is provided, using the supplied connection.

Parameters:

id - The Id of the Course to load Lineitems from

con - A connection supplied by the caller's database context

Returns:

The LwLineitemList containing all Lineitem objects associated with the Course

Throws:

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

PersistenceException - If a general persistence level exception occurs

loadByCourseIdAndLineitemName

BbList loadByCourseIdAndLineitemName(Id courseId,
                                     java.lang.String name)
                                     throws KeyNotFoundException,
                                            PersistenceException

Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using a connection obtained through this object's database context. The method returns a list because Lineitem names are not guaranteed to be unique.

Parameters:

id - The Id of the Course to load Lineitems from

name - The name of the Lineitem to be loaded

Returns:

The LwLineitemList containing all Lineitem objects associated with the Course and having a name which matches the provided name

Throws:

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

PersistenceException - If a general persistence level exception occurs

loadByCourseIdAndLineitemName

BbList loadByCourseIdAndLineitemName(Id courseId,
                                     java.lang.String name,
                                     java.sql.Connection con)
                                     throws KeyNotFoundException,
                                            PersistenceException

Loads a list of Lineitem objects associated with the Course whose Id is provided and whose name matches the name provided, using the supplied connection. The method returns a list because Lineitem names are not guaranteed to be unique.

Parameters:

id - The Id of the Course to load Lineitems from

name - The name of the Lineitem to be loaded

con - A connection supplied by the caller's database context

Returns:

The LwLineitemList containing all Lineitem objects associated with the Course and having a name which matches the provided name

Throws:

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

PersistenceException - If a general persistence level exception occurs