com.plumtree.server
Interface IPTPersist


public interface IPTPersist

IPTPersist is implemented by objects that wish to support standardized persistence to and from the Plumtree database. Most Plumtree objects support IPTPersist, e.g. Users, Data Sources, etc.

Author:
michaels

Method Summary
 boolean GetDirty()
          Retrieves the dirty flag for this object.
 void Load(com.plumtree.openfoundation.util.IXPPropertyBag pBag)
          Load the persistent data about the object from a PropertyBag (which was typically retrieved from the database)
 void LoadFromXML(java.lang.String bstrXML)
          Load the persistent data about the object from an XML string
 void Save(com.plumtree.openfoundation.util.IXPPropertyBag pBag)
          Save the persistent data about the object to a PropertyBag (which will typically be stored into the database)
 java.lang.String SaveToXML(int nXMLFormat)
          Save the persistent data about the object to an XML string
 void SetDirty(boolean Value)
          Sets the dirty flag for this object.
 

Method Detail

SetDirty

void SetDirty(boolean Value)
Sets the dirty flag for this object. The dirty flag is used to record if any changes have happened to the object since it was last saved. Saving an object that is not dirty is a no-op.

Parameters:
Value - is the object dirty

GetDirty

boolean GetDirty()
Retrieves the dirty flag for this object. The dirty flag is used to record if any changes have happened to the object since it was last saved. Saving an object that is not dirty is a no-op.

Returns:
is the object dirty

Save

void Save(com.plumtree.openfoundation.util.IXPPropertyBag pBag)
Save the persistent data about the object to a PropertyBag (which will typically be stored into the database)

Parameters:
pBag - the PropertyBag into which to save the data

Load

void Load(com.plumtree.openfoundation.util.IXPPropertyBag pBag)
Load the persistent data about the object from a PropertyBag (which was typically retrieved from the database)

Parameters:
pBag - the PropertyBag from which to read data

SaveToXML

java.lang.String SaveToXML(int nXMLFormat)
Save the persistent data about the object to an XML string

Parameters:
nXMLFormat - the format to be used to serialize- must be 0
Returns:
the string representation of the XML holding the object data

LoadFromXML

void LoadFromXML(java.lang.String bstrXML)
Load the persistent data about the object from an XML string

Parameters:
bstrXML - the XML string, as created by SaveToXML


Copyright © 2008 Plumtree Software Inc. All Rights Reserved.