gnue/gnue-common/doc DataObjects.txt

[Jason Cater]

CVSROOT:        /home/cvs
Module name:    gnue
Changes by:     Jason Cater <address@hidden>    01/07/17 12:10:54

Modified files:
        gnue-common/doc: DataObjects.txt 

Log message:
        Clarified my clarifications to the DataObjects docs

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue-common/doc/DataObjects.txt.diff?cvsroot=OldCVS&tr1=1.2&tr2=1.3&r1=text&r2=text

Patches:
Index: gnue/gnue-common/doc/DataObjects.txt
diff -u gnue/gnue-common/doc/DataObjects.txt:1.2 
gnue/gnue-common/doc/DataObjects.txt:1.3
--- gnue/gnue-common/doc/DataObjects.txt:1.2    Tue Jul 17 12:06:19 2001
+++ gnue/gnue-common/doc/DataObjects.txt        Tue Jul 17 12:10:54 2001
@@ -3,6 +3,8 @@
 GRD for forms and reports, respectively). The DataSource object acts as
 a implementation buffer between vendor-specific DataObjects and vendor-
 neutral datasource tags (explained further in the DataObject discussion).
+In other words, a vendor-specific DataObject will be bound to the 
+DataSource after the DataSource is initialized.
 
 A DataObject is the highest level object in the Database Driver hierarchy. 
 It basically maintains state information such as the database connection,
@@ -39,24 +41,28 @@
 
 ***********
 DataSource: 
-  getDataSet(): 
-  
-  addDetailDataSource() : Adds a DataSource in a master/detail relationship
-  masterRecordChanged() : Called when master in master/detail is updated
+  initialize()
+    Called to initialize the datasource. Binds the 
+    DataSource to a DataObject.
+
+  getDataObject()
+    Returns the bound DataObject
+
+  referenceField(field)
+    Used by the client app to notify that a certain field is being 
+    referenced.  This will ensure that the DataObject includes this
+    field in its query.
 
-  commit()      : 
-  rollback()    : 
 
-
 ***********
 DataObject:
-  createResultSet(self, conditions={}, readOnly=0): 
+  createResultSet(conditions={}, readOnly=0): 
     Creates and returns a resultset satisfying "conditions". conditions
     can either be a dictionary/hash of fieldname:value AND pairs, or, for
     more complex conditions, a GConditions object.
 
 
-  addDetailDataObject(self, dataObject, handler=None): 
+  addDetailDataObject(dataObject, handler=None): 
     Add a detail data object.  This dataobject will create a new resultset 
     everything this dataobject changes (new record, etc).  The optional 
     handler will be called after the detail dataobject is notified.  The