[Zope-Checkins] CVS: Zope/lib/python/Products/ZCatalog/help - ZCatalog.py:1.13

[Casey Duncan]

Update of /cvs-repository/Zope/lib/python/Products/ZCatalog/help
In directory cvs.zope.org:/tmp/cvs-serv15813/help

Modified Files:
	ZCatalog.py 
Log Message:
Added new APIS:
  - Catalog.getIndex returns an acquisition wrapped index, use instead of 
    Catalog.indexes[...]
  - ZCatalog.getIndexObjects returns the list of index obs also acquisition
    wrapped. Its use is preferred over the previous index_objects method.

Changed Catalog code to utilize getIndex. This is mostly a neutral change except for in clear() which did not used to wrap before calling the index.
Help docs and interfaces updated to reflect the change.


=== Zope/lib/python/Products/ZCatalog/help/ZCatalog.py 1.12 => 1.13 ===
--- Zope/lib/python/Products/ZCatalog/help/ZCatalog.py:1.12	Tue Jun 11 16:50:43 2002
+++ Zope/lib/python/Products/ZCatalog/help/ZCatalog.py	Wed Aug 14 15:10:14 2002
@@ -121,18 +121,21 @@
 
         """
 
-    def indexes():
-        """
-
-        Returns a sequence of names that correspond to indexes.
-
-        """
-
     def index_objects():
         """
-
+        
         Returns a sequence of actual index objects.
-
+        
+        NOTE: This returns unwrapped indexes! You should probably use
+        getIndexObjects instead. Some indexes expect to be wrapped.
+        
+        """
+        
+    def getIndexObjects():
+        """
+        
+        Returns a list of acquisition wrapped index objects
+        
         """
 
     def searchResults(REQUEST=None, **kw):