Changeset 9766 for main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py

Timestamp:

5 Dec 2012, 06:01:47 (12 years ago)

Author:

uli

Message:

Define interfaces for more general object queries and fix typo.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py

@@ -303 +303 @@
         """
 
-    def export_all(site, filapath=None):
+    def export_all(site, filepath=None):
         """Export all items in `site` as CSV file.
 
@@ -1224 +1224 @@
         """Return the currently used global or site-wide IExportContainer.
         """
+
+class IFilteredQuery(IKofaObject):
+    """A query for objects.
+    """
+
+    defaults = schema.Dict(
+        title = u'Default Parameters',
+        required = True,
+        )
+
+    def __init__(**parameters):
+        """Instantiate a filtered query by passing in parameters.
+        """
+
+    def query():
+        """Get an iterable of objects denoted by the set parameters.
+
+        The search should be applied to objects inside current
+        site. It's the caller's duty to set the correct site before.
+
+        Result can be any iterable like a catalog result set, a list,
+        or similar.
+        """
+
+class IFilteredCatalogQuery(IFilteredQuery):
+    """A catalog-based query for objects.
+    """
+
+    cat_name = schema.TextLine(
+        title = u'Registered name of the catalog to search.',
+        required = True,
+        )
+
+    def query_catalog(catalog):
+        """Query catalog with the parameters passed to constructor.
+        """