| 1 | .. _applicants_interfaces: |
|---|
| 2 | |
|---|
| 3 | Parent Containers |
|---|
| 4 | ================= |
|---|
| 5 | |
|---|
| 6 | `IApplicantsRoot` |
|---|
| 7 | ----------------- |
|---|
| 8 | |
|---|
| 9 | Much like ``academics`` and ``students``, also ``applicants`` is a |
|---|
| 10 | unique container (of type `ApplicantsRoot`) located in the |
|---|
| 11 | `IUniversity` instance. It is the counterpart of the students |
|---|
| 12 | (section) container. The root container has a `description` schema |
|---|
| 13 | field attribute which contains human readable, multi-lingual |
|---|
| 14 | information about the application procedure in HTML format. This |
|---|
| 15 | description can be seen by anonymous users, when they enter the |
|---|
| 16 | applicants section (by pressing the 'Application' tab in the |
|---|
| 17 | navigation bar). |
|---|
| 18 | |
|---|
| 19 | .. _multilingual: |
|---|
| 20 | |
|---|
| 21 | .. note:: |
|---|
| 22 | |
|---|
| 23 | A multi-lingual or localized text is a sequence of human-readable |
|---|
| 24 | text strings in different languages. The languages must be separated |
|---|
| 25 | by ``>>xy<<``, whereas ``xy`` is the language code. Text parts |
|---|
| 26 | without correct leading language separator - usually the first part |
|---|
| 27 | has no language descriptor - are interpreted as texts in the |
|---|
| 28 | portal's language. The text strings can be either HTML or |
|---|
| 29 | reStructuredText (REST) formatted. |
|---|
| 30 | |
|---|
| 31 | .. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py |
|---|
| 32 | :pyobject: IApplicantsRoot |
|---|
| 33 | |
|---|
| 34 | `IApplicantsContainer` |
|---|
| 35 | ---------------------- |
|---|
| 36 | |
|---|
| 37 | The applicants root contains the various `ApplicantsContainer` |
|---|
| 38 | objects. It's worth to present their interface here. |
|---|
| 39 | |
|---|
| 40 | .. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py |
|---|
| 41 | :pyobject: IApplicantsContainer |
|---|
| 42 | |
|---|
| 43 | `statistics` and `expired` are read-only property attributes. |
|---|
| 44 | `description_dict` contains the same information as the |
|---|
| 45 | `description`, but the sequence of language translations has been |
|---|
| 46 | split up and copied into a dictionary for faster processing. In the |
|---|
| 47 | base package, `local_roles` is an empty list which means, no local |
|---|
| 48 | role can be assigned at applicants container level. |
|---|
| 49 | |
|---|
| 50 | Crucial for application are the `prefix`, `year`, `mode` and |
|---|
| 51 | `application_category` schema fields. The `prefix` atribute can only |
|---|
| 52 | be set when adding a container. It cannot be edited afterwards. The |
|---|
| 53 | attribute determines the application type and automatically sets the |
|---|
| 54 | prefix of the container code and of all applicant ids inside the |
|---|
| 55 | container. The prefix is supplied by the `ApplicationTypeSource` |
|---|
| 56 | (see `application types of base package |
|---|
| 57 | <https://kofa-demo.waeup.org/sources#collapseAppTypes>`_). It is |
|---|
| 58 | followed by the year of entry. Thus, the identifiers of applicants |
|---|
| 59 | containers and the applicants inside the containers start with the |
|---|
| 60 | same prefix-year sequence. Example: ``app2015`` which translates |
|---|
| 61 | into 'General Studies 2015/2016'. Consequently, **applicants cannot |
|---|
| 62 | be moved from one container to another.** |
|---|
| 63 | |
|---|
| 64 | The application category is supplied by the |
|---|
| 65 | `ApplicationCategorySource` (see `application categories of base |
|---|
| 66 | package <https://kofa-demo.waeup.org/sources#collapseAppCats>`_) and |
|---|
| 67 | refers to a group of study programmes (certificates) which the |
|---|
| 68 | applicant can apply for, read also chapter on :ref:`Certificates |
|---|
| 69 | <certificate>`. |
|---|
| 70 | |
|---|
| 71 | Applicant :sup:`in progress` |
|---|
| 72 | ============================ |
|---|
| 73 | |
|---|
| 74 | `IApplicantBaseData` |
|---|
| 75 | -------------------- |
|---|
| 76 | |
|---|
| 77 | |
|---|
