blackboard.admin.persist.datasource
Interface DataSourceLoader

All Superinterfaces:
Loader

public interface DataSourceLoader
extends Loader

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

A loader provides for the retrieval of an object to be stored within the CMS system. Loading methods are named according to the type of persistence that is performed.

Since:
Bb 6.0
See Also:
DataSourcePersister, DataSource

Nested Class Summary
static class DataSourceLoader.Default
          A utility class that provides quick access to the Loader 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
 DataSourceObjectCount loadAdminObjectCount(java.lang.String dataSourceBatchUid, DataType dataType, IAdminObject.RowStatus status)
          load AdminObject Count
 BbList<DataSource> loadAll()
          loadAll
 BbList<DataSourceObjectCount> loadAllAdminObjectCounts(java.lang.String dataSourceBatchUid, IAdminObject.RowStatus status)
          load All AdminObject Counts
 DataSource loadByBatchUid(java.lang.String dataSourceBatchUid)
          Load by batch uid.
 DataSource loadDefault()
          Loads the default data source.
 
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

loadByBatchUid

DataSource loadByBatchUid(java.lang.String dataSourceBatchUid)
                          throws PersistenceException,
                                 KeyNotFoundException
Load by batch uid.

Parameters:
dataSourceBatchUid - Batch Uid with which to identify DataSource object.
Returns:
DataSource object referenced by batch uid provided.
Throws:
PersistenceException - Thrown if failure occurs during load of DataSource object.
KeyNotFoundException - Thrown if DataSource object could not be found with provided batch uid.

loadDefault

DataSource loadDefault()
                       throws PersistenceException,
                              KeyNotFoundException
Loads the default data source.

Throws:
PersistenceException
KeyNotFoundException

loadAll

BbList<DataSource> loadAll()
                           throws PersistenceException
loadAll

Returns:
BbList List containing referrants to instances of DataSource.
Throws:
PersistenceException - Thrown if failure occurs during load of DataSource object.

loadAdminObjectCount

DataSourceObjectCount loadAdminObjectCount(java.lang.String dataSourceBatchUid,
                                           DataType dataType,
                                           IAdminObject.RowStatus status)
                                           throws PersistenceException,
                                                  KeyNotFoundException
load AdminObject Count

Parameters:
dataSourceBatchUid - Batch Uid with which to identify DataSource object.
dataType - DataType refers to identifying type for Admin Object to be referred to.
status - IAdminObject.RowStatus status to be used in specifying criteria in count selection.
Returns:
DataSourceObjectCount Represents count of particular a type of Admin Object.
Throws:
KeyNotFoundException - Thrown if DataSource object could not be found with provided batch uid.
PersistenceException - Thrown if failure occurs during load of DataSourceObjectCount objects.

loadAllAdminObjectCounts

BbList<DataSourceObjectCount> loadAllAdminObjectCounts(java.lang.String dataSourceBatchUid,
                                                       IAdminObject.RowStatus status)
                                                       throws PersistenceException,
                                                              KeyNotFoundException
load All AdminObject Counts

Parameters:
dataSourceBatchUid - Batch Uid with which to identify DataSource object.
status - IAdminObject.RowStatus status to be used in specifying criteria in count selection.
Returns:
BbList List containing referrants to encapsulated counts of Admin Objects
Throws:
KeyNotFoundException - Thrown if DataSource object could not be found with provided batch uid.
PersistenceException - Thrown if failure occurs during load of DataSourceObjectCount objects.


Copyright © 2012 Blackboard, Inc. All Rights Reserved.