blackboard.admin.persist.course
Interface EnrollmentXmlPersister

All Superinterfaces:
Persister

public interface EnrollmentXmlPersister
extends Persister

This class describes the set of methods for XML based Enrollment persistence.

Since:
Bb 6.0
see IMS Project

Nested Class Summary
static class EnrollmentXmlPersister.Default
          A utility class that provides quick access to the Persister instance associated with the default instance of the database BbPersistenceManager.
 
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(Enrollment obj, org.w3c.dom.Document doc)
          Generates an Element tree Enrollment as specified by the IMS spec whose values and structure matches the contents of the provided Enrollment object.
 org.w3c.dom.Element persist(java.util.List<? extends IMembership> objList, org.w3c.dom.Document doc)
          Generates an Element tree whose values and structure matches the contents of the provided Enrollment object.
 
Methods inherited from interface blackboard.persist.Persister
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.

See Also:
Constant Field Values
Method Detail

persist

org.w3c.dom.Element persist(Enrollment obj,
                            org.w3c.dom.Document doc)
Generates an Element tree Enrollment as specified by the IMS spec whose values and structure matches the contents of the provided Enrollment object.

Parameters:
obj - the Enrollment we should generate the XML tree for.
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 Enrollment object

persist

org.w3c.dom.Element persist(java.util.List<? extends IMembership> objList,
                            org.w3c.dom.Document doc)
Generates an Element tree whose values and structure matches the contents of the provided Enrollment object. For list processing it is assumed that all items are associated with a single course

Parameters:
objList - the list of Enrollment objects we should generate the XML tree for.
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 List object


Copyright © 2012 Blackboard, Inc. All Rights Reserved.