blackboard.persist.navigation
Interface CourseTocDbLoader

All Superinterfaces:

Loader

public interface CourseTocDbLoader
extends Loader

This interface describes the set of methods that all database loaders for CourseToc 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

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

CourseToc	loadByContentId(Id id) Load the CourseToc with the given content Id from the database using a connection obtained through this object's database context.
CourseToc	loadByContentId(Id id, java.sql.Connection con) Load the CourseToc with the given content Id from the database using the supplied connection.
BbList	loadByCourseId(Id courseId) Load the list of CourseToc objects that currently exist for the course identified by the given course Id using a connection obtained through this object's database context.
BbList	loadByCourseId(Id courseId, java.sql.Connection con) Load the list of CourseToc objects that currently exist for the course identified by the given course Id using the supplied connection.
CourseToc	loadByCourseIdAndLabel(Id courseId, java.lang.String strLabel) Load the CourseToc from the given course (identified by id) with the given label using a connection obtained through this object's database context.
CourseToc	loadByCourseIdAndLabel(Id courseId, java.lang.String strLabel, java.sql.Connection con) Load the CourseToc from the given course (identified by id) with the given label using the supplied connection.
CourseToc	loadById(Id id) Load the CourseToc with the given Id from the database using a connection obtained through this object's database context.
CourseToc	loadById(Id id, java.sql.Connection con) Load the CourseToc with the given Id from the database using the supplied connection.
CourseToc	loadEntryPointByCourseId(Id courseId) Load the CourseToc that represents the entry point for the given course (identified by id) using a connection obtained through this object's database context.
CourseToc	loadEntryPointByCourseId(Id courseId, java.sql.Connection con) Load the CourseToc that represents the entry point for the given course (identified by id) 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

CourseToc loadById(Id id)
                   throws KeyNotFoundException,
                          PersistenceException

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

Throws:

KeyNotFoundException - if there is no CourseToc in the database with the given Id

PersistenceException - if some other error occurs while loading the object

loadById

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

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

Throws:

KeyNotFoundException - if there is no CourseToc in the database with the given Id

PersistenceException - if some other error occurs while loading the object

loadByContentId

CourseToc loadByContentId(Id id)
                          throws KeyNotFoundException,
                                 PersistenceException

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

Throws:

KeyNotFoundException - if there is no CourseToc in the database with the given Id

PersistenceException - if some other error occurs while loading the object

loadByContentId

CourseToc loadByContentId(Id id,
                          java.sql.Connection con)
                          throws KeyNotFoundException,
                                 PersistenceException

Load the CourseToc with the given content Id from the database using the supplied connection.

Throws:

KeyNotFoundException - if there is no CourseToc 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 CourseToc objects that currently exist for the course identified by the given course 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 object

loadByCourseId

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

Load the list of CourseToc objects that currently exist for the course identified by the given course Id using the supplied connection.

Throws:

KeyNotFoundException - if the provided course id is invalid

PersistenceException - if some other error occurs while loading the object

loadByCourseIdAndLabel

CourseToc loadByCourseIdAndLabel(Id courseId,
                                 java.lang.String strLabel)
                                 throws KeyNotFoundException,
                                        PersistenceException

Load the CourseToc from the given course (identified by id) with the given label 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 object

loadByCourseIdAndLabel

CourseToc loadByCourseIdAndLabel(Id courseId,
                                 java.lang.String strLabel,
                                 java.sql.Connection con)
                                 throws KeyNotFoundException,
                                        PersistenceException

Load the CourseToc from the given course (identified by id) with the given label using the supplied connection.

Throws:

KeyNotFoundException - if the provided course id is invalid

PersistenceException - if some other error occurs while loading the object

loadEntryPointByCourseId

CourseToc loadEntryPointByCourseId(Id courseId)
                                   throws KeyNotFoundException,
                                          PersistenceException

Load the CourseToc that represents the entry point for 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 object

loadEntryPointByCourseId

CourseToc loadEntryPointByCourseId(Id courseId,
                                   java.sql.Connection con)
                                   throws KeyNotFoundException,
                                          PersistenceException

Load the CourseToc that represents the entry point for 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 object