blackboard.persist.discussionboard
Interface MessageXmlPersister

All Superinterfaces:
Persister

public interface MessageXmlPersister
extends Persister

MessageXmlPersister

Since:
Bb 5.5

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(Message obj, org.w3c.dom.Document doc)
          Generates an Element tree whose values and structure matches the contents of the provided Message object.
 void persist(Message obj, java.util.List<java.lang.String> list, java.lang.String previousMsgId, java.lang.String previousMsgParentId, javax.xml.stream.XMLStreamWriter writer)
          Generates an Element tree whose values and structure matches the contents of the provided Message 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. Used when making a call to BbPersistenceManager.getPersister(String)

See Also:
Constant Field Values
Method Detail

persist

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

Parameters:
obj - the Message 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 Message object
Throws:
ValidationException - not thrown
PersistenceException

persist

void persist(Message obj,
             java.util.List<java.lang.String> list,
             java.lang.String previousMsgId,
             java.lang.String previousMsgParentId,
             javax.xml.stream.XMLStreamWriter writer)
             throws ValidationException,
                    PersistenceException,
                    javax.xml.stream.XMLStreamException
Generates an Element tree whose values and structure matches the contents of the provided Message object.

Parameters:
obj - the Message we should generate the XML tree for.
list - list of Messages that have not been ended with tag yet.
previousMsgId - The ExternalString of previous Message's Id
previousMsgParentId - The ExternalString of the Parent's Id of previous Message
writer - the (@link XMLStreamWriter} we should should use to writer the XML document
Throws:
ValidationException - not thrown
PersistenceException
javax.xml.stream.XMLStreamException


Copyright © 2012 Blackboard, Inc. All Rights Reserved.