blackboard.persist.user
Interface UserRoleDbPersister

All Superinterfaces:

Persister

public interface UserRoleDbPersister
extends Persister

This interface describes the set of methods that all database persisters for UserRole objects must implement. UserRole objects represent a user's secondary institution roles.

A database persister allows an object to be stored (either inserted or updated) within the database or to be deleted from the database. Persisting methods are named according to the type of persistence that is performed.

Since:

Bb 6.3

Version:

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

See Also:

BbPersistenceManager, UserRoleDbLoader, UserRole

Nested Class Summary

static class

UserRoleDbPersister.Default A utility class that provides quick access to the UserRoleDbPersister 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

void	deleteAllByUserId(Id userId) Deletes the UserRoles associated with the given user Id value using a connection from the associated persistence manager's database container.
void	deleteAllByUserId(Id userId, java.sql.Connection con) Deletes the UserRoles identified by the given user value using the supplied connection.
void	deleteById(Id id) Deletes the UserRole identified by the given Id value using a connection from the associated persistence manager's database container.
void	deleteById(Id id, java.sql.Connection con) Deletes the UserRole identified by the given Id value using the supplied connection.
void	deleteByUserIdAndInstitutionRoleId(Id userId, Id instRoleId)
void	deleteByUserIdAndInstitutionRoleId(Id userId, Id instRoleId, java.sql.Connection con)
void	persist(UserRole role) Inserts or updates the supplied UserRole using a connection from the associated persistence manager's database container.
void	persist(UserRole role, java.sql.Connection con) Inserts or updates the supplied UserRole using the supplied connection.

Methods inherited from interface blackboard.persist.Persister

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.getPersister(String)

See Also:

Constant Field Values

Method Detail

persist

void persist(UserRole role)
             throws ValidationException,
                    PersistenceException

Inserts or updates the supplied UserRole using a connection from the associated persistence manager's database container. If the object's id is set and is associated with the same container, then an update is done, otherwise a new object is inserted.

Throws:

ValidationException - if the object is not in a consistent state to be persisted.

PersistenceException - if some other exception happens while persisting the object.

persist

void persist(UserRole role,
             java.sql.Connection con)
             throws ValidationException,
                    PersistenceException

Inserts or updates the supplied UserRole using the supplied connection. The connection must be to the same database as is used by the associated persistence manager. If the object's id is set and is associated with this persistence manager's same container, then an update is done, otherwise a new object is inserted.

Throws:

ValidationException - if the object is not in a consistent state to be persisted.

PersistenceException - if some other exception happens while persisting the object.

deleteById

void deleteById(Id id)
                throws KeyNotFoundException,
                       PersistenceException

Deletes the UserRole identified by the given Id value using a connection from the associated persistence manager's database container.

Throws:

KeyNotFoundException - is not thrown. Depending on the database used, if a matching UserRole does not exist a PersistenceException might be thrown or no exception will be thrown but no rows will be affected.

PersistenceException - if some other exception happens during the delete operation

deleteById

void deleteById(Id id,
                java.sql.Connection con)
                throws KeyNotFoundException,
                       PersistenceException

Deletes the UserRole identified by the given Id value using the supplied connection.

Throws:

KeyNotFoundException - is not thrown. Depending on the database used, if a matching UserRole does not exist a PersistenceException might be thrown or no exception will be thrown but no rows will be affected.

PersistenceException - if some other exception happens during the delete operation

deleteAllByUserId

void deleteAllByUserId(Id userId)
                       throws KeyNotFoundException,
                              PersistenceException

Deletes the UserRoles associated with the given user Id value using a connection from the associated persistence manager's database container.

Throws:

KeyNotFoundException - is not thrown. Depending on the database used, if a matching UserRole does not exist a PersistenceException might be thrown or no exception will be thrown but no rows will be affected.

PersistenceException - if some other exception happens during the delete operation

deleteAllByUserId

void deleteAllByUserId(Id userId,
                       java.sql.Connection con)
                       throws KeyNotFoundException,
                              PersistenceException

Deletes the UserRoles identified by the given user value using the supplied connection.

Throws:

KeyNotFoundException - is not thrown. Depending on the database used, if a matching UserRole does not exist a PersistenceException might be thrown or no exception will be thrown but no rows will be affected.

PersistenceException - if some other exception happens during the delete operation

deleteByUserIdAndInstitutionRoleId

void deleteByUserIdAndInstitutionRoleId(Id userId,
                                        Id instRoleId)
                                        throws KeyNotFoundException,
                                               PersistenceException

Throws:

KeyNotFoundException

PersistenceException

deleteByUserIdAndInstitutionRoleId

void deleteByUserIdAndInstitutionRoleId(Id userId,
                                        Id instRoleId,
                                        java.sql.Connection con)
                                        throws KeyNotFoundException,
                                               PersistenceException

Throws:

KeyNotFoundException

PersistenceException