|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortalRoleDbLoader
This interface describes the set of methods that all database loaders for
PortalRole
objects must implement. PortalRole objects represent the
institution roles within the Blackboard application.
Loading methods are named according to the criteria used for loading and the
type of load that is performed.
Nested Class Summary | |
---|---|
static class |
PortalRoleDbLoader.Default
A utility class that provides quick access to the PortalRoleDbLoader
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 |
loadAll()
Load the list of PortalRole objects in the system from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadAll(java.sql.Connection con)
Load the list of PortalRole objects in the system from the database in a lightweight fashion using the supplied connection. |
BbList |
loadAllByUserId(Id userId)
Load the list of PortalRole objects that represent the primary and secondary portal roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadAllByUserId(Id userId,
java.sql.Connection con)
Load the list of PortalRole objects that represent the primary and secondary portal roles for the given user from the database in a lightweight fashion using the supplied connection. |
PortalRole |
loadById(Id id)
Load the PortalRole with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context. |
PortalRole |
loadById(Id id,
java.sql.Connection con)
Load the PortalRole with the given Id from the database in a lightweight fashion using the supplied connection. |
PortalRole |
loadByRoleId(java.lang.String roleId)
Load the PortalRole with the given role id from the database in a lightweight fashion using a connection obtained through this object's database context. |
PortalRole |
loadByRoleId(java.lang.String roleId,
java.sql.Connection con)
Load the PortalRole with the given role id from the database in a lightweight fashion using the supplied connection. |
PortalRole |
loadByRoleName(java.lang.String name)
Load the PortalRole with the given name from the database in a lightweight fashion using a connection obtained through this object's database context. |
PortalRole |
loadByRoleName(java.lang.String name,
java.sql.Connection con)
Load the PortalRole with the given name from the database in a lightweight fashion using the supplied connection. |
PortalRole |
loadDefault()
Load the default PortalRole object in the system from the database in a lightweight fashion using a connection obtained through this object's database context. |
PortalRole |
loadDefault(java.sql.Connection con)
Load the default PortalRole object in the system from the database in a lightweight fashion using the supplied connection. |
PortalRole |
loadPrimaryRoleByUserId(Id userId)
Load the PortalRole that is the primary portal role for the given user from the database in a lightweight fashion using a connection obtained through this object's database context. |
PortalRole |
loadPrimaryRoleByUserId(Id userId,
java.sql.Connection con)
Load the PortalRole that is the primary portal role for the given user from the database in a lightweight fashion using the supplied connection. |
BbList |
loadRemovable()
Load the list of PortalRole objects that have a removable attribute of true from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadRemovable(java.sql.Connection con)
Load the list of PortalRole objects that have a removable attribute of true from the database in a lightweight fashion using the supplied connection. |
BbList |
loadSecondaryRolesByUserId(Id userId)
Load the list of PortalRole objects that represent the secondary portal roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context. |
BbList |
loadSecondaryRolesByUserId(Id userId,
java.sql.Connection con)
Load the list of PortalRole objects that represent the secondary portal roles for the given user from the database in a lightweight fashion using the supplied connection. |
Methods inherited from interface blackboard.persist.CachingLoader |
---|
getCacheFileName, refreshCache |
Methods inherited from interface blackboard.persist.Loader |
---|
getAppVersion, init |
Field Detail |
---|
static final java.lang.String TYPE
BbPersistenceManager.getLoader(String)
.
Method Detail |
---|
PortalRole loadById(Id id) throws KeyNotFoundException, PersistenceException
id
- the Id
of the PortalRole
that should be loaded
KeyNotFoundException
- if there is no PortalRole in the database with
the given id
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadById(Id id, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
id
- the Id
of the PortalRole
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no PortalRole in the database with
the given id
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadByRoleId(java.lang.String roleId) throws KeyNotFoundException, PersistenceException
roleId
- the role id of the PortalRole
that should be loaded
KeyNotFoundException
- if there is no PortalRole in the database with
the given role id
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadByRoleId(java.lang.String roleId, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
roleId
- the role id of the PortalRole
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no PortalRole in the database with
the given role id
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadByRoleName(java.lang.String name) throws KeyNotFoundException, PersistenceException
name
- the name of the PortalRole
that should be loaded
KeyNotFoundException
- if there is no PortalRole in the database with
the given name
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadByRoleName(java.lang.String name, java.sql.Connection con) throws KeyNotFoundException, PersistenceException
name
- the name of the PortalRole
that should be loadedcon
- the Connection
to use to perform the load. Can be null.
KeyNotFoundException
- if there is no PortalRole in the database with
the given name
PersistenceException
- if some other error occurs while loading
the objectBbList loadRemovable() throws PersistenceException
PersistenceException
- if some other error occurs while loading
the objectBbList loadRemovable(java.sql.Connection con) throws PersistenceException
con
- the Connection
to use to perform the load. Can be null.
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadPrimaryRoleByUserId(Id userId) throws PersistenceException
userId
- the Id
of the User
whose primary portal role should be loaded.
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadPrimaryRoleByUserId(Id userId, java.sql.Connection con) throws PersistenceException
userId
- the Id
of the User
whose primary portal role should be loaded.con
- the Connection
to use to perform the load. Can be null.
PersistenceException
- if some other error occurs while loading
the objectBbList loadSecondaryRolesByUserId(Id userId) throws PersistenceException
userId
- the Id
of the User
whose secondary portal roles should be loaded.
PersistenceException
- if some other error occurs while loading
the objectBbList loadSecondaryRolesByUserId(Id userId, java.sql.Connection con) throws PersistenceException
userId
- the Id
of the User
whose secondary portal roles should be loaded.con
- the Connection
to use to perform the load. Can be null.
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllByUserId(Id userId) throws PersistenceException
userId
- the Id
of the User
whose primary and secondary portal roles should be loaded.
PersistenceException
- if some other error occurs while loading
the objectBbList loadAllByUserId(Id userId, java.sql.Connection con) throws PersistenceException
userId
- the Id
of the User
whose primary and secondary portal roles should be loaded.con
- the Connection
to use to perform the load. Can be null.
PersistenceException
- if some other error occurs while loading
the objectBbList loadAll() throws PersistenceException
PersistenceException
- if some other error occurs while loading
the objectBbList loadAll(java.sql.Connection con) throws PersistenceException
con
- the Connection
to use to perform the load. Can be null.
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadDefault() throws PersistenceException
PersistenceException
- if some other error occurs while loading
the objectPortalRole loadDefault(java.sql.Connection con) throws PersistenceException
con
- the Connection
to use to perform the load. Can be null.
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 |