source: main/waeup.fceokene/trunk/src/waeup/fceokene/applicants/interfaces.py @ 13965

Last change on this file since 13965 was 13884, checked in by Henrik Bettermann, 9 years ago

course1 must not be required when importing data.
  • Property svn:keywords set to Id
File size: 13.7 KB
Line 
1## $Id: interfaces.py 13884 2016-06-06 14:14:31Z henrik $
2##
3## Copyright (C) 2011 Uli Fouquet & Henrik Bettermann
4## This program is free software; you can redistribute it and/or modify
5## it under the terms of the GNU General Public License as published by
6## the Free Software Foundation; either version 2 of the License, or
7## (at your option) any later version.
8##
9## This program is distributed in the hope that it will be useful,
10## but WITHOUT ANY WARRANTY; without even the implied warranty of
11## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12## GNU General Public License for more details.
13##
14## You should have received a copy of the GNU General Public License
15## along with this program; if not, write to the Free Software
16## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17##
18"""Customized interfaces of the university application package.
19"""
20
21from zope import schema
22from zc.sourcefactory.basic import BasicSourceFactory
23from waeup.kofa.applicants.interfaces import (
24    IApplicantBaseData,
25    AppCatCertificateSource, CertificateSource)
26from waeup.kofa.schoolgrades import ResultEntryField
27from waeup.kofa.interfaces import (
28    SimpleKofaVocabulary, academic_sessions_vocab, validate_email,
29    IKofaObject)
30from waeup.kofa.schema import FormattedDate, TextLineChoice, PhoneNumber
31from waeup.kofa.schoolgrades import ResultEntryField
32from waeup.kofa.students.vocabularies import nats_vocab, GenderSource
33from waeup.kofa.applicants.interfaces import contextual_reg_num_source
34from kofacustom.nigeria.applicants.interfaces import (
35    LGASource, high_qual, high_grade, exam_types,
36    INigeriaUGApplicant, INigeriaPGApplicant,
37    INigeriaApplicantOnlinePayment,
38    INigeriaUGApplicantEdit,
39    INigeriaApplicantUpdateByRegNo,
40    IPUTMEApplicantEdit,
41    OMIT_DISPLAY_FIELDS
42    )
43from waeup.fceokene.applicants.schools import SCHOOLS
44from waeup.fceokene.interfaces import MessageFactory as _
45
46BEC_OMIT_DISPLAY_FIELDS = OMIT_DISPLAY_FIELDS
47BEC_OMIT_PDF_FIELDS = BEC_OMIT_DISPLAY_FIELDS + ('phone',)
48BEC_OMIT_MANAGE_FIELDS = ('special_application',)
49BEC_OMIT_EDIT_FIELDS = BEC_OMIT_MANAGE_FIELDS + OMIT_DISPLAY_FIELDS + (
50    'student_id', 'notice',
51    'screening_score',
52    'screening_venue',
53    'screening_date',
54    #'jamb_subjects',
55    #'jamb_score',
56    'aggregate')
57
58class SchoolSource(BasicSourceFactory):
59    """A source that delivers all kinds of registrations.
60    """
61    def getValues(self):
62        sorted_items = sorted(SCHOOLS.items(),
63                              key=lambda element: element[0])
64        return [item[0] for item in sorted_items]
65
66    def getTitle(self, value):
67        return u"%s: %s -- %s" % (
68            SCHOOLS[value][0],
69            SCHOOLS[value][1],
70            SCHOOLS[value][2],)
71
72class ITPURegistration(IKofaObject):
73    """A TPU registrant.
74    """
75
76    suspended = schema.Bool(
77        title = _(u'Account suspended'),
78        default = False,
79        required = False,
80        )
81
82    locked = schema.Bool(
83        title = _(u'Form locked'),
84        default = False,
85        required = False,
86        )
87
88    applicant_id = schema.TextLine(
89        title = _(u'Applicant Id'),
90        required = False,
91        readonly = False,
92        )
93
94    reg_number = schema.TextLine(
95        title = _(u'Registration Number'),
96        required = False,
97        readonly = False,
98        )
99
100    matric_number = schema.TextLine(
101        title = _(u'Matriculation Number'),
102        required = False,
103        readonly = False,
104        )
105
106    firstname = schema.TextLine(
107        title = _(u'First Name'),
108        required = True,
109        )
110
111    middlename = schema.TextLine(
112        title = _(u'Middle Name'),
113        required = False,
114        )
115
116    lastname = schema.TextLine(
117        title = _(u'Last Name (Surname)'),
118        required = True,
119        )
120
121    email = schema.ASCIILine(
122        title = _(u'Email Address'),
123        required = True,
124        constraint=validate_email,
125        )
126
127    phone = PhoneNumber(
128        title = _(u'Phone'),
129        description = u'',
130        required = False,
131        )
132
133    perm_address = schema.Text(
134        title = _(u'Home Address'),
135        required = False,
136        readonly = False,
137        )
138
139    lga = schema.Choice(
140        source = LGASource(),
141        title = _(u'State/LGA'),
142        required = False,
143        )
144
145    subj_comb = schema.TextLine(
146        title = _(u'Subject Combination'),
147        required = False,
148        readonly = False,
149        )
150
151    school1 = schema.Choice(
152        title = _(u'1st Choice TPZ and School'),
153        source = SchoolSource(),
154        required = False,
155        )
156
157    school2 = schema.Choice(
158        title = _(u'2nd Choice TPZ and School'),
159        source = SchoolSource(),
160        required = False,
161        )
162
163    school3 = schema.Choice(
164        title = _(u'3rd Choice TPZ and School'),
165        source = SchoolSource(),
166        required = False,
167        )
168
169class ICustomUGApplicant(INigeriaUGApplicant):
170    """An undergraduate applicant.
171
172    This interface defines the least common multiple of all fields
173    in ug application forms. In customized forms, fields can be excluded by
174    adding them to the OMIT* tuples.
175    """
176
177    nationality = schema.Choice(
178        source = nats_vocab,
179        title = _(u'Nationality'),
180        required = True,
181        )
182    lga = schema.Choice(
183        source = LGASource(),
184        title = _(u'State/LGA (Nigerians only)'),
185        required = False,
186        )
187    #perm_address = schema.Text(
188    #    title = _(u'Permanent Address'),
189    #    required = False,
190    #    )
191    course1 = schema.Choice(
192        title = _(u'1st Choice Course of Study'),
193        source = AppCatCertificateSource(),
194        required = False,
195        )
196    course2 = schema.Choice(
197        title = _(u'2nd Choice Course of Study'),
198        source = AppCatCertificateSource(),
199        required = False,
200        )
201    olevel_type = schema.Choice(
202        title = _(u'1st Qualification Obtained'),
203        required = False,
204        readonly = False,
205        vocabulary = exam_types,
206        )
207    olevel_school = schema.TextLine(
208        title = _(u'1st Institution Attended'),
209        required = False,
210        readonly = False,
211        )
212    olevel_exam_number = schema.TextLine(
213        title = _(u'1st Exam Number'),
214        required = False,
215        readonly = False,
216        )
217    olevel_exam_date = FormattedDate(
218        title = _(u'1st Exam Date'),
219        required = False,
220        readonly = False,
221        show_year = True,
222        )
223    olevel_results = schema.List(
224        title = _(u'1st Exam Results'),
225        value_type = ResultEntryField(),
226        required = False,
227        readonly = False,
228        default = [],
229        )
230    olevel_type2 = schema.Choice(
231        title = _(u'2nd Qualification Obtained'),
232        required = False,
233        readonly = False,
234        vocabulary = exam_types,
235        )
236    olevel_school2 = schema.TextLine(
237        title = _(u'2nd Institution Attended'),
238        required = False,
239        readonly = False,
240        )
241    olevel_exam_number2 = schema.TextLine(
242        title = _(u'2nd Exam Number'),
243        required = False,
244        readonly = False,
245        )
246    olevel_exam_date2 = FormattedDate(
247        title = _(u'2nd Exam Date'),
248        required = False,
249        readonly = False,
250        show_year = True,
251        )
252    olevel_results2 = schema.List(
253        title = _(u'2nd Exam Results'),
254        value_type = ResultEntryField(),
255        required = False,
256        readonly = False,
257        default = [],
258        )
259    hq_type = schema.Choice(
260        title = _(u'Qualification Obtained'),
261        required = False,
262        readonly = False,
263        vocabulary = high_qual,
264        )
265    hq_matric_no = schema.TextLine(
266        title = _(u'Former Matric Number'),
267        required = False,
268        readonly = False,
269        )
270    hq_degree = schema.Choice(
271        title = _(u'Class of Degree'),
272        required = False,
273        readonly = False,
274        vocabulary = high_grade,
275        )
276    hq_school = schema.TextLine(
277        title = _(u'Institution Attended'),
278        required = False,
279        readonly = False,
280        )
281    hq_session = schema.TextLine(
282        title = _(u'Years Attended'),
283        required = False,
284        readonly = False,
285        )
286    hq_disc = schema.TextLine(
287        title = _(u'Discipline'),
288        required = False,
289        readonly = False,
290        )
291    jamb_subjects = schema.Text(
292        title = _(u'Subjects and Scores'),
293        description = _(u'(one subject with score per line)'),
294        required = False,
295        )
296    jamb_score = schema.Int(
297        title = _(u'Total JAMB Score'),
298        required = False,
299        )
300    jamb_reg_number = schema.TextLine(
301        title = _(u'JAMB Registration Number'),
302        required = False,
303        )
304    notice = schema.Text(
305        title = _(u'Notice'),
306        required = False,
307        )
308    screening_venue = schema.TextLine(
309        title = _(u'Screening Venue'),
310        required = False,
311        )
312    screening_date = schema.TextLine(
313        title = _(u'Screening Date'),
314        required = False,
315        )
316    screening_score = schema.Int(
317        title = _(u'Screening Score (%)'),
318        required = False,
319        )
320    aggregate = schema.Int(
321        title = _(u'Aggregate Score (%)'),
322        description = _(u'(average of relative JAMB and PUTME scores)'),
323        required = False,
324        )
325    result_uploaded = schema.Bool(
326        title = _(u'Result uploaded'),
327        default = False,
328        )
329    student_id = schema.TextLine(
330        title = _(u'Student Id'),
331        required = False,
332        readonly = False,
333        )
334    course_admitted = schema.Choice(
335        title = _(u'Admitted Course of Study'),
336        source = CertificateSource(),
337        required = False,
338        )
339    locked = schema.Bool(
340        title = _(u'Form locked'),
341        default = False,
342        )
343
344
345class ICustomPGApplicant(INigeriaPGApplicant):
346    """A postgraduate applicant.
347
348    This interface defines the least common multiple of all fields
349    in pg application forms. In customized forms, fields can be excluded by
350    adding them to the PG_OMIT* tuples.
351    """
352
353class ICustomApplicant(ICustomUGApplicant, ICustomPGApplicant,
354    ITPURegistration):
355    """An interface for all types of applicants.
356
357    Attention: The ICustomPGApplicant field seetings will be overwritten
358    by ICustomPGApplicant field settings. If a field is defined
359    in both interfaces zope.schema validates only against the
360    constraints in ICustomUGApplicant. This does not affect the forms
361    since they are build on either ICustomUGApplicant or ICustomPGApplicant.
362    """
363
364    def writeLogMessage(view, comment):
365        """Adds an INFO message to the log file
366        """
367
368    def createStudent():
369        """Create a student object from applicatnt data
370        and copy applicant object.
371        """
372
373class ICustomUGApplicantEdit(ICustomUGApplicant):
374    """An undergraduate applicant interface for edit forms.
375
376    Here we can repeat the fields from base data and set the
377    `required` and `readonly` attributes to True to further restrict
378    the data access. Or we can allow only certain certificates to be
379    selected by choosing the appropriate source.
380
381    We cannot omit fields here. This has to be done in the
382    respective form page.
383    """
384
385
386    email = schema.ASCIILine(
387        title = _(u'Email Address'),
388        required = True,
389        constraint=validate_email,
390        )
391    date_of_birth = FormattedDate(
392        title = _(u'Date of Birth'),
393        required = True,
394        show_year = True,
395        )
396    jamb_reg_number = schema.TextLine(
397        title = _(u'JAMB Registration Number'),
398        required = True,
399        )
400    course1 = schema.Choice(
401        title = _(u'1st Choice Course of Study'),
402        source = AppCatCertificateSource(),
403        required = True,
404        )
405
406ICustomUGApplicantEdit[
407    'date_of_birth'].order =  ICustomUGApplicant['date_of_birth'].order
408ICustomUGApplicantEdit[
409    'email'].order =  ICustomUGApplicant['email'].order
410ICustomUGApplicantEdit[
411    'jamb_reg_number'].order =  ICustomUGApplicant['jamb_reg_number'].order
412ICustomUGApplicantEdit[
413    'course1'].order =  ICustomUGApplicant['course1'].order
414
415class ICustomPGApplicantEdit(ICustomPGApplicant):
416    """A postgraduate applicant interface for editing.
417
418    Here we can repeat the fields from base data and set the
419    `required` and `readonly` attributes to True to further restrict
420    the data access. Or we can allow only certain certificates to be
421    selected by choosing the appropriate source.
422
423    We cannot omit fields here. This has to be done in the
424    respective form page.
425    """
426
427    email = schema.ASCIILine(
428        title = _(u'Email Address'),
429        required = True,
430        constraint=validate_email,
431        )
432    date_of_birth = FormattedDate(
433        title = _(u'Date of Birth'),
434        required = True,
435        show_year = True,
436        )
437
438ICustomPGApplicantEdit[
439    'date_of_birth'].order =  ICustomPGApplicant['date_of_birth'].order
440ICustomPGApplicantEdit[
441    'email'].order =  ICustomPGApplicant['email'].order
442
443
444class ICustomApplicantOnlinePayment(INigeriaApplicantOnlinePayment):
445    """An applicant payment via payment gateways.
446
447    """
448
449class IPUTMEApplicantEdit(IPUTMEApplicantEdit):
450    """An undergraduate applicant interface for editing.
451
452    Here we can repeat the fields from base data and set the
453    `required` and `readonly` attributes to True to further restrict
454    the data access. Or we can allow only certain certificates to be
455    selected by choosing the appropriate source.
456
457    We cannot omit fields here. This has to be done in the
458    respective form page.
459    """
460
461class ICustomApplicantUpdateByRegNo(INigeriaApplicantUpdateByRegNo):
462    """Representation of an applicant.
463
464    Skip regular reg_number validation if reg_number is used for finding
465    the applicant object.
466    """
467
Note: See TracBrowser for help on using the repository browser.