app/soc/models/school.py
changeset 173 f5219e0ee998
child 181 fdd29818a954
equal deleted inserted replaced
172:594e07154872 173:f5219e0ee998
       
     1 #!/usr/bin/python2.5
       
     2 #
       
     3 # Copyright 2008 the Melange authors.
       
     4 #
       
     5 # Licensed under the Apache License, Version 2.0 (the "License");
       
     6 # you may not use this file except in compliance with the License.
       
     7 # You may obtain a copy of the License at
       
     8 #
       
     9 #   http://www.apache.org/licenses/LICENSE-2.0
       
    10 #
       
    11 # Unless required by applicable law or agreed to in writing, software
       
    12 # distributed under the License is distributed on an "AS IS" BASIS,
       
    13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
       
    14 # See the License for the specific language governing permissions and
       
    15 # limitations under the License.
       
    16 
       
    17 """This module contains the School Model."""
       
    18 
       
    19 __authors__ = [
       
    20   '"Todd Larsen" <tlarsen@google.com>',
       
    21 ]
       
    22 
       
    23 
       
    24 from google.appengine.ext import db
       
    25 
       
    26 from django.utils.translation import ugettext_lazy
       
    27 
       
    28 from soc.models import base
       
    29 import soc.models.group
       
    30 
       
    31 
       
    32 class School(base.ModelWithFieldAttributes):
       
    33   """Details specific to a School.
       
    34 
       
    35   A School is a specific type of Group that gathers Students together.
       
    36 
       
    37   A School entity participates in the following relationships implemented
       
    38   as a db.ReferenceProperty elsewhere in another db.Model:
       
    39 
       
    40    students)  a 1:many relationship of Students attending (or otherwise
       
    41      belonging to) a School.  This relation is implemented as the 'students'
       
    42      back-reference Query of the Student model 'school' reference.
       
    43   """
       
    44 
       
    45   #: Required 1:1 relationship that ties School details to the more
       
    46   #: generic Group details.  The back-reference in the Group model is a
       
    47   #: Query named 'school'.
       
    48   group = db.ReferenceProperty(reference_class=soc.models.group.Group,
       
    49                                required=True, collection_name="school")