blackboard.persist.course
Interface GroupMembershipXmlLoader

All Superinterfaces:

Loader

public interface GroupMembershipXmlLoader

extends Loader

GroupMembershipXmlLoader

Since:

Bb 6.0

Version:

$Revision: 2 $ $Date: 2/27/02 4: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

GroupMembership	load(org.w3c.dom.Element rootElement) Generates a GroupMembership object given an Element tree whose structure and contents match those generated by GroupMembershipXMLPerister .
GroupMembership	load(java.io.InputStream is) Generates a GroupMembership object given an InputStream which contains XML whose structure and contents match those generated by GroupMembershipXMLPerister.
BbList	loadList(org.w3c.dom.Element rootElement) Generates a BbList of GroupMembership objects from the Element tree provided.
BbList	loadList(java.io.InputStream is) Generates a BbList of GroupMembership 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 GroupMembership load(org.w3c.dom.Element rootElement)
                     throws java.lang.IllegalArgumentException,
                            PersistenceException

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

Parameters:

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

Returns:

a GroupMembership 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 GroupMembership XML tree.

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

load

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

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

Parameters:

is - the InputStream containing the XML to load the group membership from

Returns:

a GroupMembership 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 GroupMembership 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 GroupMembership objects from the Element tree provided.

Parameters:

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

Returns:

a BbList of GroupMembership objects from the tree provided

Throws:

java.lang.IllegalArgumentException - thrown if the provided Element is not the root of a valid list of group 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 GroupMembership objects from the InputStream provided.

Parameters:

is - the InputStream containing the XML to load the group membership list from

Returns:

a BbList of GroupMembership objects from the tree provided

Throws:

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

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