blackboard.persist.content
Interface LinkDbLoader

All Superinterfaces:
Loader

public interface LinkDbLoader
extends Loader

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

Loading methods are named according to the criteria used for loading and the type of load that is performed.

Since:
Bb 6.0

Nested Class Summary
static class LinkDbLoader.Default
          A utility class that provides quick access to the LinkDbLoader 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<Link> loadByCourseId(Id courseId)
          Load the Links defined within the given course (identified by id) from the database using a connection obtained through this object's database context.
 BbList<Link> loadByCourseId(Id courseId, java.sql.Connection con)
          Load the Links defined within the given course (identified by id) from the database using the supplied connection.
 Link loadById(Id id)
          Load the Link with the given Id from the database using a connection obtained through this object's database context.
 Link loadById(Id id, java.sql.Connection con)
          Load the Link with the given Id from the database using the supplied connection.
 java.util.List<Link> loadByLinkIdsAndCourseId(java.util.List<Id> linkId, Id courseId)
           
 java.util.List<Link> loadByLinkIdsAndCourseId(java.util.List<Id> linkIds, Id courseId, java.sql.Connection con)
           
 BbList<Link> loadByReferredToIdAndType(Id id, Link.ReferredToType eReferredToType)
          Load the Link with the given referred to id and type from the database using a connection obtained through this object's database context.
 BbList<Link> loadByReferredToIdAndType(Id id, Link.ReferredToType eReferredToType, java.sql.Connection con)
          Load the Links with the given referred to id and type from the database using the supplied connection.
 java.util.List<Link> loadByReferredToTypeAndCourseId(Id courseId, Link.ReferredToType eReferredToType)
           
 java.util.List<Link> loadByReferredToTypeAndCourseId(Id courseId, Link.ReferredToType eReferredToType, java.sql.Connection con)
           
 Link loadByReferrerIdAndType(Id id, Link.ReferrerType eReferrerType)
          Load the Link with the given referrer id and type from the database using a connection obtained through this object's database context.
 Link loadByReferrerIdAndType(Id id, Link.ReferrerType eReferrerType, java.sql.Connection con)
          Load the Link with the given referrer id and type from the database using the supplied connection.
 java.util.List<Link> loadByReferrerTypeAndCourseId(Id courseId, Link.ReferrerType eReferrerType)
           
 java.util.List<Link> loadByReferrerTypeAndCourseId(Id courseId, Link.ReferrerType eReferrerType, java.sql.Connection con)
           
 
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

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

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

loadById

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

Parameters:
id - the Id of the Link that should be loaded
con - the Connection to use to perform the load. If left null, method will use default connection.
Throws:
KeyNotFoundException - if there is no Link in the database with the given Id
PersistenceException - if some other error occurs while loading the object

loadByCourseId

BbList<Link> loadByCourseId(Id courseId)
                            throws KeyNotFoundException,
                                   PersistenceException
Load the Links defined within the given course (identified by id) from the database using a connection obtained through this object's database context.

Parameters:
courseId - the Id of the Link that should be loaded
Throws:
KeyNotFoundException - if the provided course id value is invalid
PersistenceException - if some other error occurs while loading the object

loadByCourseId

BbList<Link> loadByCourseId(Id courseId,
                            java.sql.Connection con)
                            throws KeyNotFoundException,
                                   PersistenceException
Load the Links defined within the given course (identified by id) from the database using the supplied connection.

Parameters:
courseId - the Id of the Course that from which links should be loaded
con - the Connection to use to perform the load. If left null, method will use default connection.
Throws:
KeyNotFoundException - if the provided course id value is invalid
PersistenceException - if some other error occurs while loading the object

loadByReferrerIdAndType

Link loadByReferrerIdAndType(Id id,
                             Link.ReferrerType eReferrerType)
                             throws KeyNotFoundException,
                                    PersistenceException
Load the Link with the given referrer id and type from the database using a connection obtained through this object's database context.

Parameters:
id - the Id of the Course from which links should be loaded
Throws:
KeyNotFoundException - if there is no Link in the database with the given referrer id and type
PersistenceException - if some other error occurs while loading the object

loadByReferrerIdAndType

Link loadByReferrerIdAndType(Id id,
                             Link.ReferrerType eReferrerType,
                             java.sql.Connection con)
                             throws KeyNotFoundException,
                                    PersistenceException
Load the Link with the given referrer id and type from the database using the supplied connection.

Parameters:
id - the Id of the Link.ReferrerType that should be loaded
eReferrerType - the Link.ReferrerType
con - the Connection to use to perform the load. If left null, method will use default connection.
Throws:
KeyNotFoundException - if there is no Link in the database with the given referrer id and type
PersistenceException - if some other error occurs while loading the object

loadByReferrerTypeAndCourseId

java.util.List<Link> loadByReferrerTypeAndCourseId(Id courseId,
                                                   Link.ReferrerType eReferrerType)
                                                   throws KeyNotFoundException,
                                                          PersistenceException,
                                                          blackboard.db.ConnectionNotAvailableException,
                                                          java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException

loadByReferrerTypeAndCourseId

java.util.List<Link> loadByReferrerTypeAndCourseId(Id courseId,
                                                   Link.ReferrerType eReferrerType,
                                                   java.sql.Connection con)
                                                   throws KeyNotFoundException,
                                                          PersistenceException,
                                                          blackboard.db.ConnectionNotAvailableException,
                                                          java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException

loadByLinkIdsAndCourseId

java.util.List<Link> loadByLinkIdsAndCourseId(java.util.List<Id> linkId,
                                              Id courseId)
                                              throws KeyNotFoundException,
                                                     PersistenceException,
                                                     blackboard.db.ConnectionNotAvailableException,
                                                     java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException

loadByLinkIdsAndCourseId

java.util.List<Link> loadByLinkIdsAndCourseId(java.util.List<Id> linkIds,
                                              Id courseId,
                                              java.sql.Connection con)
                                              throws KeyNotFoundException,
                                                     PersistenceException,
                                                     blackboard.db.ConnectionNotAvailableException,
                                                     java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException

loadByReferredToIdAndType

BbList<Link> loadByReferredToIdAndType(Id id,
                                       Link.ReferredToType eReferredToType)
                                       throws KeyNotFoundException,
                                              PersistenceException
Load the Link with the given referred to id and type from the database using a connection obtained through this object's database context.

Parameters:
id - the Id of the Link.ReferrerType that should be loaded
eReferredToType - the Link.ReferrerType
Throws:
KeyNotFoundException - if the provided id value is invalid
PersistenceException - if some other error occurs while loading the object

loadByReferredToIdAndType

BbList<Link> loadByReferredToIdAndType(Id id,
                                       Link.ReferredToType eReferredToType,
                                       java.sql.Connection con)
                                       throws KeyNotFoundException,
                                              PersistenceException
Load the Links with the given referred to id and type from the database using the supplied connection.

Parameters:
id - the Id of the Link.ReferredToType that should be loaded
eReferredToType - the Link.ReferredToType
con - the Connection to use to perform the load. If left null, method will use default connection.
Throws:
KeyNotFoundException - if the provided id value is invalid
PersistenceException - if some other error occurs while loading the object

loadByReferredToTypeAndCourseId

java.util.List<Link> loadByReferredToTypeAndCourseId(Id courseId,
                                                     Link.ReferredToType eReferredToType)
                                                     throws KeyNotFoundException,
                                                            PersistenceException,
                                                            blackboard.db.ConnectionNotAvailableException,
                                                            java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException

loadByReferredToTypeAndCourseId

java.util.List<Link> loadByReferredToTypeAndCourseId(Id courseId,
                                                     Link.ReferredToType eReferredToType,
                                                     java.sql.Connection con)
                                                     throws KeyNotFoundException,
                                                            PersistenceException,
                                                            blackboard.db.ConnectionNotAvailableException,
                                                            java.sql.SQLException
Throws:
KeyNotFoundException
PersistenceException
blackboard.db.ConnectionNotAvailableException
java.sql.SQLException


Copyright © 2012 Blackboard, Inc. All Rights Reserved.