[rhmessaging-commits] rhmessaging commits: r1254 - mgmt/cumin/python/wooly.

[rhmessaging-commits at lists.jboss.org]

Author: justi9
Date: 2007-11-06 14:08:39 -0500 (Tue, 06 Nov 2007)
New Revision: 1254

Modified:
   mgmt/cumin/python/wooly/__init__.py
Log:
Adds a comment to page to explain how session state is preserved or
discarded.



Modified: mgmt/cumin/python/wooly/__init__.py
===================================================================
--- mgmt/cumin/python/wooly/__init__.py	2007-11-06 18:58:52 UTC (rev 1253)
+++ mgmt/cumin/python/wooly/__init__.py	2007-11-06 19:08:39 UTC (rev 1254)
@@ -295,6 +295,16 @@
         self.frame.set_default(frame)
 
     def get_saved_parameters(self, session):
+        """
+        Gets a list of parameters saved for this page and its current
+        frame.
+
+        This, combined with *_current_frame, serves to discard state
+        that is out of scope.  The current pattern is to preserve the
+        state of parameters in the current frame and all of its
+        ancestor frames.
+        """
+        
         frame = self.get_current_frame(session)
 
         if frame not in self.cached_parameters: