blackboard.persist.discussionboard
Interface UserForumSettingsDbLoader

All Superinterfaces:

Loader

public interface UserForumSettingsDbLoader
extends Loader

This interface describes the set of methods that all database loaders for UserForumSettings objects must implement.

Since:

Bb 6.0

Version:

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

Nested Class Summary

static class

UserForumSettingsDbLoader.Default A utility class that provides quick access to the UserForumSettingsDbLoader 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	loadByForumId(Id forumId) Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context.
BbList	loadByForumId(Id forumId, java.sql.Connection con) Load the UserForumSettings object for the given Forum Id (identified by forumId) using the supplied connection.
UserForumSettings	loadByForumIdAndUserId(Id forumId, Id userId) Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context.
UserForumSettings	loadByForumIdAndUserId(Id forumId, Id userId, java.sql.Connection conn) Load the UserForumSettings object for the given Forum Id (identified by forumId) using the supplied connection.
UserForumSettings	loadById(Id id) Load the UserForumSettings with the given Id from the database using a connection obtained through this object's database context.
UserForumSettings	loadById(Id id, java.sql.Connection con) Load the UserForumSettings with the given Id from the database using the supplied connection.
BbList	loadSubscribedByForumId(Id forumId) Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context.
BbList	loadSubscribedByForumId(Id forumId, java.sql.Connection con) Load the UserForumSettings object for subscribed users the given Forum Id (identified by forumId) using the supplied connection.

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

UserForumSettings loadById(Id id)
                           throws KeyNotFoundException,
                                  PersistenceException

Load the UserForumSettings with the given Id from the database using a connection obtained through this object's database context.

Parameters:

id - the Id of the UserForumSettings that should be loaded

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadById

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

Load the UserForumSettings with the given Id from the database using the supplied connection.

Parameters:

id - the Id of the UserForumSettings that should be loaded

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

Throws:

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

PersistenceException - if some other error occurs while loading the object

loadByForumId

BbList loadByForumId(Id forumId)
                     throws KeyNotFoundException,
                            PersistenceException

Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context.

Parameters:

forumId - the Id of the Forum whose settings should be loaded

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object

loadByForumId

BbList loadByForumId(Id forumId,
                     java.sql.Connection con)
                     throws KeyNotFoundException,
                            PersistenceException

Load the UserForumSettings object for the given Forum Id (identified by forumId) using the supplied connection.

Parameters:

forumId - the Id of the Forum whose settings should be loaded

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

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object

loadByForumIdAndUserId

UserForumSettings loadByForumIdAndUserId(Id forumId,
                                         Id userId)
                                         throws KeyNotFoundException,
                                                PersistenceException

Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context.

Parameters:

forumId - the Id of the Forum whose settings should be loaded

forumId - the Id of the User whose settings should be loaded

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object

loadByForumIdAndUserId

UserForumSettings loadByForumIdAndUserId(Id forumId,
                                         Id userId,
                                         java.sql.Connection conn)
                                         throws KeyNotFoundException,
                                                PersistenceException

Load the UserForumSettings object for the given Forum Id (identified by forumId) using the supplied connection.

Parameters:

forumId - the Id of the Forum whose settings should be loaded

forumId - the Id of the User whose settings should be loaded

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

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object

loadSubscribedByForumId

BbList loadSubscribedByForumId(Id forumId)
                               throws PersistenceException

Load the UserForumSettings object for the given Forum Id (identified by forumId) using a connection obtained through this object's database context. This is a heavy loader that loads a filtered version of the User

Parameters:

forumId - the Id of the Forum whose settings should be loaded

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object

loadSubscribedByForumId

BbList loadSubscribedByForumId(Id forumId,
                               java.sql.Connection con)
                               throws PersistenceException

Load the UserForumSettings object for subscribed users the given Forum Id (identified by forumId) using the supplied connection. This is a heavy loader that loads a filtered version of the User

Parameters:

forumId - the Id of the Forum whose settings should be loaded

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

Throws:

KeyNotFoundException - if the provided forum id is invalid

PersistenceException - if some other error occurs while loading the object