Changeset 5071 for trunk/doc/src/docbook/developerdoc/api_overview.xml

Timestamp:

Aug 21, 2009, 8:17:57 AM (14 years ago)

Author:

Nicklas Nordborg

Message:

References #108: Logging the change history of an item

• Added the new data classes to UML diagram and made updates to all other affected diagrams
• Documented the logging feature for plug-in developers
• Made the new data classes immutable

File:

• trunk/doc/src/docbook/developerdoc/api_overview.xml (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/api_overview.xml

@@ -405 +405 @@
             This interface is used by items which registered the date they were
             created in the database. The registration date is set at creation time
-            and can't be modified later. Since this didn't exist prior to BASE 2.10
+            and can't be modified later. Since this didn't exist prior to BASE 2.10,
             null values are allowed on all pre-existing items. Note! For backwards 
             compatibility reasons with existing code in 
             <classname docapi="net.sf.basedb.core.data">BioMaterialEventData</classname>
             the method name is <methodname>getEntryDate()</methodname>.
+            </para>
+          </listitem>
+        </varlistentry>
+        
+        <varlistentry>
+          <term><interfacename docapi="net.sf.basedb.core.data">LoggableData</interfacename></term>
+          <listitem>
+            <para>
+            This is a tagging interface that indicates that the <classname 
+            docapi="net.sf.basedb.core.log.db">DbLogManagerFactory</classname> logging
+            implementation should log changes made to items that implements it.
             </para>
           </listitem>