source: main/waeup.kofa/trunk/src/waeup/kofa/students/accommodation.py @ 9533

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

Fix docstrings.

In my old ZODB which I used for testing there were orphaned catalog entries. I don't know why. The tests show clearly that the catalog is updated whenever a hostel is removed or cleared. However, to be 100% that nothing goes wrong I added some extra safety belts.

  • Property svn:keywords set to Id
File size: 3.2 KB
Line 
1## $Id: accommodation.py 9424 2012-10-26 17:17:10Z 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"""
19Student accommodation components.
20"""
21from datetime import datetime
22import grok
23from zope.component import getUtility
24from zope.component.interfaces import IFactory
25from zope.interface import implementedBy
26from waeup.kofa.interfaces import academic_sessions_vocab, IKofaUtils
27from waeup.kofa.students.interfaces import (
28    IStudentAccommodation, IStudentNavigation, IBedTicket)
29from waeup.kofa.utils.helpers import attrs_to_fields
30
31class StudentAccommodation(grok.Container):
32    """This is a container for bed tickets.
33    """
34    grok.implements(IStudentAccommodation, IStudentNavigation)
35    grok.provides(IStudentAccommodation)
36
37    def __init__(self):
38        super(StudentAccommodation, self).__init__()
39        return
40
41    def addBedTicket(self, bedticket):
42        """Add a bed ticket object.
43        """
44        if not IBedTicket.providedBy(bedticket):
45            raise TypeError(
46                'StudentAccommodation containers contain only IBedTicket instances')
47        self[str(bedticket.booking_session)] = bedticket
48        return
49
50    @property
51    def student(self):
52        return self.__parent__
53
54    def writeLogMessage(self, view, message):
55        return self.__parent__.writeLogMessage(view, message)
56
57StudentAccommodation = attrs_to_fields(StudentAccommodation)
58
59class BedTicket(grok.Model):
60    """This is a bed ticket which shows that the student has booked a bed.
61    """
62    grok.implements(IBedTicket, IStudentNavigation)
63    grok.provides(IBedTicket)
64
65    def __init__(self):
66        super(BedTicket, self).__init__()
67        self.booking_date = datetime.utcnow()
68        self.bed = None
69        return
70
71    @property
72    def student(self):
73        try:
74            return self.__parent__.__parent__
75        except AttributeError:
76            return None
77
78    def writeLogMessage(self, view, message):
79        return self.__parent__.__parent__.writeLogMessage(view, message)
80
81    def getSessionString(self):
82        return academic_sessions_vocab.getTerm(
83            self.booking_session).title
84
85BedTicket = attrs_to_fields(BedTicket)
86
87# Bed tickets must be importable. So we might need a factory.
88class BedTicketFactory(grok.GlobalUtility):
89    """A factory for bed tickets.
90    """
91    grok.implements(IFactory)
92    grok.name(u'waeup.BedTicket')
93    title = u"Create a new bed ticket.",
94    description = u"This factory instantiates new bed ticket instances."
95
96    def __call__(self, *args, **kw):
97        return BedTicket()
98
99    def getInterfaces(self):
100        return implementedBy(BedTicket)
Note: See TracBrowser for help on using the repository browser.