|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserDbLoader
This interface describes the set of methods that all database loaders for
User
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 |
UserDbLoader.Default
A utility class that provides quick access to the UserDbLoader
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 | |
---|---|
User |
loadByBatchUid(java.lang.String batchUid)
Load the User with the given batch uid value from the database in a light- weight fashion using a connection obtained through this object's database context. |
User |
loadByBatchUid(java.lang.String batchUid,
java.sql.Connection con)
Load the User with the given batch uid value from the database in a light- weight fashion using the supplied connection. |
User |
loadByBatchUid(java.lang.String batchUid,
java.sql.Connection con,
boolean bHeavy)
Load the User with the given batch uid from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
BbList |
loadByCardNumberFamilyNameGivenName(java.lang.String cardNumber,
java.lang.String familyName,
java.lang.String givenName,
java.sql.Connection con)
|
BbList |
loadByCourseId(Id courseId)
Load all users that are enrolled in the given course from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadByCourseId(Id courseId,
java.sql.Connection con)
Load all users that are enrolled in the given course from the database in a lightweight fashion using the supplied connection. |
BbList |
loadByCourseId(Id courseId,
java.sql.Connection con,
boolean bHeavy)
Load all users that are enrolled in the given course from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
BbList |
loadByEmailAddressFamilyNameGivenName(java.lang.String emailAddress,
java.lang.String familyName,
java.lang.String givenName)
Load the BbList of users with the given email address from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadByEmailAddressFamilyNameGivenName(java.lang.String emailAddress,
java.lang.String familyName,
java.lang.String givenName,
java.sql.Connection con)
These three loaders are only used by the guest deposit module using different guest identifiers |
BbList |
loadByGroupId(Id groupId)
Load all users that are enrolled in the given group from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadByGroupId(Id groupId,
java.sql.Connection con)
Load all users that are enrolled in the given group from the database in a lightweight fashion using the supplied connection. |
BbList |
loadByGroupId(Id groupId,
java.sql.Connection con,
boolean bHeavy)
Load all users that are enrolled in the given group from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
User |
loadById(Id id)
Load the User with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context. |
User |
loadById(Id id,
java.sql.Connection con)
Load the User with the given Id from the database in a lightweight fashion using the supplied connection. |
User |
loadById(Id id,
java.sql.Connection con,
boolean bHeavy)
Load the User with the given Id from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
BbList |
loadByPrimaryPortalRoleId(Id portalRoleId)
Load all users by the given portalRole id in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadByPrimaryPortalRoleId(Id portalRoleId,
java.sql.Connection con)
Load all users by the given portalRole id in a lightweight fashion using the supplied connection. |
BbList |
loadByPrimaryPortalRoleId(Id portalRoleId,
java.sql.Connection con,
boolean bHeavy)
Load all users by the given portalRole id in the specified fashion using the supplied connection. |
BbList |
loadByStudentIdFamilyNameGivenName(java.lang.String studentId,
java.lang.String familyName,
java.lang.String givenName,
java.sql.Connection con)
|
User |
loadByUserName(java.lang.String userName)
Load the User with the given username from the database in a lightweight fashion using a connection obtained through this object's database context. |
User |
loadByUserName(java.lang.String userName,
java.sql.Connection con)
Load the User with the given username from the database in a lightweight fashion using the supplied connection. |
User |
loadByUserName(java.lang.String userName,
java.sql.Connection con,
boolean bHeavy)
Load the User with the given username from the database in the specified fashion (lightweight or heavyweight) using the supplied connection. |
User |
loadGuestUser()
Load the "guest" user using a connection obtained through this object's database context. |
BbList |
loadObservedByObserverId(Id observerId)
Load all users that are/can be observed by the given observer (identified by their user id) in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadObservedByObserverId(Id observerId,
java.sql.Connection con)
Load all users that are/can be observed by the given observer (identified by their user id) in a lightweight fashion using the supplied connection. |
BbList |
loadObservedByObserverId(Id observerId,
java.sql.Connection con,
boolean bHeavy)
Load all users that are/can be observed by the given observer (identified by their user id) in the specified fashion using the supplied connection. |
BbList |
searchByUserName(java.lang.String userName)
|
Methods inherited from interface blackboard.persist.Loader |
---|
getAppVersion, init |
Field Detail |
---|
static final java.lang.String TYPE
BbPersistenceManager.getLoader(String)
Method Detail |
---|
User loadById(Id id) throws KeyNotFoundException, PersistenceException
id
- the Id
of the User
that should be loaded
KeyNotFoundException
- if there is no User in the database with the given id
PersistenceException
- if some other error occurs while loading the objectUser loadById(Id id, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
id
- the Id
of the User
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no User in the database with the given id
PersistenceException
- if some other error occurs while loading the objectUser loadById(Id id, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
id
- the Id
of the User
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 User in the database with the given id
PersistenceException
- if some other error occurs while loading the objectBbList loadByEmailAddressFamilyNameGivenName(java.lang.String emailAddress, java.lang.String familyName, java.lang.String givenName) throws KeyNotFoundException, PersistenceException
email
- the email address of the User
that should be loaded
KeyNotFoundException
- if there is no User in the database with the given id
PersistenceException
- if some other error occurs while loading the objectBbList loadByEmailAddressFamilyNameGivenName(java.lang.String emailAddress, java.lang.String familyName, java.lang.String givenName, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
KeyNotFoundException
PersistenceException
BbList loadByStudentIdFamilyNameGivenName(java.lang.String studentId, java.lang.String familyName, java.lang.String givenName, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
KeyNotFoundException
PersistenceException
BbList loadByCardNumberFamilyNameGivenName(java.lang.String cardNumber, java.lang.String familyName, java.lang.String givenName, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
KeyNotFoundException
PersistenceException
BbList searchByUserName(java.lang.String userName) throws KeyNotFoundException, PersistenceException
KeyNotFoundException
PersistenceException
User loadByUserName(java.lang.String userName) throws KeyNotFoundException, PersistenceException
userName
- the username of the User
that should be loaded
KeyNotFoundException
- if there is no User in the database with the given username
PersistenceException
- if some other error occurs while loading the objectUser loadByUserName(java.lang.String userName, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
userName
- the username of the User
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no User in the database with the given username
PersistenceException
- if some other error occurs while loading the objectUser loadByUserName(java.lang.String userName, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
userName
- the username of the User
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 User in the database with the given username
PersistenceException
- if some other error occurs while loading the objectBbList loadByCourseId(Id courseId) throws KeyNotFoundException, PersistenceException
courseId
- the Id
of the Course
that we should load enrolled
users from
KeyNotFoundException
- if the provided course id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByCourseId(Id courseId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
courseId
- the Id
of the Course
that we should load enrolled
users fromcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided course id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByCourseId(Id courseId, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
courseId
- the Id
of the Course
that we should load enrolled
users fromcon
- 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 course id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByGroupId(Id groupId) throws KeyNotFoundException, PersistenceException
groupId
- the Id
of the Group
that we should load enrolled
users from
KeyNotFoundException
- if the provided group id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByGroupId(Id groupId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
groupId
- the Id
of the Group
that we should load enrolled
users fromcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided group id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByGroupId(Id groupId, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
groupId
- the Id
of the Group
that we should load enrolled
users fromcon
- 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 group id is invalid
PersistenceException
- if some other error occurs while loading the objectUser loadByBatchUid(java.lang.String batchUid) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the User
that should be loaded
KeyNotFoundException
- if there is no User in the database with the given batch uid
PersistenceException
- if some other error occurs while loading the objectUser loadByBatchUid(java.lang.String batchUid, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the User
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no User in the database with the given batch uid
PersistenceException
- if some other error occurs while loading the objectUser loadByBatchUid(java.lang.String batchUid, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
batchUid
- the batch uid of the User
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 User in the database with the given batch uid
PersistenceException
- if some other error occurs while loading the objectBbList loadObservedByObserverId(Id observerId) throws KeyNotFoundException, PersistenceException
observerId
- the Id
of the User
(observer) that we should load
the list of observed users for
KeyNotFoundException
- if the provided observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadObservedByObserverId(Id observerId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
observerId
- the Id
of the User
(observer) that we should load
the list of observed users forcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadObservedByObserverId(Id observerId, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
observerId
- the Id
of the User
(observer) that we should load
the list of observed users forcon
- 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 observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByPrimaryPortalRoleId(Id portalRoleId) throws KeyNotFoundException, PersistenceException
portalRoleId
- the Id
of the User
that we should load the list of
users for
KeyNotFoundException
- if the provided observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByPrimaryPortalRoleId(Id portalRoleId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
portalRoleId
- the Id
of the User
that we should load the list of
users forcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if the provided observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectBbList loadByPrimaryPortalRoleId(Id portalRoleId, java.sql.Connection con, boolean bHeavy) throws KeyNotFoundException, PersistenceException
portalRoleId
- the Id
of the User
that we should load the list of
users forcon
- 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 observer user id is invalid
PersistenceException
- if some other error occurs while loading the objectUser loadGuestUser() throws KeyNotFoundException, PersistenceException
KeyNotFoundException
- if the guest user can not be found
PersistenceException
- if an error occurs while loading the User
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |