Changeset 12861 for main/waeup.kofa/trunk/src/waeup/kofa/applicants

Timestamp:

17 Apr 2015, 14:43:42 (10 years ago)

Author:

Henrik Bettermann

Message:

More documentation.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/applicants/export.py (modified) (4 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/applicants/export.py

@@ -64 +64 @@
 
 class ApplicantExporter(grok.GlobalUtility, ExporterBase):
-    """The Applicant Exporter exports all application records (= applicants)
+    """The Applicant Exporter exports application records (= applicants)
     stored in the database. In contrast to the exporters in the academics
     section this exporter does not iterate over the items of containers
-    but searches the Applicants Catalog instead.
+    but searches the :class:`ApplicantsCatalog` instead.
+
+    The exporter exports all applicants if started in the Data Center
+    which means in the context of the `DataCenter` object. The exporter can also 
+    be started 'locally' which means in the context of an `ApplicantsContainer`
+    container. Then the :meth:`export_filtered()` instead of the 
+    :meth:`export_all()` method is applied which searches for applicants
+    in the respective container.
     """
     grok.implements(ICSVExporter)
@@ -98 +105 @@
     def export(self, applicants, filepath=None):
         """Export `applicants`, an iterable, as CSV file.
-
         If `filepath` is ``None``, a raw string with CSV data is returned.
         """
@@ -107 +113 @@
 
     def export_all(self, site, filepath=None):
-        """Export applicants into filepath as CSV data.
-
+        """Export all applicants into filepath as CSV data.
         If `filepath` is ``None``, a raw string with CSV data is returned.
         """
@@ -122 +127 @@
 
     def export_filtered(self, site, filepath=None, **kw):
-        """Export applicants in container.
-
+        """Export filtered applicants in container denoted by keywords (`kw`).
         If `filepath` is ``None``, a raw string with CSV data should
         be returned.