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

.. _applicants_interfaces:

Parent Containers
=================

`IApplicantsRoot`
-----------------

Much like ``academics`` and ``students``, also ``applicants`` is a
unique container (of type `ApplicantsRoot`) located in the
`IUniversity` instance. It is the counterpart of the students
(section) container. The root container has a `description` schema
field attribute which contains human readable, multi-lingual
information about the application procedure in HTML format. This
description can be seen by anonymous users, when they enter the
applicants section (by pressing the 'Application' tab in the
navigation bar).

.. _multilingual:

.. note::

  A multi-lingual or localized text is a sequence of human-readable
  text strings in different languages. The languages must be separated
  by ``>>xy<<``, whereas ``xy`` is the language code. Text parts
  without correct leading language separator - usually the first part
  has no language descriptor - are interpreted as texts in the
  portal's language. The text strings can be either HTML or
  reStructuredText (REST) formatted.

.. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
   :pyobject: IApplicantsRoot

`IApplicantsContainer`
----------------------

The applicants root contains the various `ApplicantsContainer`
objects. It's worth to present their interface here.

.. literalinclude:: ../../../../src/waeup/kofa/applicants/interfaces.py
   :pyobject: IApplicantsContainer

`statistics` and `expired` are read-only property attributes.
`description_dict` contains the same information as the
`description`, but the sequence of language translations has been
split up and copied into a dictionary for faster processing. In the
base package, `local_roles` is an empty list which means, no local
role can be assigned at applicants container level.

Crucial for application are the `prefix`, `year`, `mode` and
`application_category` schema fields. The `prefix` atribute can only
be set when adding a container. It cannot be edited afterwards. The
attribute determines the application type and automatically sets the
prefix of the container code and of all applicant ids inside the
container. The prefix is supplied by the `ApplicationTypeSource`
(see `application types of base package
<https://kofa-demo.waeup.org/sources#collapseAppTypes>`_). It is
followed by the year of entry. Thus, the identifiers of applicants
containers and the applicants inside the containers start with the
same prefix-year sequence. Example: ``app2015`` which translates
into 'General Studies 2015/2016'. Consequently, **applicants cannot
be moved from one container to another.**

The application category is supplied by the
`ApplicationCategorySource` (see `application categories of base
package <https://kofa-demo.waeup.org/sources#collapseAppCats>`_) and
refers to a group of study programmes (certificates) which the
applicant can apply for, read also chapter on :ref:`Certificates
<certificate>`.

Applicant :sup:`in progress`
============================

`IApplicantBaseData`
--------------------