Back to index

plone3  3.1.7
Public Member Functions | Private Attributes
CMFEditions.ZVCStorageTool.ShadowStorage Class Reference
Inheritance diagram for CMFEditions.ZVCStorageTool.ShadowStorage:
Inheritance graph
[legend]
Collaboration diagram for CMFEditions.ZVCStorageTool.ShadowStorage:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def isRegistered
def getHistory

Private Attributes

 _storage

Detailed Description

Container for Shadow Histories

Only cares about containerish operations.

Definition at line 734 of file ZVCStorageTool.py.


Constructor & Destructor Documentation

Definition at line 739 of file ZVCStorageTool.py.

00739 
00740     def __init__(self):
00741         # Using a OOBtree to allow history ids of any type. The type 
00742         # of the history ids higly depends on the unique id tool which
00743         # we isn't under our control.
00744         self._storage = OOBTree()


Member Function Documentation

def CMFEditions.ZVCStorageTool.ShadowStorage.getHistory (   self,
  history_id,
  autoAdd = False 
)
Returns the History Object of the Given ``history_id``.

Returns None if ``autoAdd`` is False and the history 
does not exist. Else prepares and returns an empty history.

Definition at line 750 of file ZVCStorageTool.py.

00750 
00751     def getHistory(self, history_id, autoAdd=False):
00752         """Returns the History Object of the Given ``history_id``.
00753         
00754         Returns None if ``autoAdd`` is False and the history 
00755         does not exist. Else prepares and returns an empty history.
00756         """
00757         # Create a new history if there isn't one yet
00758         if autoAdd and not self.isRegistered(history_id):
00759             self._storage[history_id] = ShadowHistory()
00760         return self._storage.get(history_id, None)
00761 
00762 InitializeClass(ShadowStorage)
00763 

Here is the call graph for this function:

Returns True if a History With the Given History id Exists

Definition at line 745 of file ZVCStorageTool.py.

00745 
00746     def isRegistered(self, history_id):
00747         """Returns True if a History With the Given History id Exists
00748         """
00749         return history_id in self._storage

Here is the caller graph for this function:


Member Data Documentation

Definition at line 743 of file ZVCStorageTool.py.


The documentation for this class was generated from the following file: