applicants.interfaces - Applicants Related Interfaces

Interfaces of the university application package.

class waeup.kofa.applicants.interfaces.AppCatCertificateSource

Bases: waeup.kofa.university.vocabularies.CertificateSource

An application certificate source delivers all certificates which belong to a certain application_category.

This source is meant to be used with Applicants.

The application category must match the application category of the context parent, normally an applicants container.

__doc__ = 'An application certificate source delivers all certificates\n which belong to a certain application_category.\n\n This source is meant to be used with Applicants.\n\n The application category must match the application category of\n the context parent, normally an applicants container.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

contains(context, value)

getTitle(context, value)

getValues(context)

class waeup.kofa.applicants.interfaces.ApplicantBalancePaymentCategorySource

Bases: waeup.kofa.interfaces.ContextualDictSourceFactoryBase

A source that delivers all selectable items of balance payments.

DICT_NAME = 'APPLICANT_BALANCE_PAYMENT_CATEGORIES'

name of dict to deliver from kofa utils.

__doc__ = 'A source that delivers all selectable items of balance payments.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

class waeup.kofa.applicants.interfaces.ApplicantEmailSource(context)

Bases: waeup.kofa.students.vocabularies.RegNumberSource

A source that accepts any email address if not used already by a different applicant. This source is not used in the base package.

__doc__ = 'A source that accepts any email address if not used already by a\n different applicant. This source is not used in the base package.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

cat_name = 'applicants_catalog'

comp_field = 'applicant_id'

field_name = 'email'

validation_error

alias of EmailInSource

class waeup.kofa.applicants.interfaces.ApplicantRegNumberSource(context)

Bases: waeup.kofa.students.vocabularies.RegNumberSource

A source that accepts any reg number if not used already by a different applicant.

__doc__ = 'A source that accepts any reg number if not used already by a\n different applicant.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

cat_name = 'applicants_catalog'

comp_field = 'applicant_id'

field_name = 'reg_number'

validation_error

alias of RegNumInSource

class waeup.kofa.applicants.interfaces.ApplicationTypeSource

Bases: zc.sourcefactory.contextual.BasicContextualSourceFactory

An application type source delivers screening types defined in the portal.

__doc__ = 'An application type source delivers screening types defined in the\n portal.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

getTitle(context, value)

getToken(context, value)

getValues(context)

exception waeup.kofa.applicants.interfaces.EmailInSource

Bases: zope.schema._bootstrapinterfaces.ValidationError

An application record with email address exists.

__doc__ = 'An application record with email address exists.\n '

__module__ = 'waeup.kofa.applicants.interfaces'

interface waeup.kofa.applicants.interfaces.IApplicant

Extends: waeup.kofa.applicants.interfaces.IApplicantBaseData, waeup.kofa.applicants.interfaces.IApplicantTestData

This is basically the applicant base data. Here we repeat the fields from base data if we have to set the required attribute to True (which is the default).

createStudent(view, graduated)

Create a student object from applicant data and copy passport image and application slip. If graduated is set True, a graduated student is being created. This method is supposed to be used for transcript applicants. It is tested but not used in the base package.

writeLogMessage(view, comment)

Add an INFO message to applicants.log.

interface waeup.kofa.applicants.interfaces.IApplicantBalancePayment

Extends: waeup.kofa.interfaces.IKofaObject

An interface for adding balances.

p_category

Payment Category

balance_amount

Balance Amount

interface waeup.kofa.applicants.interfaces.IApplicantBaseData

Extends: waeup.kofa.interfaces.IKofaObject

This is a base interface of an applicant with no field required. For use with processors, forms, etc., please use one of the derived interfaces below, which set more fields to required state, depending on use-case.

application_number

The key under which the record is stored

course_admitted

Admitted Course of Study

sex

Gender

course1

1st Choice Course of Study

suspended

Account suspended

special

True if special application

reg_number

Registration Number

container_code

Code of the parent container plus additional information if record is used or not

student_id

Student Id

applicant_id

Applicant Id

course2

2nd Choice Course of Study

state

Application state of an applicant

date_of_birth

Date of Birth

email

Email Address

display_fullname

The fullname of an applicant

notice

Notice

translated_state

Real name of the application state

special_application

Special Application

firstname

First Name

middlename

Middle Name

lastname

Last Name (Surname)

phone

Phone

password

Encrypted password of an applicant

application_date

UTC datetime of submission, used for export only

locked

Form locked

payments

List of payment objects stored in the applicant container

history

Object history, a list of messages

interface waeup.kofa.applicants.interfaces.IApplicantEdit

Extends: waeup.kofa.applicants.interfaces.IApplicant

This is an applicant interface for editing.

Here we can repeat the fields from base data and set the required and readonly attributes to True to further restrict the data access. Or we can allow only certain certificates to be selected by choosing the appropriate source.

We cannot omit fields here. This has to be done in the respective form page.

course_admitted

Admitted Course of Study

notice

Notice

email

Email Address

course2

2nd Choice Course of Study

course1

1st Choice Course of Study

interface waeup.kofa.applicants.interfaces.IApplicantOnlinePayment

Extends: waeup.kofa.payments.interfaces.IOnlinePayment

An applicant payment via payment gateways.

doAfterApplicantPayment()

Process applicant after payment was made.

approveApplicantPayment()

Approve payment and process applicant.

doAfterApplicantPaymentApproval()

Process applicant after payment was approved.

interface waeup.kofa.applicants.interfaces.IApplicantRefereeReport

Extends: waeup.kofa.interfaces.IKofaObject

A referee report.

name

Referee Name

phone

Referee Phone

email_pref

Preferred Email Address

creation_date

Report Creation Date

email

Referee email address taken from the mandate

r_id

Report identifier

report

Report

interface waeup.kofa.applicants.interfaces.IApplicantRegisterUpdate

Extends: waeup.kofa.applicants.interfaces.IApplicant

This is a representation of an applicant for first-time registration. This interface is used when applicants use the registration page to update their records.

reg_number

Registration Number

lastname

Last Name (Surname)

email

Email Address

interface waeup.kofa.applicants.interfaces.IApplicantTestData

Extends: waeup.kofa.interfaces.IKofaObject

This interface is for demonstration and testing only. It can be omitted in customized versions of Kofa.

school_grades

School Grades

referees

Referees

interface waeup.kofa.applicants.interfaces.IApplicantUpdateByRegNo

Extends: waeup.kofa.applicants.interfaces.IApplicant

Skip regular reg_number validation if reg_number is used for finding the applicant object.

reg_number

Registration Number

interface waeup.kofa.applicants.interfaces.IApplicantsContainer

Extends: waeup.kofa.interfaces.IKofaObject

An applicants container contains applicants.

code

Code

application_fee

Application Fee

application_category

Category for the grouping of certificates

traverse(name)

Deliver appropriate containers.

send_email

Send email after submission

prefix

Application Target

year

Year of Entrance

addApplicant(applicant)

Add an applicant.

description

Human readable description in HTML format

startdate

Application Start Date

Example: 2011-12-01 18:30:00+01:00

statistics

Applicant counts

description_dict

Language translation dictionary with values in HTML format

title

Title

hidden

Hide container

local_roles

List of local role names

application_slip_notice

Human readable notice on application slip in HTML format

strict_deadline

Forbid additions after deadline (enddate)

expired

True if application has started but not ended

picture_editable

False if applicants are not allowed to edit uploaded pictures.

writeLogMessage(view, comment)

Add an INFO message to applicants.log.

enddate

Application Closing Date

Example: 2011-12-31 23:59:59+01:00

with_picture

With passport picture

mode

Application Mode

interface waeup.kofa.applicants.interfaces.IApplicantsContainerAdd

Extends: waeup.kofa.applicants.interfaces.IApplicantsContainer

An applicants container contains university applicants.

prefix

Application Target

container_number

Container Number

If set, this number will be added to the container prefix (e.g. app3). If not set, the year of entrance will be used (e.g. app2019).

year

Year of Entrance

interface waeup.kofa.applicants.interfaces.IApplicantsRoot

Extends: waeup.kofa.interfaces.IKofaObject, grokcore.content.interfaces.IContainer

A container for applicants containers.

logger_filename

Name of the logger file

description_dict

Language translation dictionary with values in HTML format

logger_name

Name of the logger

local_roles

List of local role names

description

Human readable description in HTML format

interface waeup.kofa.applicants.interfaces.IApplicantsUtils

A collection of methods which are subject to customization.

APP_TYPES_DICT

dict of application types

setPaymentDetails(container, payment)

Set the payment data of an applicant.

getApplicantsStatistics(container)

Count applicants in containers.

getCertTitle(context, value)

Compose the titles in AppCatCertificateSource.

isPictureEditable(container)

False if applicants are not allowed to edit uploaded pictures.

filterCertificates(context, resultset)

Filter and sort certificates for AppCatCertificateSource.

interface waeup.kofa.applicants.interfaces.ISpecialApplicant

Extends: waeup.kofa.interfaces.IKofaObject

This reduced interface is for former students or students who are not users of the portal but have to pay supplementary fees. This interface is used in browser components only. Thus we can’t add fields here to the regular IApplicant interface here. We can only ‘customize’ fields.

reg_number

Identification Number

locked

Form locked

special_application

Special Application

firstname

First Name

middlename

Middle Name

lastname

Last Name (Surname)

applicant_id

Applicant Id

email

Email Address

phone

Phone

date_of_birth

Date of Birth

suspended

Account suspended

exception waeup.kofa.applicants.interfaces.RegNumInSource

Bases: zope.schema._bootstrapinterfaces.ValidationError

Registration number exists already

__doc__ = 'Registration number exists already\n '

__module__ = 'waeup.kofa.applicants.interfaces'

waeup.kofa.applicants.interfaces.contextual_email_source(context)

waeup.kofa.applicants.interfaces.contextual_reg_num_source(context)

waeup.kofa.applicants.interfaces.year_range()