blackboard.persist.course
Interface CourseDbPersister

All Superinterfaces:
Persister

public interface CourseDbPersister
extends Persister

This interface describes the set of methods that all database persisters for Course 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

Nested Class Summary
static class CourseDbPersister.Default
          A utility class that provides quick access to the CourseDbPersister 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 deleteById(Id id)
          Deletes the Course 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 Course identified by the given Id value using the supplied connection.
 void persist(Course course)
          Inserts or updates the supplied Course in a lightweight fashion using a connection from the associated persistence manager's database container.
 void persist(Course course, java.sql.Connection con)
          Inserts or updates the supplied Course in a lightweight fashion 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(Course course)
             throws ValidationException,
                    PersistenceException
Inserts or updates the supplied Course in a lightweight fashion 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(Course course,
             java.sql.Connection con)
             throws ValidationException,
                    PersistenceException
Inserts or updates the supplied Course in a lightweight fashion 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 Course identified by the given Id value using a connection from the associated persistence manager's database container.

Because of referential integrity, deletes are done in a heavyweight fashion causing this object as well as all dependent objects to be deleted from the database.

Note: This method will only remove the course from the database; it does NOT remove the filesystem course folders.

Throws:
KeyNotFoundException - is not thrown. Depending on the database used, if a matching Course 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 Course identified by the given Id value using the supplied connection.

Because of referential integrity, deletes are done in a heavyweight fashion causing this object as well as all dependent objects to be deleted from the database.

Note: This method will only remove the course from the database; it does NOT remove the filesystem course folders.

Throws:
KeyNotFoundException - is not thrown. Depending on the database used, if a matching Course 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


Copyright © 2012 Blackboard, Inc. All Rights Reserved.