Commit 01a49a24 authored by Vincent Pelletier's avatar Vincent Pelletier

Document _load .

git-svn-id: https://svn.erp5.org/repos/neo/trunk@2255 71dcc9de-d417-0410-9af5-da40c76e7ee4
parent 2a4f6272
...@@ -439,7 +439,35 @@ class Application(object): ...@@ -439,7 +439,35 @@ class Application(object):
@profiler_decorator @profiler_decorator
def _load(self, oid, serial=None, tid=None, cache=0): 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) cell_list = self._getCellListForOID(oid, readable=True)
if len(cell_list) == 0: if len(cell_list) == 0:
# No cells available, so why are we running ? # No cells available, so why are we running ?
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment