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 Club 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 Club(base.ModelWithFieldAttributes):

    33   """Details specific to a Club.

    34 

    35   A Club is a generic type of Group that gathers Members into a community.

    36 

    37   A Club entity participates in the following relationships implemented

    38   as a db.ReferenceProperty elsewhere in another db.Model:

    39 

    40    members)  a 1:many relationship of Members belonging to a Club.  This

    41      relation is implemented as the 'members' back-reference Query of the

    42      Member model 'club' reference.

    43   """

    44 

    45   #: Required 1:1 relationship that ties Club details to the more generic

    46   #: Group details.  The back-reference in the Group model is a Query

    47   #: named 'club'.

    48   group = db.ReferenceProperty(reference_class=soc.models.org.Group,

    49                                required=True, collection_name="club")