source: main/waeup.kofa/trunk/src/waeup/kofa/students/interfaces.py @ 9106

Last change on this file since 9106 was 9035, checked in by Henrik Bettermann, 12 years ago

Some boolean values must not be required.

  • Property svn:keywords set to Id
File size: 15.0 KB
RevLine 
[7191]1## $Id: interfaces.py 9035 2012-07-21 09:39:06Z henrik $
[6621]2##
[7191]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##
[8409]18#from datetime import datetime
[7620]19from zope.component import getUtility
[7256]20from zope.interface import Attribute, Interface
[6621]21from zope import schema
[7620]22from zc.sourcefactory.contextual import BasicContextualSourceFactory
[7811]23from waeup.kofa.interfaces import (
[8409]24    IKofaObject, academic_sessions_vocab, validate_email, ICSVExporter)
[7811]25from waeup.kofa.interfaces import MessageFactory as _
[8176]26from waeup.kofa.schema import TextLineChoice, FormattedDate, PhoneNumber
[7811]27from waeup.kofa.students.vocabularies import (
[7915]28    StudyLevelSource, contextual_reg_num_source, contextual_mat_num_source,
29    GenderSource, nats_vocab,
30    )
[8160]31from waeup.kofa.payments.interfaces import (
[8174]32    IPaymentsContainer, IOnlinePayment)
[7915]33from waeup.kofa.university.vocabularies import (
34    CourseSource, StudyModeSource, CertificateSource)
[6621]35
[7620]36# VerdictSource can't be placed into the vocabularies module because it
37# requires importing IStudentsUtils which then leads to circular imports.
38class VerdictSource(BasicContextualSourceFactory):
39    """A verdicts source delivers all verdicts provided
40    in the portal.
41    """
42    def getValues(self, context):
[7841]43        verdicts_dict = getUtility(IStudentsUtils).VERDICTS_DICT
[8820]44        return sorted(verdicts_dict.keys())
[7620]45
46    def getToken(self, context, value):
47        return value
48
49    def getTitle(self, context, value):
[7841]50        verdicts_dict = getUtility(IStudentsUtils).VERDICTS_DICT
[8820]51        if value != '0':
52            return verdicts_dict[value] + ' (%s)' % value
[7688]53        return verdicts_dict[value]
[7620]54
[7681]55
[7150]56class IStudentsUtils(Interface):
57    """A collection of methods which are subject to customization.
58
59    """
[7841]60    def setReturningData(student):
61        """ This method defines what happens after school fee payment
62        depending on the student's senate verdict.
63
64        In the base configuration current level is always increased
65        by 100 no matter which verdict has been assigned.
66        """
67
[8595]68    def setPaymentDetails(category, student):
69        """Create Payment object and set the payment data of a student for
70        the payment category specified.
[7150]71
72        """
73
[7186]74    def getAccommodation_details(student):
[7150]75        """Determine the accommodation dates of a student.
76
77        """
78
[7186]79    def selectBed(available_beds):
[7150]80        """Select a bed from a list of available beds.
81
82        In the standard configuration we select the first bed found,
83        but can also randomize the selection if we like.
84        """
85
[7186]86    def renderPDF(view, subject='', filename='slip.pdf',):
[7150]87        """Render pdf slips for various pages.
88
89        """
90
[7819]91class IStudentsContainer(IKofaObject):
[7096]92    """A students container contains university students.
[6692]93
94    """
95    def addStudent(student):
96        """Add an IStudent object and subcontainers.
97
98        """
99
100    def archive(id=None):
101        """Create on-dist archive of students.
102
103        If id is `None`, all students are archived.
104
105        If id contains a single id string, only the respective
106        students are archived.
107
108        If id contains a list of id strings all of the respective
109        students types are saved to disk.
110        """
111
112    def clear(id=None, archive=True):
113        """Remove students of type given by 'id'.
114
115        Optionally archive the students.
116
117        If id is `None`, all students are archived.
118
119        If id contains a single id string, only the respective
120        students are archived.
121
122        If id contains a list of id strings all of the respective
123        student types are saved to disk.
124
125        If `archive` is ``False`` none of the archive-handling is done
126        and respective students are simply removed from the
127        database.
128        """
129
[8408]130    unique_student_id = Attribute("""A unique student id.""")
131
[7819]132class IStudentNavigation(IKofaObject):
[8735]133    """Interface needed for student navigation, logging, etc.
[7150]134
[6642]135    """
[8736]136    student = Attribute('Student object of context.')
[7150]137
[8735]138    def writeLogMessage(view, message):
139        """Write a view specific log message into students.log.
140
141        """
142
[7819]143class IStudentBase(IKofaObject):
[6631]144    """Representation of student base data.
[7150]145
[6621]146    """
[7062]147    history = Attribute('Object history, a list of messages')
[6637]148    state = Attribute('Returns the registration state of a student')
[6699]149    password = Attribute('Encrypted password of a student')
[7203]150    certcode = Attribute('The certificate code of any chosen study course')
151    depcode = Attribute('The department code of any chosen study course')
152    faccode = Attribute('The faculty code of any chosen study course')
[7062]153    current_session = Attribute('The current session of the student')
[7641]154    current_mode = Attribute('The current mode of the student')
[7364]155    fullname = Attribute('All name parts separated by hyphens')
156    display_fullname = Attribute('The fullname of an applicant')
[8969]157    is_postgrad = Attribute('True if postgraduate student')
[6637]158
[8983]159    suspended = schema.Bool(
160        title = _(u'Account suspended'),
161        default = False,
[9035]162        required = False,
[8983]163        )
164
[6665]165    student_id = schema.TextLine(
[7723]166        title = _(u'Student Id'),
[6849]167        required = False,
[6665]168        )
169
[7357]170    firstname = schema.TextLine(
[7723]171        title = _(u'First Name'),
[6621]172        required = True,
173        )
174
[7357]175    middlename = schema.TextLine(
[7723]176        title = _(u'Middle Name'),
[7357]177        required = False,
178        )
179
180    lastname = schema.TextLine(
[7723]181        title = _(u'Last Name (Surname)'),
[7357]182        required = True,
183        )
184
[6996]185    sex = schema.Choice(
[7723]186        title = _(u'Sex'),
[6996]187        source = GenderSource(),
188        required = True,
189        )
190
[6788]191    reg_number = TextLineChoice(
[7723]192        title = _(u'Registration Number'),
[6696]193        required = True,
194        readonly = False,
[6788]195        source = contextual_reg_num_source,
[6696]196        )
197
[6788]198    matric_number = TextLineChoice(
[7723]199        title = _(u'Matriculation Number'),
[6750]200        required = False,
201        readonly = False,
[6788]202        source = contextual_mat_num_source,
[6750]203        )
204
[6769]205    adm_code = schema.TextLine(
[7723]206        title = _(u'PWD Activation Code'),
[6769]207        required = False,
[8977]208        readonly = False,
[6769]209        )
210
[7133]211    email = schema.ASCIILine(
[7723]212        title = _(u'Email'),
[7133]213        required = False,
214        constraint=validate_email,
215        )
[8176]216    phone = PhoneNumber(
[7723]217        title = _(u'Phone'),
[7331]218        description = u'',
[7133]219        required = False,
220        )
221
[7993]222class IUGStudentClearance(IKofaObject):
223    """Representation of undergraduate student clearance data.
[7150]224
[6631]225    """
[8160]226    date_of_birth = FormattedDate(
[7723]227        title = _(u'Date of Birth'),
[6631]228        required = True,
[8160]229        show_year = True,
[6631]230        )
231
[6695]232    clearance_locked = schema.Bool(
[7723]233        title = _(u'Clearance form locked'),
[6695]234        default = False,
[9035]235        required = False,
[6695]236        )
237
[6769]238    clr_code = schema.TextLine(
[7723]239        title = _(u'CLR Activation Code'),
[6769]240        required = False,
[8977]241        readonly = False,
[6769]242        )
243
[7523]244    nationality = schema.Choice(
[8069]245        vocabulary = nats_vocab,
[7723]246        title = _(u'Nationality'),
[7983]247        required = False,
[7523]248        )
249
[7993]250class IPGStudentClearance(IUGStudentClearance):
251    """Representation of postgraduate student clearance data.
252
253    """
254    employer = schema.TextLine(
255        title = _(u'Employer'),
256        required = False,
257        readonly = False,
258        )
259
[7819]260class IStudentPersonal(IKofaObject):
[6631]261    """Representation of student personal data.
[7150]262
[6631]263    """
[6651]264    perm_address = schema.Text(
[7723]265        title = _(u'Permanent Address'),
[6631]266        required = False,
267        )
268
[8008]269class IStudent(IStudentBase,IUGStudentClearance,IPGStudentClearance,
270    IStudentPersonal):
[6631]271    """Representation of a student.
[7150]272
[6631]273    """
274
[6849]275class IStudentUpdateByRegNo(IStudent):
276    """Representation of a student. Skip regular reg_number validation.
[7150]277
[6849]278    """
279    reg_number = schema.TextLine(
[7723]280        title = _(u'Registration Number'),
[6849]281        required = False,
282        )
283
284class IStudentUpdateByMatricNo(IStudent):
285    """Representation of a student. Skip regular matric_number validation.
[7150]286
[6849]287    """
288    matric_number = schema.TextLine(
[7723]289        title = _(u'Matriculation Number'),
[6849]290        required = False,
291        )
292
[8779]293class IStudentRequestPW(IStudent):
294    """Representation of an student for first-time password request.
295
296    This interface is used when students use the requestpw page to
297    login for the the first time.
298    """
[8854]299    number = schema.TextLine(
300        title = _(u'Registr. or Matric. Number'),
[8779]301        required = True,
302        )
303
304    firstname = schema.TextLine(
305        title = _(u'First Name'),
306        required = True,
307        )
308
309    email = schema.ASCIILine(
310        title = _(u'Email Address'),
311        required = True,
312        constraint=validate_email,
313        )
314
[7819]315class IStudentStudyCourse(IKofaObject):
[6633]316    """A container for student study levels.
317
318    """
[6648]319    certificate = schema.Choice(
[7723]320        title = _(u'Certificate'),
[6648]321        source = CertificateSource(),
[7209]322        required = False,
[6633]323        )
[6635]324
[6996]325    entry_mode = schema.Choice(
[7723]326        title = _(u'Entry Mode'),
[7681]327        source = StudyModeSource(),
[6996]328        required = True,
329        readonly = False,
330        )
331
332    entry_session = schema.Choice(
[7723]333        title = _(u'Entry Session'),
[6996]334        source = academic_sessions_vocab,
[7425]335        #default = datetime.now().year,
[6996]336        required = True,
337        readonly = False,
338        )
339
[6724]340    current_session = schema.Choice(
[7723]341        title = _(u'Current Session'),
[6744]342        source = academic_sessions_vocab,
[6724]343        required = True,
[6996]344        readonly = False,
[6724]345        )
346
347    current_level = schema.Choice(
[7723]348        title = _(u'Current Level'),
[6725]349        source = StudyLevelSource(),
350        required = False,
[6996]351        readonly = False,
[6724]352        )
353
354    current_verdict = schema.Choice(
[7723]355        title = _(u'Current Verdict'),
[7619]356        source = VerdictSource(),
[8820]357        default = '0',
[6725]358        required = False,
[6724]359        )
360
361    previous_verdict = schema.Choice(
[7723]362        title = _(u'Previous Verdict'),
[7619]363        source = VerdictSource(),
[8820]364        default = '0',
[6725]365        required = False,
[6724]366        )
367
[7951]368class IStudentVerdictUpdate(IKofaObject):
369    """A interface for verdict imports.
370
371    """
372
373    current_verdict = schema.Choice(
374        title = _(u'Current Verdict'),
375        source = VerdictSource(),
376        required = True,
377        )
378
379    current_session = schema.Choice(
380        title = _(u'Current Session'),
381        source = academic_sessions_vocab,
382        required = True,
383        )
384
385    current_level = schema.Choice(
386        title = _(u'Current Level'),
387        source = StudyLevelSource(),
388        required = True,
389        )
390
[7819]391class IStudentStudyLevel(IKofaObject):
[6774]392    """A container for course tickets.
393
394    """
395    level = Attribute('The level code')
[6793]396    validation_date = Attribute('The date of validation')
397    validated_by = Attribute('User Id of course adviser')
[6774]398
[6793]399    level_session = schema.Choice(
[7723]400        title = _(u'Session'),
[6793]401        source = academic_sessions_vocab,
402        required = True,
403        )
[6781]404
[6793]405    level_verdict = schema.Choice(
[7723]406        title = _(u'Verdict'),
[7619]407        source = VerdictSource(),
[8820]408        default = '0',
[6793]409        required = False,
410        )
411
[8920]412    def addCourseTicket(ticket, course):
[8182]413        """Add a course ticket object.
414        """
415
[7819]416class ICourseTicket(IKofaObject):
[6781]417    """A course ticket.
418
419    """
[6783]420    code = Attribute('code of the original course')
421    title = Attribute('title of the original course')
422    credits = Attribute('credits of the original course')
423    passmark = Attribute('passmark of the original course')
424    semester = Attribute('semester of the original course')
[7304]425    fcode = Attribute('faculty code of the original course')
426    dcode = Attribute('department code of the original course')
[6781]427
[7665]428    mandatory = schema.Bool(
[7723]429        title = _(u'Mandatory'),
[6795]430        default = False,
431        required = False,
432        readonly = False,
433        )
434
[6781]435    score = schema.Int(
[7723]436        title = _(u'Score'),
[6781]437        default = 0,
438        required = False,
439        readonly = False,
440        )
441
[6806]442    automatic = schema.Bool(
[7723]443        title = _(u'Automatical Creation'),
[6806]444        default = False,
445        required = False,
446        readonly = True,
447        )
448
[7661]449    carry_over = schema.Bool(
[7723]450        title = _(u'Carry-over Course'),
[7661]451        default = False,
452        required = False,
453        readonly = False,
454        )
455
[7633]456    def getLevel():
457        """Returns the id of the level the ticket has been added to.
458        """
459
460    def getLevelSession():
461        """Returns the session of the level the ticket has been added to.
462        """
463
[6795]464class ICourseTicketAdd(ICourseTicket):
[7150]465    """An interface for adding course tickets.
[6795]466
467    """
468    course = schema.Choice(
[7723]469        title = _(u'Course'),
[6795]470        source = CourseSource(),
471        readonly = False,
472        )
473
[7819]474class IStudentAccommodation(IKofaObject):
[6635]475    """A container for student accommodation objects.
476
477    """
478
[7819]479class IBedTicket(IKofaObject):
[6989]480    """A ticket for accommodation booking.
481
482    """
[6996]483    bed = Attribute('The bed object.')
484
485    bed_coordinates = schema.TextLine(
[7723]486        title = _(u'Bed Coordinates'),
[6992]487        required = False,
[7014]488        readonly = False,
[6992]489        )
490
[6996]491    bed_type = schema.TextLine(
[7723]492        title = _(u'Bed Type'),
[6996]493        required = False,
[7014]494        readonly = False,
[6996]495        )
496
[6992]497    booking_session = schema.Choice(
[7723]498        title = _(u'Session'),
[6992]499        source = academic_sessions_vocab,
500        required = True,
[7014]501        readonly = True,
[6992]502        )
503
[8170]504    booking_date = schema.Datetime(
[7723]505        title = _(u'Booking Date'),
[6992]506        required = False,
[7014]507        readonly = True,
[6992]508        )
509
510    booking_code = schema.TextLine(
[7723]511        title = _(u'Booking Activation Code'),
[6992]512        required = False,
[7014]513        readonly = True,
[6992]514        )
515
[6994]516    def getSessionString():
[7633]517        """Returns the title of academic_sessions_vocab term.
[7150]518
[6994]519        """
[6992]520
[6860]521class IStudentPaymentsContainer(IPaymentsContainer):
[6635]522    """A container for student payment objects.
523
524    """
525
[6877]526class IStudentOnlinePayment(IOnlinePayment):
527    """A student payment via payment gateways.
528
529    """
530
[8268]531    p_level = schema.Int(
532        title = _(u'Payment Level'),
533        required = False,
534        readonly = True,
535        )
[6877]536
[8422]537    def doAfterStudentPayment():
538        """Process student after payment was made.
539
540        """
541
[8453]542    def doAfterStudentPaymentApproval():
543        """Process student after payment was approved.
544
545        """
546
[8420]547    def approveStudentPayment():
[8422]548        """Approve payment and process student.
[8420]549
550        """
551
[8268]552IStudentOnlinePayment['p_level'].order = IStudentOnlinePayment[
553    'p_session'].order
[8408]554
555class ICSVStudentExporter(ICSVExporter):
556    """A regular ICSVExporter that additionally supports exporting
557      data from a given student object.
558    """
559
560    def export_student(student, filepath=None):
561        """Export data for a given student.
562        """
Note: See TracBrowser for help on using the repository browser.