blackboard.persist.discussionboard
Interface ForumXmlLoader

All Superinterfaces:

Loader

public interface ForumXmlLoader
extends Loader

ForumXmlLoader

Since:

Bb 5.5

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

Forum	load(org.w3c.dom.Element rootElement) Generates an Forum object given an Element tree whose structure and contents match those generated by ForumXMLPersister .
Forum	load(java.io.InputStream is) Generates an Forum object given an InputStream which contains XML whose structure and contents match those generated by ForumXMLPerister.

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

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

Generates an Forum object given an Element tree whose structure and contents match those generated by ForumXMLPersister .

Parameters:

rootElement - the root (@link Element} of a valid Forum XML tree that should be transformed.

Returns:

an Forum 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 Forum XML tree.

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

load

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

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

Parameters:

is - the InputStream containg the XML to load the forum from

Returns:

an Forum 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 Forum XML tree.

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