source: main/kofacustom.nigeria/branches/uli-paypal/src/kofacustom/nigeria/students/student.py @ 17387

## $Id: student.py 14274 2016-11-15 09:12:51Z henrik $
##
## Copyright (C) 2011 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
##
"""
Container for the various objects owned by students.
"""
import grok
from zope.interface import implementedBy
from waeup.kofa.utils.helpers import attrs_to_fields
from waeup.kofa.students.student import Student, StudentFactory
from waeup.kofa.interfaces import CLEARANCE
from kofacustom.nigeria.students.interfaces import (
    INigeriaStudent, IStudentNavigation, INigeriaStudentPersonalEdit)


class NigeriaStudent(Student):
    """This is a student container for the various objects
    owned by students.
    """
    grok.implements(
        INigeriaStudent, INigeriaStudentPersonalEdit, IStudentNavigation)
    grok.provides(INigeriaStudent)

    @property
    def is_foreigner(self):
        return getattr(self, 'nationality') != 'NG'

    @property
    def transcript_enabled(self):
        return False

    @property
    def clearance_locked(self):
        return self.state != CLEARANCE and not self.provisionally_cleared

# Set all attributes of Student required in IStudent as field
# properties. Doing this, we do not have to set initial attributes
# ourselves and as a bonus we get free validation when an attribute is
# set.
NigeriaStudent = attrs_to_fields(NigeriaStudent)

class NigeriaStudentFactory(StudentFactory):
    """A factory for students.
    """

    def __call__(self, *args, **kw):
        return NigeriaStudent()

    def getInterfaces(self):
        return implementedBy(NigeriaStudent)