blackboard.persist.course
Interface CartridgeDbLoader

All Superinterfaces:

Loader

public interface CartridgeDbLoader
extends Loader

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

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

Cartridge	loadById(Id id) Load the Cartridge with the given Id from the database using a connection obtained through this object's database context.
Cartridge	loadById(Id id, java.sql.Connection con) Load the Cartridge with the given Id from the database using the supplied connection.
Cartridge	loadByIdentifierAndPublisherName(java.lang.String strIdentifier, java.lang.String strPublisherName) Load the Cartridge with the given identifier (string-based id) and publisher name from the database using a connection obtained through this object's database context.
Cartridge	loadByIdentifierAndPublisherName(java.lang.String strIdentifier, java.lang.String strPublisherName, java.sql.Connection con) Load the Cartridge with the given identifier (string-based id) and publisher name 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

Cartridge loadById(Id id)
                   throws KeyNotFoundException,
                          PersistenceException

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

Parameters:

id - the Id of the Cartridge that should be loaded

Throws:

KeyNotFoundException - if there is no Cartridge in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadById

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

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

Parameters:

id - the Id of the Cartridge that should be loaded

con - the Connection to use to perform the load. Can be null.

Throws:

KeyNotFoundException - if there is no Cartridge in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadByIdentifierAndPublisherName

Cartridge loadByIdentifierAndPublisherName(java.lang.String strIdentifier,
                                           java.lang.String strPublisherName)
                                           throws KeyNotFoundException,
                                                  PersistenceException

Load the Cartridge with the given identifier (string-based id) and publisher name from the database using a connection obtained through this object's database context. The identifier of a cartridge from an individual publisher is unique, therefore, the combination of identifier and publisher name form a globally unique key.

Parameters:

strIdentifier - the string-based id of the Cartridge that should be loaded

strPublisherName - the name of the publisher whose created the cartridge

Throws:

KeyNotFoundException - if there is no Cartridge in the database with the given identifier and publisher name

PersistenceException - if some other error occurs while loading the object

loadByIdentifierAndPublisherName

Cartridge loadByIdentifierAndPublisherName(java.lang.String strIdentifier,
                                           java.lang.String strPublisherName,
                                           java.sql.Connection con)
                                           throws KeyNotFoundException,
                                                  PersistenceException

Load the Cartridge with the given identifier (string-based id) and publisher name from the database using the supplied connection. The identifier of a cartridge from an individual publisher is unique, therefore, the combination of identifier and publisher name form a globally unique key.

Parameters:

strIdentifier - the string-based id of the Cartridge that should be loaded

strPublisherName - the name of the publisher whose created the cartridge

Throws:

KeyNotFoundException - if there is no Cartridge in the database with the given identifier and publisher name

PersistenceException - if some other error occurs while loading the object