Changeset 5676 for main/waeup.sirp/trunk/src/waeup/sirp/applicants/interfaces.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)
• interfaces.py (modified) (3 diffs)

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

@@ -20 +20 @@
 ## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ##
-"""Interfaces regarding student applications and related components.
+"""Interfaces regarding student applicants and related components.
 """
 from zope import schema
 from waeup.sirp.interfaces import IWAeUPObject
 
-class IApplicationsRoot(IWAeUPObject):
-    """A container for student application containers.
+class IApplicantsRoot(IWAeUPObject):
+    """A container for university applicants containers.
     """
-    def addApplicationContainer(container, name=None):
-        """Add an application container.
+    def addApplicantsContainer(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 university applicants for a
           certain screening type (``pume``) and of the year 2011.
         """
 
-class IApplicationContainer(IWAeUPObject):
-    """An application container contains student applications.
+class IApplicantsContainer(IWAeUPObject):
+    """An applicants container contains university applicants.
 
     """
@@ -54 +54 @@
 
     title = schema.TextLine(
-        title = u'Short description of the type of applications stored here.',
+        title = u'Short description of the type of applicants stored here.',
         required = True,
         default = u'Untitled',
@@ -84 +84 @@
 
     def archive(id=None):
-        """Create on-dist archive of applications stored in this term.
+        """Create on-dist archive of applicants stored in this term.
 
-        If id is `None`, all applications are archived.
+        If id is `None`, all applicants are archived.
 
         If id contains a single id string, only the respective
-        applications are archived.
+        applicants are archived.
 
         If id contains a list of id strings all of the respective
-        application types are saved to disk.
+        applicants types are saved to disk.
         """
 
     def clear(id=None, archive=True):
-        """Remove applications of type given by 'id'.
+        """Remove applicants of type given by 'id'.
 
-        Optionally archive the applications.
+        Optionally archive the applicants.
         
-        If id is `None`, all applications are archived.
+        If id is `None`, all applicants are archived.
 
         If id contains a single id string, only the respective
-        applications are archived.
+        applicants are archived.
 
         If id contains a list of id strings all of the respective
-        application types are saved to disk.
+        applicant types are saved to disk.
 
         If `archive` is ``False`` none of the archive-handling is done
-        and respective applications are simply removed from the
+        and respective applicants are simply removed from the
         database.
         """