blackboard.persist.calendar
Interface CalendarEntryDbLoader

All Superinterfaces:

Loader

public interface CalendarEntryDbLoader
extends Loader

This interface describes the set of methods that all database loaders for CalendarEntry objects must implement.

Loading methods are named according to the criteria used for loading and the type of load that is performed.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2005/06/27 $

Nested Class Summary

static class

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

BbList	loadByCourseId(Id courseId) Load the list of CalendarEntry objects for the given course Id using a connection obtained through this object's database context.
BbList	loadByCourseId(Id courseId, java.util.Calendar startDate, java.util.Calendar endDate)
BbList	loadByCourseId(Id courseId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
BbList	loadByCourseId(Id courseId, java.sql.Connection con) Load the list of CalendarEntry objects for the given course Id using the supplied connection.
BbList	loadByCourseIdAndUserId(Id courseId, Id userId, java.util.Calendar startDate, java.util.Calendar endDate) loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id.
BbList	loadByCourseIdAndUserId(Id courseId, Id userId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con) loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id using the supplied connection.
CalendarEntry	loadById(Id id) Load the CalendarEntry with the given Id from the database using a connection obtained through this object's database context.
CalendarEntry	loadById(Id id, java.sql.Connection con) Load the CalendarEntry with the given Id from the database using the supplied connection.
BbList	loadByType(CalendarEntry.Type type) Load the list of CalendarEntry objects of the given Calendar.Type using a connection obtained through this object's database context.
BbList	loadByType(CalendarEntry.Type type, java.util.Calendar startDate, java.util.Calendar endDate)
BbList	loadByType(CalendarEntry.Type type, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
BbList	loadByType(CalendarEntry.Type type, java.sql.Connection con) Load the list of CalendarEntry objects of the given Calendar.Type using the supplied connection.
BbList	loadByUserId(Id userId) Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
BbList	loadByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate) Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
BbList	loadByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con) Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.
BbList	loadByUserId(Id userId, java.sql.Connection con) Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.
BbList	loadPersonalByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate) Loads the list of personal calendar entries within a given date range that pertain to the user identified by the given user Id using a connection obtained through this object's database context.
BbList	loadPersonalByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con) Loads the list of personal calendar entries that pertain to the user identified by the given user 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

CalendarEntry loadById(Id id)
                       throws KeyNotFoundException,
                              PersistenceException

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

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadById

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

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

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadByType

BbList loadByType(CalendarEntry.Type type)
                  throws KeyNotFoundException,
                         PersistenceException

Load the list of CalendarEntry objects of the given Calendar.Type using a connection obtained through this object's database context.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided course id is invalid

PersistenceException - if some other error occurs while loading the object

loadByType

BbList loadByType(CalendarEntry.Type type,
                  java.sql.Connection con)
                  throws KeyNotFoundException,
                         PersistenceException

Load the list of CalendarEntry objects of the given Calendar.Type using the supplied connection.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided course id is invalid

PersistenceException - if some other error occurs while loading the object

loadByType

BbList loadByType(CalendarEntry.Type type,
                  java.util.Calendar startDate,
                  java.util.Calendar endDate)
                  throws KeyNotFoundException,
                         PersistenceException

Throws:

KeyNotFoundException

PersistenceException

loadByType

BbList loadByType(CalendarEntry.Type type,
                  java.util.Calendar startDate,
                  java.util.Calendar endDate,
                  java.sql.Connection con)
                  throws KeyNotFoundException,
                         PersistenceException

Throws:

KeyNotFoundException

PersistenceException

loadByCourseId

BbList loadByCourseId(Id courseId)
                      throws KeyNotFoundException,
                             PersistenceException

Load the list of CalendarEntry objects for the given course Id using a connection obtained through this object's database context.

Results are ordered by start date (CalendarEntry.getStartDate()).

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 CalendarEntry objects for the given course Id using the supplied connection.

Results are ordered by start date (CalendarEntry.getStartDate()).

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.util.Calendar startDate,
                      java.util.Calendar endDate)
                      throws KeyNotFoundException,
                             PersistenceException

Throws:

KeyNotFoundException

PersistenceException

loadByCourseId

BbList loadByCourseId(Id courseId,
                      java.util.Calendar startDate,
                      java.util.Calendar endDate,
                      java.sql.Connection con)
                      throws KeyNotFoundException,
                             PersistenceException

Throws:

KeyNotFoundException

PersistenceException

loadByUserId

BbList loadByUserId(Id userId)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList loadByUserId(Id userId,
                    java.util.Calendar startDate,
                    java.util.Calendar endDate,
                    java.sql.Connection con)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the list of all calendar entries (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList loadByUserId(Id userId,
                    java.util.Calendar startDate,
                    java.util.Calendar endDate)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using a connection obtained through this object's database context.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList loadByUserId(Id userId,
                    java.sql.Connection con)
                    throws KeyNotFoundException,
                           PersistenceException

Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user identified by the given user Id using the supplied connection.

Results are ordered by CalendarEntry.Type (CalendarEntry.getType()), course Id (BbObject.getId()), start date (CalendarEntry.getStartDate()), and event title (CalendarEntry.getTitle()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadByCourseIdAndUserId

BbList loadByCourseIdAndUserId(Id courseId,
                               Id userId,
                               java.util.Calendar startDate,
                               java.util.Calendar endDate)
                               throws KeyNotFoundException,
                                      PersistenceException

loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id.

Results are ordered by CalendarEntry.Type (CalendarEntry.getType()), course Id (BbObject.getId()), start date (CalendarEntry.getStartDate()), and event title (CalendarEntry.getTitle()).

Parameters:

-

Returns:

BbList

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadByCourseIdAndUserId

BbList loadByCourseIdAndUserId(Id courseId,
                               Id userId,
                               java.util.Calendar startDate,
                               java.util.Calendar endDate,
                               java.sql.Connection con)
                               throws KeyNotFoundException,
                                      PersistenceException

loadByCourseIdAndUserId Loads the list of all calendar entries within a given date range (institution, course, and personal) that pertain to the user and course identified by the given user Id and course id using the supplied connection.

Results are ordered by CalendarEntry.Type (CalendarEntry.getType()), course Id (BbObject.getId()), start date (CalendarEntry.getStartDate()), and event title (CalendarEntry.getTitle()).

Parameters:

-

Returns:

BbList

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadPersonalByUserId

BbList loadPersonalByUserId(Id userId,
                            java.util.Calendar startDate,
                            java.util.Calendar endDate)
                            throws KeyNotFoundException,
                                   PersistenceException

Loads the list of personal calendar entries within a given date range that pertain to the user identified by the given user Id using a connection obtained through this object's database context.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object

loadPersonalByUserId

BbList loadPersonalByUserId(Id userId,
                            java.util.Calendar startDate,
                            java.util.Calendar endDate,
                            java.sql.Connection con)
                            throws KeyNotFoundException,
                                   PersistenceException

Loads the list of personal calendar entries that pertain to the user identified by the given user Id using the supplied connection.

Results are ordered by start date (CalendarEntry.getStartDate()).

Throws:

KeyNotFoundException - if the provided user id is invalid

PersistenceException - if some other error occurs while loading the object