blackboard.persist.course
Interface CourseMembershipXmlLoader

All Superinterfaces:

Loader

public interface CourseMembershipXmlLoader

extends Loader

CourseMembershipXmlLoader

Since:

Bb 5.5

Version:

$Revision: 2 $ $Date: 12/26/01 1:38p $

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

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

Methods inherited from interface blackboard.persist.Loader

getAppVersion, init

Field Detail

TYPE

public 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

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

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

Parameters:

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

Returns:

a CourseMembership whose contents match those of the Element tree provided.

Throws:

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

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

load

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

Generates a CourseMembership object given an InputStream which contains XML whose structure and contents match those generated by CourseMembershipXMLPerister.

Parameters:

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

Returns:

a CourseMembership whose contents match those of the XML contained within the provided stream.

Throws:

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

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

loadList

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

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

Parameters:

rootElement - the root (@link Element} of a valid list of CourseMembership XML trees that should be transformed.

Returns:

a BbList of CourseMembership objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid list of course memberships

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

loadList

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

Generates a BbList of CourseMembership objects from the InputStream provided.

Parameters:

is - the InputStream containg the XML to load the groups list from

Returns:

a BbList of CourseMembership objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided stream is not the root of a valid list of course memberships

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