[Neo-report] r2255 vincent - /trunk/neo/client/app.py

[nobody at svn.erp5.org]

Author: vincent
Date: Sat Aug 28 10:27:45 2010
New Revision: 2255

Log:
Document _load .

Modified:
    trunk/neo/client/app.py

Modified: trunk/neo/client/app.py
==============================================================================
--- trunk/neo/client/app.py [iso-8859-1] (original)
+++ trunk/neo/client/app.py [iso-8859-1] Sat Aug 28 10:27:45 2010
@@ -439,7 +439,35 @@ class Application(object):
 
     @profiler_decorator
     def _load(self, oid, serial=None, tid=None, cache=0):
-        """Internal method which manage load ,loadSerial and loadBefore."""
+        """
+        Internal method which manage load, loadSerial and loadBefore.
+        OID and TID (serial) parameters are expected packed.
+        oid
+            OID of object to get.
+        serial
+            If given, the exact serial at which OID is desired.
+            tid should be None.
+        tid
+            If given, the excluded upper bound serial at which OID is desired.
+            serial should be None.
+        cache
+            Store data in cache for future lookups.
+
+        Return value: (3-tuple)
+        - Object data (None if object creation was undone).
+        - Serial of given data.
+        - Next serial at which object exists, or None. Only set when tid
+          parameter is not None.
+
+        Exceptions:
+            NEOStorageError
+                technical problem
+            NEOStorageNotFoundError
+                object exists but no data satisfies given parameters
+                object doesn't exist
+        """
+        # TODO:
+        # - rename parameters (here and in handlers & packet definitions)
         cell_list = self._getCellListForOID(oid, readable=True)
         if len(cell_list) == 0:
             # No cells available, so why are we running ?