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

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<CalendarEntry> 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<CalendarEntry> loadByCourseId(Id courseId, java.util.Calendar startDate, java.util.Calendar endDate)
           
 BbList<CalendarEntry> loadByCourseId(Id courseId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
           
 BbList<CalendarEntry> loadByCourseId(Id courseId, java.sql.Connection con)
          Load the list of CalendarEntry objects for the given course Id using the supplied connection.
 BbList<CalendarEntry> 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<CalendarEntry> 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.
 BbList<CalendarEntry> loadByCreatorUserId(Id userId)
          Loads the list of all calendar entries created or owned by the given user id using a connection obtained through this object's database context.
 BbList<CalendarEntry> loadByCreatorUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate)
           
 BbList<CalendarEntry> loadByCreatorUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
           
 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<CalendarEntry> 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<CalendarEntry> loadByType(CalendarEntry.Type type, java.util.Calendar startDate, java.util.Calendar endDate)
           
 BbList<CalendarEntry> loadByType(CalendarEntry.Type type, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
           
 BbList<CalendarEntry> loadByType(CalendarEntry.Type type, java.sql.Connection con)
          Load the list of CalendarEntry objects of the given Calendar.Type using the supplied connection.
 BbList<CalendarEntry> loadByUserId(Id userId)
          Loads the list of all calendar entries in courses, in which the user identified by the given user Id is enrolled using a connection obtained through this object's database context.
 BbList<CalendarEntry> loadByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate)
          Loads the list of all calendar entries within a given date range and courses, in which the user identified by the given user Id is enrolled using a connection obtained through this object's database context.
 BbList<CalendarEntry> loadByUserId(Id userId, java.util.Calendar startDate, java.util.Calendar endDate, java.sql.Connection con)
          Loads the list of all calendar entries in courses, in which the user identified by the given user Id is enrolled using a connection connection.
 BbList<CalendarEntry> loadByUserId(Id userId, java.sql.Connection con)
          Loads the list of all calendar entries within a given date range and courses, in which the user identified by the given user Id is enrolled using a connection.
 BbList<CalendarEntry> 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<CalendarEntry> 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<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadByType

BbList<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadByType

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

loadByType

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

loadByCourseId

BbList<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadByCourseId

BbList<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadByCourseId

BbList<CalendarEntry> loadByCourseId(Id courseId,
                                     java.util.Calendar startDate,
                                     java.util.Calendar endDate)
                                     throws KeyNotFoundException,
                                            PersistenceException
Throws:
KeyNotFoundException
PersistenceException

loadByCourseId

BbList<CalendarEntry> loadByCourseId(Id courseId,
                                     java.util.Calendar startDate,
                                     java.util.Calendar endDate,
                                     java.sql.Connection con)
                                     throws KeyNotFoundException,
                                            PersistenceException
Throws:
KeyNotFoundException
PersistenceException

loadByCreatorUserId

BbList<CalendarEntry> loadByCreatorUserId(Id userId)
                                          throws KeyNotFoundException,
                                                 PersistenceException
Loads the list of all calendar entries created or owned 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadByCreatorUserId

BbList<CalendarEntry> loadByCreatorUserId(Id userId,
                                          java.util.Calendar startDate,
                                          java.util.Calendar endDate,
                                          java.sql.Connection con)
                                          throws KeyNotFoundException,
                                                 PersistenceException
Throws:
KeyNotFoundException
PersistenceException

loadByCreatorUserId

BbList<CalendarEntry> loadByCreatorUserId(Id userId,
                                          java.util.Calendar startDate,
                                          java.util.Calendar endDate)
                                          throws KeyNotFoundException,
                                                 PersistenceException
Throws:
KeyNotFoundException
PersistenceException

loadByUserId

BbList<CalendarEntry> loadByUserId(Id userId)
                                   throws KeyNotFoundException,
                                          PersistenceException
Loads the list of all calendar entries in courses, in which the user identified by the given user Id is enrolled using a connection obtained through this object's database context.

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

Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList<CalendarEntry> 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 in courses, in which the user identified by the given user Id is enrolled using a connection connection.

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

Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList<CalendarEntry> 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 and courses, in which the user identified by the given user Id is enrolled using a connection obtained through this object's database context.

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

Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadByUserId

BbList<CalendarEntry> loadByUserId(Id userId,
                                   java.sql.Connection con)
                                   throws KeyNotFoundException,
                                          PersistenceException
Loads the list of all calendar entries within a given date range and courses, in which the user identified by the given user Id is enrolled using a connection.

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

Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadByCourseIdAndUserId

BbList<CalendarEntry> 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()).

Returns:
BbList
Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadByCourseIdAndUserId

BbList<CalendarEntry> 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()).

Returns:
BbList
Throws:
KeyNotFoundException - not thrown
PersistenceException - if some other error occurs while loading the object

loadPersonalByUserId

BbList<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object

loadPersonalByUserId

BbList<CalendarEntry> 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 - not thrown
PersistenceException - if some other error occurs while loading the object


Copyright © 2012 Blackboard, Inc. All Rights Reserved.