blackboard.persist.discussionboard
Interface MessageXmlPersister

All Superinterfaces:

Persister

public interface MessageXmlPersister
extends Persister

MessageXmlPersister

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2007/06/27 $

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.

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 - thrown if the provided Message is not in a proper condition for persisting.

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