blackboard.persist.discussionboard
Interface UserForumSettingsXmlLoader

All Superinterfaces:
Loader

public interface UserForumSettingsXmlLoader
extends Loader

Since:
Bb 6.3

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
 UserForumSettings load(org.w3c.dom.Element rootElement)
          Generates a UserForumSettings object given an Element tree whose structure and contents match those generated by UserForumSettingsXmlPersister.
 UserForumSettings load(java.io.InputStream is)
          Generates an UserForumSettings object given an InputStream which contains XML whose structure and contents match those generated by UserForumSettingsXmlPersister.
 BbList<UserForumSettings> loadList(org.w3c.dom.Element rootElement)
           
 BbList<UserForumSettings> loadList(java.io.InputStream is)
           
 
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

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

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

load

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

Parameters:
is - the InputStream containing the XML to load the assessment creation settings from
Returns:
a UserForumSettings 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 UserForumSettings XML tree.
PersistenceException - thrown if an error occurs in the element reading process.

loadList

BbList<UserForumSettings> loadList(org.w3c.dom.Element rootElement)
                                   throws java.lang.IllegalArgumentException,
                                          PersistenceException
Throws:
java.lang.IllegalArgumentException
PersistenceException

loadList

BbList<UserForumSettings> loadList(java.io.InputStream is)
                                   throws java.lang.IllegalArgumentException,
                                          PersistenceException
Throws:
java.lang.IllegalArgumentException
PersistenceException


Copyright © 2012 Blackboard, Inc. All Rights Reserved.