Changeset 5825

Timestamp:

9 Mar 2011, 14:20:54 (14 years ago)

Author:

uli

Message:

Add docstring to tell what's going on when getting a list of
applicants container providers.

File:

• main/waeup.sirp/trunk/src/waeup/sirp/applicants/browser.py (modified) (1 diff)

main/waeup.sirp/trunk/src/waeup/sirp/applicants/browser.py

@@ -113 +113 @@
         
     def getContainerProviders(self):
-
+        """Get a list of applicants container providers.
+
+        Applicants container providers are named utilities that help
+        to create applicants containers of different types
+        (JAMB-based, non-JAMB-based, etc.).
+
+        The list returned contains dicts::
+
+          {'name': <utility_name>,
+           'provider': <provider instance>}
+
+        where `utility_name` is the name under which the respective
+        provider utility is registered and `provider` is the real
+        provider instance.
+
+        The `utility_name` can be used to lookup the utility anew (for
+        instance after submitting a form) and the `provider` instance
+        can be used to create new instances of the respective
+        applicants container type.
+        """
         providers = getAllUtilitiesRegisteredFor(IApplicantContainerProvider)
         result = [