Changeset 5676 for main/waeup.sirp/trunk/src/waeup/sirp/applicants/root.py

Timestamp:

25 Jan 2011, 13:21:00 (14 years ago)

Author:

Henrik Bettermann

Message:

Rename applications to applicants.

Location:

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

Files:

• . (moved) (moved from main/waeup.sirp/trunk/src/waeup/sirp/applications)
• root.py (modified) (4 diffs)

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

@@ -21 +21 @@
 ##
 """
-The root for applications.
+The root for applicants.
 """
 import grok
 from waeup.sirp.interfaces import IWAeUPSIRPPluggable
-from waeup.sirp.applications.interfaces import IApplicationsRoot
+from waeup.sirp.applicants.interfaces import IApplicantsRoot
 
-class ApplicationsRoot(grok.Container):
-    """The root of student applications-related components.
+class ApplicantsRoot(grok.Container):
+    """The root of applicants-related components. It contains primarily 
+    containers for applicants.
     """
-    grok.implements(IApplicationsRoot)
+    grok.implements(IApplicantsRoot)
 
-    def addApplicationContainer(self, container, name=None):
-        """Add an application container.
+    def addApplicantsContainer(self, container, name=None):
+        """Add an applicants container.
 
-        Adds an application container that implements `interface`
+        Adds an applicants container that implements `interface`
         under the name `name`.
 
         `container`
           the container instance to be added. Should
-          implement :class:`IApplicationContainer`.
+          implement :class:`IApplicantsContainer`.
 
         `name`
           the name under which the container will be accessible. We
           usually use names like ``pume_2011`` to indicate, that the
-          new container will contain student applications for a
+          new container will contain student applicants for a
           certain screening type (``pume``) and of the year 2011.
 
@@ -52 +53 @@
         return
 
-class ApplicationsPlugin(grok.GlobalUtility):
-    """A WAeUPSIRPPlugin that creates an applications root in portal.
+class ApplicantsPlugin(grok.GlobalUtility):
+    """A WAeUPSIRPPlugin that creates an applicants root in portal.
 
     This plugin should be called by a typical
@@ -62 +63 @@
     Implements :class:`waeup.sirp.interfaces.IWAeUPSIRPPluggable`
     """
-    grok.name('applications')
+    grok.name('applicants')
     grok.implements(IWAeUPSIRPPluggable)
-    log_prefix = 'ApplicationsPlugin'
+    log_prefix = 'ApplicantsPlugin'
 
     def setup(self, site, name, logger):
-        """Create a new :class:`ApplicationsRoot` instance in `site`.
+        """Create a new :class:`ApplicantsRoot` instance in `site`.
         """
-        site['applications'] = ApplicationsRoot()
+        site['applicants'] = ApplicantsRoot()
         logger.info(
-            '%s: Installed applications root.' % (self.log_prefix,)
+            '%s: Installed applicants root.' % (self.log_prefix,)
             )
         return
 
     def update(self, site, name, logger):
-        """Update site wide ``applications`` root.
+        """Update site wide ``applicants`` root.
 
-        If the site already contains a suitable ``applications`` root,
+        If the site already contains a suitable ``applicants`` root,
         leave it that way. If not create one and delete the old one if
         appropriate.
         """
-        app_folder = site.get('applications', None)
+        app_folder = site.get('applicants', None)
         site_name = getattr(site, '__name__', 'Unnamed Site?')
-        if IApplicationsRoot.providedBy(app_folder):
-            # Applications up to date. Return.
+        if IApplicantsRoot.providedBy(app_folder):
+            # Applicants up to date. Return.
             logger.info(
                 '%s: Updating site at %s: Nothing to do.' % (
@@ -92 +93 @@
             return
         elif app_folder is not None:
-            # Applications need update. Remove old instance.
+            # Applicants need update. Remove old instance.
             logger.warn(
-                '%s: Outdated applications folder detected at site %s.'
+                '%s: Outdated applicants folder detected at site %s.'
                 'Removing it.' % (self.log_prefix, site_name)
                     )
-            del site['applications']
-        # Add new applications.
+            del site['applicants']
+        # Add new applicants.
         logger.info(
             '%s: Updating site at %s. Installing '
-            'applications.' % (self.log_prefix, site_name,)
+            'applicants.' % (self.log_prefix, site_name,)
             )
         self.setup(site, name, logger)