Changeset 4322 for waeup/branches

Timestamp:

20 Jun 2009, 19:45:45 (15 years ago)

Author:

uli

Message:

Add tests for certificate courses.

File:

• waeup/branches/ulif-rewrite/src/waeup/university/certificate.txt (modified) (5 diffs)

waeup/branches/ulif-rewrite/src/waeup/university/certificate.txt

@@ -17 +17 @@
 =======================================
 
+
 :class:`Certificate`
 --------------------
@@ -40 +41 @@
      >>> verifyObject(ICertificate, mycertificate)
      True
+
+   Beside the attributes, certificates are containers for
+   certificate-courses (see :class:`CertificateCourse`). Each
+   certificate course can be accessed by the code of the course it wraps.
 
    .. attribute:: title
@@ -156 +161 @@
           as source state (is: 'checked')
 
+   .. method:: addCourseRef(course[, level=100,[ core_or_elective=True]])
+
+      Add a reference to a course. A course is an object implementing
+      :class:`waeup.interfaces.ICourse`.
+
+      Please don't be confused by the term 'reference'. This just
+      means an ordinary :class:`waeup.university.course.Course` object
+      in almost all cases. As this object will normaly be one stored
+      in a department, the course here will simply become a reference
+      to the 'real' one in the department container.
+
+   .. method:: delCourseRef(code)
+
+      Remove a course from a certificate.
+
+      The course must be given by its code number.
+
+:class:`CertificateCourse`
+--------------------------
+
+.. class:: CertificateCourse(course[, level=100[, core_or_elective=True]])
+
+   Create a certificate course.
+
+   A certificate-course is a course (:class:`Course`) which is part of
+   a certificate. Normally, certificate-courses are held in
+   certificates and refer to an existing :class:`Course` instance held
+   elsewhere.
+
+   A certificate can require several courses and one
+   course can be required by several certificates.
+
+   .. attribute:: course
+
+      An instance of :class:`ICourse`.
+
+   .. attribute:: level
+
+      An integer telling the level to which this course applies.
+
+   .. attribute:: core_or_elective
+
+      A bool stating whether this course is required or optional to
+      get the certificate.
+
+
 
 Utilities
@@ -180 +231 @@
 ========
 
+Certificates
+------------
 
 We can create certificates:
@@ -197 +250 @@
     <waeup.university.certificate.Certificate object at 0x...>
 
+CertificateCourses
+------------------
+
+:class:`CertificateCourse` instances comply with the
+:class:`ICertificateCourse` interface:
+
+    >>> from waeup.interfaces import ICertificateCourse
+    >>> from waeup.university.certificate import CertificateCourse
+    >>> mycertcourse = CertificateCourse(None, 200, False)
+    >>> ICertificateCourse.providedBy(mycertcourse)
+    True
+
+    >>> from zope.interface.verify import verifyObject
+    >>> verifyObject(ICertificateCourse, mycertcourse)
+    True
+