blackboard.persist.discussionboard
Interface ForumDbPersister

All Superinterfaces:

Persister

public interface ForumDbPersister
extends Persister

This interface describes the set of methods that all database persisters for Forum objects must implement.

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 5.5

Version:

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

Nested Class Summary

static class

ForumDbPersister.Default

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	deleteByConferenceId(Id confId) Deletes the Forums in the Conference with the given Id value using a connection from the associated persistence manager's database container.
void	deleteByConferenceId(Id confId, java.sql.Connection con) Deletes the Forums in the Conference with the given Id value using the supplied connection.
void	deleteById(Id id) Deletes the Forum 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 Forum identified by the given Id value using the supplied connection.
void	persist(Forum forum) Inserts or updates the supplied Forum using a connection from the associated persistence manager's database container.
void	persist(Forum forum, java.sql.Connection con) Inserts or updates the supplied Forum using the supplied connection.
void	reposition(Id forumId, int newPosition) A utility class that provides quick access to the ForumDbPersister instance associated with the default instance of the database BbPersistenceManager.
void	reposition(Id fourmId, int newPosition, java.sql.Connection con) A utility class that provides quick access to the ForumDbPersister instance from the database 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(Forum forum)
             throws ValidationException,
                    PersistenceException

Inserts or updates the supplied Forum 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(Forum forum,
             java.sql.Connection con)
             throws ValidationException,
                    PersistenceException

Inserts or updates the supplied Forum 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 Forum identified by the given Id value using a connection from the associated persistence manager's database container.

Throws:

KeyNotFoundException - if an object with the given Id value can not be found

PersistenceException - if some other exception happens during the delete operation

deleteById

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

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

Throws:

KeyNotFoundException - if an object with the given Id value can not be found

PersistenceException - if some other exception happens during the delete operation

deleteByConferenceId

void deleteByConferenceId(Id confId)
                          throws KeyNotFoundException,
                                 PersistenceException

Deletes the Forums in the Conference with the given Id value using a connection from the associated persistence manager's database container.

Throws:

KeyNotFoundException - if an object with the given Id value can not be found

PersistenceException - if some other exception happens during the delete operation

deleteByConferenceId

void deleteByConferenceId(Id confId,
                          java.sql.Connection con)
                          throws KeyNotFoundException,
                                 PersistenceException

Deletes the Forums in the Conference with the given Id value using the supplied connection.

Throws:

KeyNotFoundException - if an object with the given Id value can not be found

PersistenceException - if some other exception happens during the delete operation

reposition

void reposition(Id forumId,
                int newPosition)
                throws KeyNotFoundException,
                       PersistenceException

A utility class that provides quick access to the ForumDbPersister instance associated with the default instance of the database BbPersistenceManager.

This class and its method(s) are conveniences and should be used wisely. If one is retrieving many Loader and/or Persister instances within some scope, it will likely be more efficient to retrieve the default database persistence manager directly, and then retrieve loader/persister instances from it instead of making several calls to this and/or other loader/persister utility classes.

Throws:

KeyNotFoundException

PersistenceException

reposition

void reposition(Id fourmId,
                int newPosition,
                java.sql.Connection con)
                throws KeyNotFoundException,
                       PersistenceException

A utility class that provides quick access to the ForumDbPersister instance from the database using the supplied connection.

This class and its method(s) are conveniences and should be used wisely. If one is retrieving many Loader and/or Persister instances within some scope, it will likely be more efficient to retrieve the default database persistence manager directly, and then retrieve loader/persister instances from it instead of making several calls to this and/or other loader/persister utility classes.

Throws:

KeyNotFoundException

PersistenceException