Changeset 13082 for main/waeup.kofa/trunk/docs/source/userdocs/applicants

Timestamp:

20 Jun 2015, 15:35:23 (9 years ago)

Author:

Henrik Bettermann

Message:

More docs.

File:

• main/waeup.kofa/trunk/docs/source/userdocs/applicants/interfaces.rst (modified) (2 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/applicants/interfaces.rst

@@ -36 +36 @@
 
 The applicants root contains the various `ApplicantsContainer`
-objects. It's worth to present their interface here.
+objects.
 
 .. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
@@ -69 +69 @@
 <certificate>`.
 
-Applicant :sup:`in progress`
-============================
+Applicant
+=========
+
+As already mentioned, the applicant objects contains all information
+necessary for application, except for the payment ticket data. The
+base set of the applicant's 'external behaviour' is described by the
+following interface.
 
 `IApplicantBaseData`
 --------------------
 
+.. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
+   :pyobject: IApplicantBaseData
 
+As usual, the interface lists attributes first. Except for the
+last two attributes (`password` and `application_date`), they are all
+read-only property attributes, i.e. attributes with a getter method
+only. These properties are computed dynamically and can't be set.
+
+In the base package `IApplicant` is derived from `IApplicantBaseData`
+and only two methods are added:
+
+`IApplicant`
+------------
+
+.. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
+   :pyobject: IApplicant
+
+In custom packages we have furthermore interfaces for undergraduate
+and postgraduate students, both derived from `IApplicantBaseData`.
+
+Then there is a customized interface `ISpecialApplicant` for former
+students or students who are not users of the portal but have to pay
+supplementary fees. This reduced interface is used in browser
+components only, it does not instantiate applicant objects.
+
+Applicant Payment
+=================
+
+`IApplicantOnlinePayment`
+-------------------------
+
+Instances of this interface are called applicant payment tickets.
+They contain the data which confirm that the applicant has paid the
+application fee.
+`waeup.kofa.students.interfaces.IStudentOnlinePayment` inherits from
+`waeup.kofa.payments.interfaces.IOnlinePayment` and promises three
+additional methods which process the applicant data after successful
+or approved payment.
+
+.. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
+   :pyobject: IApplicantOnlinePayment