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

    18 

    19 __authors__ = [

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

    21   '"Sverre Rabbelier" <sverre@rabbelier.nl>',

    22 ]

    23 

    24 from google.appengine.ext import db

    25 

    26 from soc import models

    27 import soc.models.person

    28 

    29 

    30 class Documentation(db.Model):

    31   """Model of Documentation, which is a Work authored by Administrators."""

    32     

    33   #: A required 1:1 relationship with a Work entity that contains the

    34   #: general "work" properties of the Documentation. The 

    35   #: back-reference in the Work model is a Query named 

    36   #: 'documentation'.

    37   #:

    38   #:   work.authors: The Authors of the Work referred to by this 

    39   #:     relation are the Administrators (or Hosts) creating the

    40   #:     Documentation.

    41   #:

    42   #:   work.title: The title of the Documentation (e.g. "Verification

    43   #:     of Eligibility").

    44   #:

    45   #:   work.abstract: Summary of the contents of the 'attachment', or

    46   #:     just an indication that the required documentation was 

    47   #:     supplied but is not actually attached.

    48   #:

    49   #:   work.reviews: Annotations to the Documentation made by other

    50   #:     Administrators.

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

    52                               collection_name="proposal")

    53 

    54   #: a many:1 relationship of Documentation entities that pertain

    55   #: to a single Person.  The back-reference in the Person model is a

    56   #: Query named 'docs'.

    57   person = db.ReferenceProperty(reference_class=soc.models.person.Person,

    58                                 collection_name="docs")

    59 

    60   #: An optional db.BlobProperty containing the documentation

    61   #: (usually a scanned image of a paper document or a PDF file).

    62   attachment = db.BlobProperty()

    63