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 Proposal Model."""

    18 

    19 __authors__ = [

    20   '"Todd Larsen" <tlarsen@google.com>',

    21   '"Pawel Solyga" <pawel.solyga@gmail.com>',

    22 ]

    23 

    24 from google.appengine.ext import db

    25 

    26 from soc import models

    27 import soc.models.work

    28 

    29 class Proposal(db.Model):

    30   """Model of a Proposal, which is a specific form of a Work.

    31 

    32   A Proposal entity participates in the following relationships implemented 

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

    34 

    35   tasks)  an optional 1:many relationship of Task entities using the

    36     Proposal as their foundation.  This relation is implemented as the

    37     'tasks' back-reference Query of the Task model 'proposal' reference.

    38 

    39    """"

    40 	#: Required 1:1 relationship with a Work entity that contains the

    41 	#: general "work" properties of the Proposal.  The back-reference in the Work

    42 	#: model is a Query named 'proposal'.

    43 	#: 

    44 	#: work.authors:  the Authors of the Work referred to by this relation

    45 	#: are the authors of the Proposal.

    46 	#: work.title:  the title of the Proposal.

    47 	#: work.abstract:  publicly displayed as a proposal abstract or summary.

    48 	#: work.reviews:  reviews of the Proposal by Reviewers.

    49   work = db.ReferenceProperty(reference_class=soc.models.work.Work, required=True,

    50                               collection_name="proposal")

    51 

    52   #: Required db.TextProperty describing the proposal in detail.

    53   #: Unlike the work.abstract, which is considered "public" information,

    54 	#: the contents of 'details' is only to be displayed to Persons in roles

    55   #: that have a "need to know" the details.

    56   details = db.TextProperty(required=True)