source: main/waeup.aaue/trunk/src/waeup/aaue/students/interfaces.py @ 14677

## $Id: interfaces.py 14318 2016-12-06 21:59:12Z henrik $
##
## Copyright (C) 2012 Uli Fouquet & Henrik Bettermann
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##

from zope import schema
from zope.interface import Attribute, invariant
from zc.sourcefactory.contextual import BasicContextualSourceFactory
from zope.catalog.interfaces import ICatalog
from zope.component import getUtility
from waeup.kofa.schoolgrades import ResultEntryField
from waeup.kofa.interfaces import (IKofaObject, academic_sessions_vocab)
from waeup.kofa.students.vocabularies import (
    StudyLevelSource, contextual_reg_num_source, nats_vocab, 
    )
from waeup.kofa.students.interfaces import IUGStudentClearance
from waeup.kofa.schema import PhoneNumber, FormattedDate, TextLineChoice
from kofacustom.nigeria.interfaces import (
    LGASource, exam_types, high_qual, high_grade)
from kofacustom.nigeria.students.interfaces import (
    INigeriaStudentBase, INigeriaUGStudentClearance, INigeriaPGStudentClearance,
    INigeriaStudentPersonal, INigeriaStudentStudyLevel,
    INigeriaStudentStudyCourse, INigeriaCourseTicket,
    INigeriaStudentUpdateByRegNo, INigeriaStudentUpdateByMatricNo,
    )
from waeup.aaue.payments.interfaces import ICustomOnlinePayment
from waeup.aaue.interfaces import MessageFactory as _

class ICustomStudentBase(INigeriaStudentBase):
    """Representation of student base data.

    """

    reg_number = TextLineChoice(
        title = _(u'JAMB Registration Number'),
        required = False,
        readonly = False,
        source = contextual_reg_num_source,
        )

    application_number = schema.TextLine(
        title = _(u'Application Number'),
        required = False,
        readonly = False,
        )

ICustomStudentBase['reg_number'].order = INigeriaStudentBase[
    'reg_number'].order

ICustomStudentBase['application_number'].order = ICustomStudentBase[
    'reg_number'].order


class ICustomStudentPersonal(INigeriaStudentPersonal):
    """Student personal data.

    """

    father_name = schema.TextLine(
        title = _(u'Father\'s Name'),
        required = False,
        readonly = False,
        )

    father_address = schema.Text(
        title = _(u'Father\'s Permanent Address'),
        required = False,
        readonly = False,
        )

    father_work = schema.TextLine(
        title = _(u'Father\'s Place of Work'),
        required = False,
        readonly = False,
        )

    father_phone = PhoneNumber(
        title = _(u'Father\'s Phone'),
        required = False,
        readonly = False,
        )

    mother_name = schema.TextLine(
        title = _(u'Mother\'s Name'),
        required = False,
        readonly = False,
        )

    mother_address = schema.Text(
        title = _(u'Mother\'s Permanent Address'),
        required = False,
        readonly = False,
        )

    mother_work = schema.TextLine(
        title = _(u'Mother\'s Place of Work'),
        required = False,
        readonly = False,
        )

    mother_phone = PhoneNumber(
        title = _(u'Mother\'s Phone'),
        required = False,
        readonly = False,
        )

    phone_personal = PhoneNumber(
        title = _(u'Student\'s Personal Phone'),
        description = u'',
        required = False,
        readonly = False,
        )

class ICustomStudentPersonalEdit(ICustomStudentPersonal):
    """Interface for editing personal data by students.

    Here we can repeat the fields from IStudentPersonal and set the
    `required` if necessary.
    """

    perm_address = schema.Text(
        title = _(u'Permanent Address'),
        required = True,
        )

    next_kin_name = schema.TextLine(
        title = _(u'Next of Kin Name'),
        required = True,
        readonly = False,
        )

    next_kin_relation = schema.TextLine(
        title = _(u'Next of Kin Relationship'),
        required = True,
        readonly = False,
        )

    next_kin_address = schema.Text(
        title = _(u'Next of Kin Address'),
        required = True,
        readonly = False,
        )

    next_kin_phone = PhoneNumber(
        title = _(u'Next of Kin Phone'),
        description = u'',
        required = True,
        readonly = False,
        )

    father_name = schema.TextLine(
        title = _(u'Father\'s Name'),
        required = True,
        readonly = False,
        )

    father_address = schema.Text(
        title = _(u'Father\'s Permanent Address'),
        required = True,
        readonly = False,
        )

    father_work = schema.TextLine(
        title = _(u'Father\'s Place of Work'),
        required = True,
        readonly = False,
        )

    father_phone = PhoneNumber(
        title = _(u'Father\'s Phone'),
        required = True,
        readonly = False,
        )

    mother_name = schema.TextLine(
        title = _(u'Mother\'s Name'),
        required = True,
        readonly = False,
        )

    mother_address = schema.Text(
        title = _(u'Mother\'s Permanent Address'),
        required = True,
        readonly = False,
        )

    mother_work = schema.TextLine(
        title = _(u'Mother\'s Place of Work'),
        required = True,
        readonly = False,
        )

    mother_phone = PhoneNumber(
        title = _(u'Mother\'s Phone'),
        required = True,
        readonly = False,
        )

    phone_personal = PhoneNumber(
        title = _(u'Student\'s Personal Phone'),
        description = u'',
        required = True,
        readonly = False,
        )

class ICustomUGStudentClearance(IUGStudentClearance):
    """Representation of ug student clearance data.

    """

    officer_comment = schema.Text(
        title = _(u"Officer's Comment"),
        required = False,
        )

    physical_clearance_date = schema.TextLine(
        title = _(u"Physical Clearance Date"),
        required = False,
        )

    clr_code = schema.TextLine(
        title = _(u'CLR Activation Code'),
        required = False,
        readonly = False,
        )

    date_of_birth = FormattedDate(
        title = _(u'Date of Birth'),
        required = False,
        show_year = True,
        )

    nationality = schema.Choice(
        source = nats_vocab,
        title = _(u'Nationality'),
        required = True,
        )

    lga = schema.Choice(
        source = LGASource(),
        title = _(u'State / LGA'),
        required = True,
        )

    def_adm = schema.Bool(
        title = _(u'Deferment of Admission'),
        required = False,
        readonly = False,
        default = False,
        )

    fst_sit_fname = schema.TextLine(
        title = _(u'Full Name'),
        required = False,
        readonly = False,
        )
    fst_sit_no = schema.TextLine(
        title = _(u'Exam Number'),
        required = False,
        readonly = False,
        )

    fst_sit_sc_pin = schema.TextLine(
        title = _(u'Scratch Card Pin'),
        required = False,
        readonly = False,
        )

    fst_sit_sc_serial_number = schema.TextLine(
        title = _(u'Scratch Card Serial Number'),
        required = False,
        readonly = False,
        )

    fst_sit_date = FormattedDate(
        title = _(u'Exam Date'),
        required = False,
        readonly = False,
        show_year = True,
        )

    fst_sit_type = schema.Choice(
        title = _(u'Exam Type'),
        required = False,
        readonly = False,
        vocabulary = exam_types,
        )

    fst_sit_results = schema.List(
        title = _(u'Exam Results'),
        value_type = ResultEntryField(),
        required = False,
        readonly = False,
        defaultFactory=list,
        )

    scd_sit_fname = schema.TextLine(
        title = _(u'Full Name'),
        required = False,
        readonly = False,
        )
    scd_sit_no = schema.TextLine(
        title = _(u'Exam Number'),
        required = False,
        readonly = False,
        )

    scd_sit_sc_pin = schema.TextLine(
        title = _(u'Scratch Card Pin'),
        required = False,
        readonly = False,
        )

    scd_sit_sc_serial_number = schema.TextLine(
        title = _(u'Scratch Card Serial Number'),
        required = False,
        readonly = False,
        )

    scd_sit_date = FormattedDate(
        title = _(u'Exam Date'),
        required = False,
        readonly = False,
        show_year = True,
        )

    scd_sit_type = schema.Choice(
        title = _(u'Exam Type'),
        required = False,
        readonly = False,
        vocabulary = exam_types,
        )

    scd_sit_results = schema.List(
        title = _(u'Exam Results'),
        value_type = ResultEntryField(),
        required = False,
        readonly = False,
        defaultFactory=list,
        )


    alr_fname = schema.TextLine(
        title = _(u'Full Name'),
        required = False,
        readonly = False,
        )
    alr_no = schema.TextLine(
        title = _(u'Exam Number'),
        required = False,
        readonly = False,
        )

    alr_date = FormattedDate(
        title = _(u'Exam Date'),
        required = False,
        readonly = False,
        show_year = True,
        )

    alr_results = schema.List(
        title = _(u'Exam Results'),
        value_type = ResultEntryField(),
        required = False,
        readonly = False,
        defaultFactory=list,
        )

    hq_type = schema.Choice(
        title = _(u'Qualification Obtained'),
        required = False,
        readonly = False,
        vocabulary = high_qual,
        )

    hq_fname = schema.TextLine(
        title = _(u'Full Name'),
        required = False,
        readonly = False,
        )

    hq_matric_no = schema.TextLine(
        title = _(u'Former Matric Number'),
        required = False,
        readonly = False,
        )

    hq_degree = schema.Choice(
        title = _(u'Class of Degree'),
        required = False,
        readonly = False,
        vocabulary = high_grade,
        )

    hq_school = schema.TextLine(
        title = _(u'Institution Attended'),
        required = False,
        readonly = False,
        )

    hq_session = schema.TextLine(
        title = _(u'Years Attended'),
        required = False,
        readonly = False,
        )

    hq_disc = schema.TextLine(
        title = _(u'Discipline'),
        required = False,
        readonly = False,
        )

    @invariant
    def check_lga_nationality(student):
        if student.nationality != 'NG' and student.lga not in ('foreigner', None):
            raise Invalid(_('Nationalty and LGA are contradictory.'))
        if student.nationality == 'NG' and student.lga == 'foreigner':
            raise Invalid(_('Nationalty and LGA are contradictory.'))

class ICustomUGStudentClearanceEdit(ICustomUGStudentClearance):
    """Representation of ug student clearance data.

    """

    fst_sit_fname = schema.TextLine(
        title = _(u'Full Name'),
        required = True,
        readonly = False,
        )
    fst_sit_no = schema.TextLine(
        title = _(u'Exam Number'),
        required = True,
        readonly = False,
        )

    fst_sit_sc_pin = schema.TextLine(
        title = _(u'Scratch Card Pin'),
        required = True,
        readonly = False,
        )

    fst_sit_sc_serial_number = schema.TextLine(
        title = _(u'Scratch Card Serial Number'),
        required = True,
        readonly = False,
        )

    fst_sit_date = FormattedDate(
        title = _(u'Exam Date'),
        required = True,
        readonly = False,
        show_year = True,
        )

    fst_sit_type = schema.Choice(
        title = _(u'Exam Type'),
        required = True,
        readonly = False,
        vocabulary = exam_types,
        )

    fst_sit_results = schema.List(
        title = _(u'Exam Results'),
        value_type = ResultEntryField(),
        required = True,
        readonly = False,
        defaultFactory=list,
        )


ICustomUGStudentClearanceEdit['fst_sit_fname'].order = ICustomUGStudentClearance[
    'fst_sit_fname'].order
ICustomUGStudentClearanceEdit['fst_sit_no'].order = ICustomUGStudentClearance[
    'fst_sit_no'].order
ICustomUGStudentClearanceEdit['fst_sit_sc_pin'].order = ICustomUGStudentClearance[
    'fst_sit_sc_pin'].order
ICustomUGStudentClearanceEdit['fst_sit_sc_serial_number'].order = ICustomUGStudentClearance[
    'fst_sit_sc_serial_number'].order
ICustomUGStudentClearanceEdit['fst_sit_date'].order = ICustomUGStudentClearance[
    'fst_sit_date'].order
ICustomUGStudentClearanceEdit['fst_sit_type'].order = ICustomUGStudentClearance[
    'fst_sit_type'].order
ICustomUGStudentClearanceEdit['fst_sit_results'].order = ICustomUGStudentClearance[
    'fst_sit_results'].order

class ICustomPGStudentClearance(INigeriaPGStudentClearance):
    """Representation of pg student clearance data.

    """


class ICustomStudent(ICustomStudentBase,ICustomUGStudentClearance,
    ICustomPGStudentClearance,ICustomStudentPersonal):
    """Representation of a student.

    """

class ICustomStudentStudyCourse(INigeriaStudentStudyCourse):
    """A container for student study levels.

    """

    imported_cgpa = schema.Float(
        title = _(u'Imported Cumulative GPA'),
        required = False,
        )

class ICustomStudentStudyLevel(INigeriaStudentStudyLevel):
    """A container for course tickets.

    """

    total_credits_s1 = schema.Int(
        title = _(u'1st Semester Units'),
        required = False,
        )

    total_credits_s2 = schema.Int(
        title = _(u'2nd Semester Units'),
        required = False,
        )

    total_credits = schema.Int(
        title = _(u'Total Units'),
        required = False,
        )

    imported_gpa = schema.Float(
        title = _(u'Imported Level GPA'),
        required = False,
        )

    imported_cgpa = schema.Float(
        title = _(u'Imported Cumulative GPA'),
        required = False,
        )


class ICustomStudentOnlinePayment(ICustomOnlinePayment):
    """A student payment via payment gateways.

    This Interface does not inherit from IStudentOnlinePayment.
    Thus all fields from IStudentOnlinePayment have to be repeated here.
    """

    p_current = schema.Bool(
        title = _(u'Current Session Payment'),
        default = True,
        required = False,
        )

    p_level = schema.Choice(
        title = _(u'Payment Level'),
        source = StudyLevelSource(),
        required = False,
        )

ICustomStudentOnlinePayment['p_level'].order = ICustomStudentOnlinePayment[
    'p_session'].order

class ICustomCourseTicket(INigeriaCourseTicket):
    """A course ticket.

    """

    score = schema.Int(
        title = _(u'Score'),
        required = False,
        readonly = False,
        max = 100,
        )

    ca = schema.Int(
        title = _(u'CA'),
        default = None,
        required = False,
        missing_value = None,
        max = 30,
        )

class ICustomCourseTicketImport(ICustomCourseTicket):
    """An interface for importing course results and nothing more.
    """
    score = schema.Int(
        title = _(u'Score'),
        required = False,
        readonly = False,
        max = 100,
        )

    ca = schema.Int(
        title = _(u'CA'),
        required = False,
        readonly = False,
        max = 30,
        )

    level_session = schema.Choice(
        title = _(u'Level Session'),
        source = academic_sessions_vocab,
        required = False,
        readonly = False,
        )

ICustomCourseTicket['ca'].order = ICustomCourseTicket['score'].order

class ICustomStudentUpdateByRegNo(INigeriaStudentUpdateByRegNo):
    """Representation of a student. Skip regular reg_number validation.

    """

class ICustomStudentUpdateByMatricNo(INigeriaStudentUpdateByMatricNo):
    """Representation of a student. Skip regular matric_number validation.

    """