blackboard.persist.discussionboard
Interface UserForumSettingsXmlPersister

All Superinterfaces:
Persister

public interface UserForumSettingsXmlPersister
extends Persister

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
 org.w3c.dom.Element persist(UserForumSettings obj, org.w3c.dom.Document doc)
          Generates an Element tree whose values and structure matches the contents of the provided UserForumSettings object.
 org.w3c.dom.Element persistList(java.util.List<UserForumSettings> list, org.w3c.dom.Document doc)
          Generates an Element whose children are the provided UserForumSettings objects persisted to XML.
 void persistStreamWriteList(java.util.List<UserForumSettings> list, javax.xml.stream.XMLStreamWriter writer)
          Stream writing an Element whose children are the provided UserForumSettings objects persisted to XML.
 
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. Used when making a call to BbPersistenceManager.getPersister(String)

See Also:
Constant Field Values
Method Detail

persist

org.w3c.dom.Element persist(UserForumSettings obj,
                            org.w3c.dom.Document doc)
                            throws ValidationException,
                                   PersistenceException
Generates an Element tree whose values and structure matches the contents of the provided UserForumSettings object.

Parameters:
obj - the UserForumSettings we should generate the XML tree for.
doc - the Document we 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 UserForumSettings object
Throws:
ValidationException - not thrown
PersistenceException - thrown if an error occurs in the element writing process.

persistList

org.w3c.dom.Element persistList(java.util.List<UserForumSettings> list,
                                org.w3c.dom.Document doc)
                                throws ValidationException,
                                       PersistenceException
Generates an Element whose children are the provided UserForumSettings objects persisted to XML.

Parameters:
list - the List of UserForumSettings objects we should persist.
doc - the Document we 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 UserForumSettings object XML
Throws:
ValidationException - not thrown
PersistenceException - thrown if an error occurs in the element writing process.

persistStreamWriteList

void persistStreamWriteList(java.util.List<UserForumSettings> list,
                            javax.xml.stream.XMLStreamWriter writer)
                            throws ValidationException,
                                   PersistenceException,
                                   javax.xml.stream.XMLStreamException
Stream writing an Element whose children are the provided UserForumSettings objects persisted to XML.

Parameters:
list - the List of UserForumSettings objects we should persist.
writer - the XMLStreamWriter we should use to stream write
Throws:
PersistenceException - thrown if an error occurs in the Persistence process.
javax.xml.stream.XMLStreamException - thrown if an error occurs in the stream writing process.
ValidationException


Copyright © 2012 Blackboard, Inc. All Rights Reserved.