blackboard.persist.discussionboard
Interface ConferenceXmlLoader

All Superinterfaces:
Loader

public interface ConferenceXmlLoader
extends Loader

ConferenceXmlLoader

Since:
Bb 6.2
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
 Conference load(org.w3c.dom.Element rootElement)
          Generates an Conference object given an Element tree whose structure and contents match those generated by ConferenceXMLPersister .
 Conference load(java.io.InputStream is)
          Generates a Conference object given an InputStream which contains XML whose structure and contents match those generated by ConferenceXMLPerister.
 BbList loadList(org.w3c.dom.Element rootElement)
          Generates a BbList of Conference objects from the Element tree provided.
 BbList loadList(java.io.InputStream is)
          Generates a BbList of Conference 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

Conference load(org.w3c.dom.Element rootElement)
                throws java.lang.IllegalArgumentException,
                       PersistenceException
Generates an Conference object given an Element tree whose structure and contents match those generated by ConferenceXMLPersister .

Parameters:
rootElement - the root (@link Element} of a valid Conference XML tree that should be transformed.
Returns:
a Conference 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 Conference XML tree.
PersistenceException - thrown if an error occurs in the element reading process.

load

Conference load(java.io.InputStream is)
                throws java.lang.IllegalArgumentException,
                       PersistenceException
Generates a Conference object given an InputStream which contains XML whose structure and contents match those generated by ConferenceXMLPerister.

Parameters:
is - the InputStream containing the XML to load the conference from
Returns:
a Conference 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 Conference 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 Conference objects from the Element tree provided.

Parameters:
rootElement - the root Element of a valid list of Conference XML trees that should be transformed.
Returns:
a BbList of Conference objects from the tree provided
Throws:
java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid list of conferences
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 Conference objects from the InputStream provided.

Parameters:
is - the InputStream containing the XML to load the conference list from
Returns:
a BbList of Conference objects from the tree provided
Throws:
java.lang.IllegalArgumentException - thrown if the provided stream is not the root of a valid list of conferences
PersistenceException - thrown if an error occurs in the element reading process.


Copyright © 2003 Blackboard, Inc. All Rights Reserved.