r5751 - in trunk/gnue-appserver: doc/technotes src/classrep

[johannes]

Author: johannes
Date: 2004-04-20 10:00:12 -0500 (Tue, 20 Apr 2004)
New Revision: 5751

Modified:
   trunk/gnue-appserver/doc/technotes/00002.txt
   trunk/gnue-appserver/src/classrep/Parameter.py
   trunk/gnue-appserver/src/classrep/Procedure.py
Log:
Updated documentation, and added some minor fixes


Modified: trunk/gnue-appserver/doc/technotes/00002.txt
===================================================================
--- trunk/gnue-appserver/doc/technotes/00002.txt        2004-04-20 14:43:54 UTC 
(rev 5750)
+++ trunk/gnue-appserver/doc/technotes/00002.txt        2004-04-20 15:00:12 UTC 
(rev 5751)
@@ -77,6 +77,16 @@
               'gnue_id' has 'string(32)' as dbFullType, as well as the above
               'address_country' column would be 'string(32)'. A column with
               fullType 'boolean' has a dbFullType 'boolean'.
+* isReference:     This boolean value is True if the property definition is 
+                   referencing another class. If True the property
+                   'referencedClass' is set to the class definition of this
+                   referenced class.
+* referencedClass: Class definition of the class referenced by this property
+                   definition.
+* isValidated:     This boolean value is True if the property definition has
+                   been validated. If a property definition has been validated,
+                   both properties 'isReference' and 'referencedClass' are
+                   valid.
 
 
 The Procedure Object
@@ -86,8 +96,38 @@
 documentation) are also accessible as properties of the corresponding Python
 object.
 
-Apart from that, the Python object of class "Property" has the following
+Apart from that, the Python object of class "Procedure" has the following
 properties:
 
-* module:     The module defining the property
+* module:       The module defining the property
+* fullName:     The fully qualified name
+* parameters:   A dictionary of all the parameters of the procedure, where the
+                parameter names act as key.
+* isCalculated: This boolean value is true, if the procedure could be used as a
+                calculated field. This means the procedure has a valid result
+                type, there are no parameters specified and the name of the
+                procedure starts with 'get'. If 'isCalculated' is true the
+                property 'calcFullName' holds the full qualified name of the
+                calculated property, e.g: the procedure
+                'address_getlastmeeting' has a 'calcFullName' of
+                'address_lastmeeting'
+* isValidated:  This boolean value is true if the procedure definition has been
+                validated. If so, the values of 'isCalculated' and
+                'calcFullName' are valid.
+* calcFullName: If a procedure could be used as 'calculated field' this value
+                property specifies the 'property name' of such a field.
+
+
+The Parameter Object
+====================
+
+All properties of the gnue_parameter business object (described in the API
+documentation) are also accessible as properties of the corresponding Python
+object.
+
+Apart from that, the Python object of class "Parameter" has the following
+properties:
+
 * fullName:   The fully qualified name
+* dbType:     The database-specific type of the property, not including length 
+              or scale, e.g. a type 'id' has 'string' as dbType.

Modified: trunk/gnue-appserver/src/classrep/Parameter.py
===================================================================
--- trunk/gnue-appserver/src/classrep/Parameter.py      2004-04-20 14:43:54 UTC 
(rev 5750)
+++ trunk/gnue-appserver/src/classrep/Parameter.py      2004-04-20 15:00:12 UTC 
(rev 5751)
@@ -106,5 +106,7 @@
   def __init__ (self, session, aObject, pDefs = None):
     BaseObject.__init__ (self, session, 'gnue_parameter', aObject, pDefs)
     self.fullName = self.gnue_name
-    self.dbType   = self.gnue_type
-
+    if self.gnue_type == 'id':
+      self.dbType = 'string'
+    else:
+      self.dbType = self.gnue_type

Modified: trunk/gnue-appserver/src/classrep/Procedure.py
===================================================================
--- trunk/gnue-appserver/src/classrep/Procedure.py      2004-04-20 14:43:54 UTC 
(rev 5750)
+++ trunk/gnue-appserver/src/classrep/Procedure.py      2004-04-20 15:00:12 UTC 
(rev 5751)
@@ -127,6 +127,7 @@
     self.fullName     = createName (module.gnue_name, self.gnue_name)
     self.isCalculated = False
     self.isValidated  = False
+    self.calcFullName = None
 
     self.parameters   = ParameterDict (session, self)