1 #!/usr/bin/python2.5

     2 #

     3 # Copyright 2009 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 Follower Model."""

    18 

    19 __authors__ = [

    20   '"Lennard de Rijk" <ljvderijk@gmail.com>',

    21 ]

    22 

    23 

    24 from google.appengine.ext import db

    25 

    26 import soc.models.linkable

    27 

    28 

    29 class Follower(soc.models.linkable.Linkable):

    30   """Details specific to a Follower.

    31 

    32     A Follower is a generic model which indicates that a User is following

    33     some other Linkable entity in the application.

    34 

    35     Scope and scope_path should be set to the entity being followed.

    36     The link_id should be used to indicate which user is following.

    37 

    38     If more functionality is needed like for instance when following 

    39     either a public or private review for Student Proposals this model

    40     should be extended. As to make it possible to create different types

    41     of following.

    42   """

    43 

    44   #: Required property to tie a user to the entity it is following

    45   user = db.ReferenceProperty(reference_class=soc.models.user.User,

    46                               required=True, collection_name='following')

    47 

    48   pass