blackboard.persist.role
Interface PortalRoleDbLoader

All Superinterfaces:

CachingLoader, Loader

public interface PortalRoleDbLoader
extends CachingLoader

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.

Since:

Bb 6.3

Version:

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

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 institution 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 institution roles for the given user from the database in a lightweight fashion using the supplied connection.
BbList	loadAvailableRolesAll() 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	loadAvailableRolesAll(java.sql.Connection con) Load the list of PortalRole objects in the system 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 institution 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 institution 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 institution 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, boolean disableSecondaryRolesFlag) 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, boolean disableSecondaryRolesFlag, 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.
BbList	loadSecondaryRolesByUserId(Id userId, java.sql.Connection con) Load the list of PortalRole objects that represent the secondary institution 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

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

PortalRole loadById(Id id)
                    throws KeyNotFoundException,
                           PersistenceException

Load the PortalRole with the given Id from the database in a lightweight fashion using a connection obtained through this object's database context.

Parameters:

id - the Id of the PortalRole that should be loaded

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadById

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

Load the PortalRole with the given Id from the database in a lightweight fashion using the supplied connection.

Parameters:

id - the Id of the PortalRole that should be loaded

con - the Connection to use to perform the load. Can be null.

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given id

PersistenceException - if some other error occurs while loading the object

loadByRoleId

PortalRole loadByRoleId(java.lang.String roleId)
                        throws KeyNotFoundException,
                               PersistenceException

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. The role id is the human-readable unique identifier assigned to the institution role.

Parameters:

roleId - the role id of the PortalRole that should be loaded

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given role id

PersistenceException - if some other error occurs while loading the object

loadByRoleId

PortalRole loadByRoleId(java.lang.String roleId,
                        java.sql.Connection con)
                        throws KeyNotFoundException,
                               PersistenceException

Load the PortalRole with the given role id from the database in a lightweight fashion using the supplied connection. The role id is the human-readable unique identifier assigned to the institution role.

Parameters:

roleId - the role id of the PortalRole that should be loaded

con - the Connection to use to perform the load. Can be null.

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given role id

PersistenceException - if some other error occurs while loading the object

loadByRoleName

PortalRole loadByRoleName(java.lang.String name)
                          throws KeyNotFoundException,
                                 PersistenceException

Load the PortalRole with the given name from the database in a lightweight fashion using a connection obtained through this object's database context.

Parameters:

name - the name of the PortalRole that should be loaded

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given name

PersistenceException - if some other error occurs while loading the object

loadByRoleName

PortalRole loadByRoleName(java.lang.String name,
                          java.sql.Connection con)
                          throws KeyNotFoundException,
                                 PersistenceException

Load the PortalRole with the given name from the database in a lightweight fashion using the supplied connection.

Parameters:

name - the name of the PortalRole that should be loaded

con - the Connection to use to perform the load. Can be null.

Throws:

KeyNotFoundException - if there is no PortalRole in the database with the given name

PersistenceException - if some other error occurs while loading the object

loadRemovable

BbList loadRemovable()
                     throws PersistenceException

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadRemovable

BbList loadRemovable(java.sql.Connection con)
                     throws PersistenceException

Load the list of PortalRole objects that have a removable attribute of true from the database in a lightweight fashion using the supplied connection.

Parameters:

con - the Connection to use to perform the load. Can be null.

Throws:

PersistenceException - if some other error occurs while loading the object

loadPrimaryRoleByUserId

PortalRole loadPrimaryRoleByUserId(Id userId)
                                   throws PersistenceException

Load the PortalRole that is the primary institution role for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.

Parameters:

userId - the Id of the User whose primary portal role should be loaded.

Throws:

PersistenceException - if some other error occurs while loading the object

loadPrimaryRoleByUserId

PortalRole loadPrimaryRoleByUserId(Id userId,
                                   java.sql.Connection con)
                                   throws PersistenceException

Load the PortalRole that is the primary institution role for the given user from the database in a lightweight fashion using the supplied connection.

Parameters:

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadSecondaryRolesByUserId

BbList loadSecondaryRolesByUserId(Id userId)
                                  throws PersistenceException

Load the list of PortalRole objects that represent the secondary institution roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.

Parameters:

userId - the Id of the User whose secondary portal roles should be loaded.

Throws:

PersistenceException - if some other error occurs while loading the object

loadSecondaryRolesByUserId

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

Load the list of PortalRole objects that represent the secondary institution roles for the given user from the database in a lightweight fashion using the supplied connection.

Parameters:

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadSecondaryRolesByUserId

BbList loadSecondaryRolesByUserId(Id userId,
                                  boolean disableSecondaryRolesFlag,
                                  java.sql.Connection con)
                                  throws PersistenceException

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.

Parameters:

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadSecondaryRolesByUserId

BbList loadSecondaryRolesByUserId(Id userId,
                                  boolean disableSecondaryRolesFlag)
                                  throws PersistenceException

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.

Parameters:

userId - the Id of the User whose secondary portal roles should be loaded.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAllByUserId

BbList loadAllByUserId(Id userId)
                       throws PersistenceException

Load the list of PortalRole objects that represent the primary and secondary institution roles for the given user from the database in a lightweight fashion using a connection obtained through this object's database context.

Parameters:

userId - the Id of the User whose primary and secondary portal roles should be loaded.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAllByUserId

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

Load the list of PortalRole objects that represent the primary and secondary institution roles for the given user from the database in a lightweight fashion using the supplied connection.

Parameters:

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAll

BbList loadAll()
               throws PersistenceException

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAll

BbList loadAll(java.sql.Connection con)
               throws PersistenceException

Load the list of PortalRole objects in the system from the database in a lightweight fashion using the supplied connection.

Parameters:

con - the Connection to use to perform the load. Can be null.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAvailableRolesAll

BbList loadAvailableRolesAll()
                             throws PersistenceException

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadAvailableRolesAll

BbList loadAvailableRolesAll(java.sql.Connection con)
                             throws PersistenceException

Load the list of PortalRole objects in the system from the database in a lightweight fashion using the supplied connection.

Parameters:

con - the Connection to use to perform the load. Can be null.

Throws:

PersistenceException - if some other error occurs while loading the object

loadDefault

PortalRole loadDefault()
                       throws PersistenceException

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.

Throws:

PersistenceException - if some other error occurs while loading the object

loadDefault

PortalRole loadDefault(java.sql.Connection con)
                       throws PersistenceException

Load the default PortalRole object in the system from the database in a lightweight fashion using the supplied connection.

Parameters:

con - the Connection to use to perform the load. Can be null.

Throws:

PersistenceException - if some other error occurs while loading the object