|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CourseDbLoader
This interface describes the set of methods that all database loaders for
Course
objects must implement.
Loading methods are named according to the criteria used for loading and the
type of load that is performed. Loading operations can be either "lightweight"
or "heavyweight". Lightweight loads load only those values directly associated
with a data object (the immediate properties of an object). Heavyweight loads
load those values directly associated with an object as well as the values of
those objects directly contained by the object. Heavyweight loads are
optimized to be as efficient as possible, but because more data is loaded
performance will be slower than that of lightweight loads. As a result,
lightweight load should be performed whenever possible.
Nested Class Summary | |
---|---|
static class |
CourseDbLoader.Default
A utility class that provides quick access to the CourseDbLoader
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 |
loadAllByServiceLevel(Course.ServiceLevel sLevel)
Load all course objects in the system with the given Course.ServiceLevel
value in a light-weight fashion using a connection obtained through this
object's database context. |
BbList |
loadAllByServiceLevel(Course.ServiceLevel sLevel,
java.sql.Connection con)
Load all course objects in the system with the given Course.ServiceLevel
value in a light-weight fashion using the supplied connection. |
BbList |
loadAllCourses()
Load all course objects in the system in a light-weight fashion using a connection obtained through this object's database context. |
BbList |
loadAllCourses(java.sql.Connection con)
Load all course objects in the system in a light-weight fashion using the supplied connection. |
Course |
loadByBatchUid(java.lang.String batchUid)
Load the Course with the given batch uid value from the database in a light- weight fashion using a connection obtained through this object's database context. |
Course |
loadByBatchUid(java.lang.String batchUid,
java.sql.Connection con)
Load the Course with the given batch uid value from the database in a light- weight fashion using the supplied connection. |
Course |
loadByBatchUid(java.lang.String batchUid,
java.sql.Connection con,
boolean bHeavy)
Load the Course with the given batch uid value from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
Course |
loadByCourseId(java.lang.String courseId)
Load the Course with the given course id (not pk) value from the database in a lightweight fashion using a connection obtained through this object's database context. |
Course |
loadByCourseId(java.lang.String courseId,
java.sql.Connection con)
Load the Course with the given course id (not pk) value from the database in a lightweight fashion using the supplied connection. |
Course |
loadByCourseId(java.lang.String courseId,
java.sql.Connection con,
boolean bHeavy)
Load the Course with the given course id (not pk) from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
BbList |
loadByDataSourceBatchUid(java.lang.String dsBatchUid)
Loads the lists of Courses associated with the datasource (identified by the given batch uid) from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadByDataSourceBatchUid(java.lang.String dsBatchUid,
java.sql.Connection con)
Loads the lists of Courses associated with the datasource (identified by the given batch uid) from the database in a lightweight fashion using the suppplied connection. |
Course |
loadById(Id id)
Load the Course with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context. |
Course |
loadById(Id id,
java.sql.Connection con)
Load the Course with the given Id from the database in a lightweight fashion using the supplied connection. |
Course |
loadById(Id id,
java.sql.Connection con,
boolean bHeavy)
Load the Course with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
BbList |
loadByUserId(Id userId)
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled using a connection obtained through this object's database context. |
BbList |
loadByUserId(Id userId,
java.sql.Connection con)
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled using the supplied connection. |
BbList |
loadByUserId(Id userid,
java.sql.Connection con,
boolean bHeavy)
Load the list of Course objects in the specified fashion (lightweight or heavyweight) in which the given user (identified by id) is enrolled using the supplied connection. |
BbList |
loadByUserIdAndCourseMembershipRole(Id userId,
CourseMembership.Role role)
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled with a specific course based role using a connection obtained through this object's database context. |
BbList |
loadByUserIdAndCourseMembershipRole(Id userId,
CourseMembership.Role role,
java.sql.Connection con)
Load the list of Course objects in a lightweight fashion in which the given user (identified by id) is enrolled with a specific course based role using the supplied connection. |
BbList |
loadByUserIdAndCourseMembershipRole(Id userid,
CourseMembership.Role role,
java.sql.Connection con,
boolean bHeavy)
Load the list of Course objects in the specified fashion (lightweight or heavyweight) in which the given user (identified by id) with a specific course based role is enrolled using the supplied connection. |
BbList |
loadTemplates()
Load all course objects in the system with a course registry flag indicating they are course templates. |
BbList |
loadTemplates(java.sql.Connection con)
Load all course objects in the system with a course registry flag indicating they are course templates. |
Methods inherited from interface blackboard.persist.Loader |
---|
getAppVersion, init |
Field Detail |
---|
static final java.lang.String TYPE
BbPersistenceManager.getLoader(String)
Method Detail |
---|
Course loadById(Id id) throws KeyNotFoundException, PersistenceException
id
- the Id
of the Course
that should be loaded
KeyNotFoundException
- if there is no Course in the database with
the given id
PersistenceException
- if some other error occurs while loading
the objectCourse loadById(Id id, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
id
- the Id
of the Course
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no Course in the database with
the given id
PersistenceException
- if some other error occurs while loading
the objectCourse loadById(Id id, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
id
- the Id
of the Course
that should be loadedcon
- the Connection
to use to perform the load. Can be null.bHeavy
- a boolean
value denoting whether a "heavy" load
should be performed.
KeyNotFoundException
- if there is no Course in the database with
the given id
PersistenceException
- if some other error occurs while loading
the objectCourse loadByCourseId(java.lang.String courseId) throws KeyNotFoundException, PersistenceException
courseId
- the string-based unique id of the Course
that should
be loaded
KeyNotFoundException
- if there is no course in the database with
the given course id
PersistenceException
- if some other error occurs while loading
the objectCourse loadByCourseId(java.lang.String courseId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
courseId
- the string-based unique id of the Course
that should
be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no course in the database with
the given course id
PersistenceException
- if some other error occurs while loading
the objectCourse loadByCourseId(java.lang.String courseId, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
courseId
- the string-based unique id of the Course
that should
be loadedcon
- the Connection
to use to perform the load. Can be null.bHeavy
- a boolean
value denoting whether a "heavy" load
should be performed.
KeyNotFoundException
- if there is no course in the database with
the given course id
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserId(Id userId) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loaded
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserId(Id userId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserId(Id userid, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loadedcon
- the Connection
to use to perform the load. Can be null.bHeavy
- a boolean
value denoting whether a "heavy" load
should be performed.
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserIdAndCourseMembershipRole(Id userId, CourseMembership.Role role) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loadedrole
- the CourseMembership.Role
of the User
.
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserIdAndCourseMembershipRole(Id userId, CourseMembership.Role role, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loadedrole
- the CourseMembership.Role
of the User
.con
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByUserIdAndCourseMembershipRole(Id userid, CourseMembership.Role role, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
userId
- the Id
of the User
whose courses should be
loadedrole
- the CourseMembership.Role
of the User
.con
- the Connection
to use to perform the load. Can be null.bHeavy
- a boolean
value denoting whether a "heavy" load
should be performed.
KeyNotFoundException
- if the provided user id is invalid
PersistenceException
- if some other error occurs while loading
the objectCourse loadByBatchUid(java.lang.String batchUid) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the Course
that should be loaded
KeyNotFoundException
- if there is no course in the database with
the given batch uid
PersistenceException
- if some other error occurs while loading
the objectCourse loadByBatchUid(java.lang.String batchUid, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the Course
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no course in the database with
the given batch uid
PersistenceException
- if some other error occurs while loading
the objectCourse loadByBatchUid(java.lang.String batchUid, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the Course
that should be loadedcon
- the Connection
to use to perform the load. Can be null.bHeavy
- a boolean
value denoting whether a "heavy" load
should be performed.
KeyNotFoundException
- if there is no course in the database with
the given batch uid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByDataSourceBatchUid(java.lang.String dsBatchUid) throws KeyNotFoundException, PersistenceException
dsBatchUid
- the data source batch uid of the Course
that should
be loaded
KeyNotFoundException
- if the provided batch uid is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadByDataSourceBatchUid(java.lang.String dsBatchUid, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
dsBatchUid
- the data source batch uid of the Course
that should
be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided batch uid is invalid
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllCourses() throws KeyNotFoundException, PersistenceException
loadAllByServiceLevel(Course.ServiceLevel)
instead.
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllCourses(java.sql.Connection con) throws KeyNotFoundException, PersistenceException
loadAllByServiceLevel(Course.ServiceLevel,Connection)
instead.
con
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllByServiceLevel(Course.ServiceLevel sLevel) throws KeyNotFoundException, PersistenceException
Course.ServiceLevel
value in a light-weight fashion using a connection obtained through this
object's database context.
sLevel
- the Course.ServiceLevel
of the course objects that
should be loaded
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllByServiceLevel(Course.ServiceLevel sLevel, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
Course.ServiceLevel
value in a light-weight fashion using the supplied connection.
sLevel
- the Course.ServiceLevel
of the course objects that
should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the objectBbList loadTemplates() throws KeyNotFoundException, PersistenceException
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the objectBbList loadTemplates(java.sql.Connection con) throws KeyNotFoundException, PersistenceException
con
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- not thrown
PersistenceException
- if some other error occurs while loading
the object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |