blackboard.persist.course
Interface CourseMembershipXmlPersister

All Superinterfaces:

Persister

public interface CourseMembershipXmlPersister

extends Persister

CourseMembershipXmlPersister

Since:

Bb 6.0

Version:

$Revision: 1 $ $Date: 2/28/02 4:02p $

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

org.w3c.dom.Element	persist(CourseMembership obj, org.w3c.dom.Document doc) Generates an Element tree whose values and structure matches the contents of the provided CourseMembership object.
org.w3c.dom.Element	persistList(BbList list, org.w3c.dom.Document doc) Generates an Element whose children are the provided CourseMembership objects persisted to XML.

Methods inherited from interface blackboard.persist.Persister

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.getPersister(String)

See Also:

Constant Field Values

Method Detail

persist

public org.w3c.dom.Element persist(CourseMembership obj,
                                   org.w3c.dom.Document doc)
                            throws ValidationException,
                                   PersistenceException

Generates an Element tree whose values and structure matches the contents of the provided CourseMembership object.

Parameters:

doc - the (@link Document} we should should use to create the Element with. No assumptions should be made concerning the state of this Document -- it should only be used for Element creation.

Returns:

an Element that matches the contents of this CourseMembership object

Throws:

ValidationException - thrown if the provided CourseMembership is not in a proper condition for persisting.

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

persistList

public org.w3c.dom.Element persistList(BbList list,
                                       org.w3c.dom.Document doc)
                                throws ValidationException,
                                       PersistenceException

Generates an Element whose children are the provided CourseMembership objects persisted to XML.

Parameters:

list - the BbList of CourseMembership objects we should persist.

doc - the (@link Document} we should should use to create the Element with. No assumptions should be made concerning the state of this Document -- it should only be used for Element creation.

Returns:

an Element that is the root of a list of CourseMembership object XML

Throws:

ValidationException - thrown if one of the provided CourseMembership objects is not in a proper condition for persisting.

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