blackboard.persist.discussionboard
Interface UserForumSettingsXmlLoader

All Superinterfaces:

Loader

public interface UserForumSettingsXmlLoader
extends Loader

Version:

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

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

UserForumSettings	load(org.w3c.dom.Element rootElement) Generates a UserForumSettings object given an Element tree whose structure and contents match those generated by UserForumSettingsXmlPersister.
UserForumSettings	load(java.io.InputStream is) Generates an UserForumSettings object given an InputStream which contains XML whose structure and contents match those generated by UserForumSettingsXmlPersister.
BbList	loadList(org.w3c.dom.Element rootElement) Generates a BbList of UserForumSettings objects from the Element tree provided.
BbList	loadList(java.io.InputStream is) Generates a BbList of UserForumSettings objects from the InputStream provided.

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

load

UserForumSettings load(org.w3c.dom.Element rootElement)
                       throws java.lang.IllegalArgumentException,
                              PersistenceException

Generates a UserForumSettings object given an Element tree whose structure and contents match those generated by UserForumSettingsXmlPersister.

Parameters:

rootElement - the root Element of a valid UserForumSettings XML tree that should be transformed.

Returns:

a UserForumSettings whose contents matches those of the Element tree provided.

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid UserForumSettings XML tree.

PersistenceException - thrown if an error occurs in the element reading process.

load

UserForumSettings load(java.io.InputStream is)
                       throws java.lang.IllegalArgumentException,
                              PersistenceException

Generates an UserForumSettings object given an InputStream which contains XML whose structure and contents match those generated by UserForumSettingsXmlPersister.

Parameters:

is - the InputStream containing the XML to load the assessment creation settings from

Returns:

a UserForumSettings whose contents matches those of the XML contained within the provided stream.

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream does not contain a valid UserForumSettings XML tree.

PersistenceException - thrown if an error occurs in the element reading process.

loadList

BbList loadList(org.w3c.dom.Element rootElement)
                throws java.lang.IllegalArgumentException,
                       PersistenceException

Generates a BbList of UserForumSettings objects from the Element tree provided.

Parameters:

rootElement - the root Element of a valid list of UserForumSettings XML trees that should be transformed.

Returns:

a BbList of UserForumSettings objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid list of assessment creation settings

PersistenceException - thrown if an error occurs in the element reading process.

loadList

BbList loadList(java.io.InputStream is)
                throws java.lang.IllegalArgumentException,
                       PersistenceException

Generates a BbList of UserForumSettings objects from the InputStream provided.

Parameters:

is - the InputStream containing the XML to load the assessment creation settings list from

Returns:

a BbList of UserForumSettings objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream is not the root of a valid list of assessment creation settings

PersistenceException - thrown if an error occurs in the element reading process.