blackboard.persist.discussionboard
Interface MessageLabelDbLoader

All Superinterfaces:
Loader

public interface MessageLabelDbLoader
extends Loader

MessageLabelDbLoader

Version:
$Revision: #1 $ 2005-4-18 $

Nested Class Summary
static class MessageLabelDbLoader.Default
          A utility class that provides quick access to the MessageLabelDbLoader 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)
          Loads the list of Message labels that belong to messages located within the given forum (identified by Id) using a connection obtained through this object's database context.
 BbList loadByForumId(Id forumId, java.sql.Connection con)
          Loads the list of Message labels that belong to messages located within the given forum (identified by Id) using the supplied connection.
 MessageLabel loadById(Id id)
          Load the Message label with the given Id from the database using a connection obtained through this object's database context.
 MessageLabel loadById(Id id, java.sql.Connection con)
          Load the Message label with the given Id from the database using the supplied connection.
 MessageLabel loadByMessageId(Id messageId)
          Load the Message label with the given parent message Id from the database using a connection obtained through this object's database context.
 MessageLabel loadByMessageId(Id messageId, java.sql.Connection con)
          Load the Message label with the given parent message Id from the database 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

MessageLabel loadById(Id id)
                      throws KeyNotFoundException,
                             PersistenceException
Load the Message label with the given Id from the database using a connection obtained through this object's database context.

Parameters:
id - the Id of the MessageLabel that should be loaded
Throws:
KeyNotFoundException - if there is no Message label in the database with the given id
PersistenceException - if some other error occurs while loading the object

loadById

MessageLabel loadById(Id id,
                      java.sql.Connection con)
                      throws KeyNotFoundException,
                             PersistenceException
Load the Message label with the given Id from the database using the supplied connection.

Parameters:
id - the Id of the MessageLabel that should be loaded
con - the Connection to use to perform the load. Can be null.
Throws:
KeyNotFoundException - if there is no Message label in the database with the given id
PersistenceException - if some other error occurs while loading the object

loadByMessageId

MessageLabel loadByMessageId(Id messageId)
                             throws KeyNotFoundException,
                                    PersistenceException
Load the Message label with the given parent message Id from the database using a connection obtained through this object's database context.

Parameters:
messageId - the Id of the parent Message that the Messagelabel should be loaded for
Throws:
KeyNotFoundException - if there is no Message label in the database with the given parent message id
PersistenceException - if some other error occurs while loading the object

loadByMessageId

MessageLabel loadByMessageId(Id messageId,
                             java.sql.Connection con)
                             throws KeyNotFoundException,
                                    PersistenceException
Load the Message label with the given parent message Id from the database using the supplied connection.

Parameters:
messageId - the Id of the parent Message that the MessageLabel should be loaded for
con - the Connection to use to perform the load. Can be null.
Throws:
KeyNotFoundException - if there is no Message label in the database with the given parent message id
PersistenceException - if some other error occurs while loading the object

loadByForumId

BbList loadByForumId(Id forumId)
                     throws KeyNotFoundException,
                            PersistenceException
Loads the list of Message labels that belong to messages located within the given forum (identified by Id) using a connection obtained through this object's database context.

Parameters:
forumId - the Id of the Forum that contains messages for which labels 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
Loads the list of Message labels that belong to messages located within the given forum (identified by Id) using the supplied connection.

Parameters:
forumId - the Id of the Forum that contains messages for which labels 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


Copyright © 2003 Blackboard, Inc. All Rights Reserved.