Moved Proposal model from wiki to source code and updated ProposalModel wiki page.
authorPawel Solyga <Pawel.Solyga@gmail.com>
Wed, 20 Aug 2008 18:36:55 +0000
changeset 97 d01d0ae7d6c8
parent 96 4fac7d09fc74
child 98 b2b823466a8b
Moved Proposal model from wiki to source code and updated ProposalModel wiki page. Patch by: Pawel Solyga Review by: Todd Larsen Review issue: 362 Review URL: http://codereviews.googleopensourceprograms.com/362
app/soc/models/proposal.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/app/soc/models/proposal.py	Wed Aug 20 18:36:55 2008 +0000
@@ -0,0 +1,56 @@
+#!/usr/bin/python2.5
+#
+# Copyright 2008 the Melange authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#   http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This module contains the Proposal Model."""
+
+__authors__ = [
+  '"Todd Larsen" <tlarsen@google.com>',
+  '"Pawel Solyga" <pawel.solyga@gmail.com>',
+]
+
+from google.appengine.ext import db
+
+from soc import models
+import soc.models.work
+
+class Proposal(db.Model):
+  """Model of a Proposal, which is a specific form of a Work.
+
+  A Proposal entity participates in the following relationships implemented 
+  as a db.ReferenceProperty elsewhere in another db.Model:
+
+  tasks)  an optional 1:many relationship of Task entities using the
+    Proposal as their foundation.  This relation is implemented as the
+    'tasks' back-reference Query of the Task model 'proposal' reference.
+
+   """"
+	#: Required 1:1 relationship with a Work entity that contains the
+	#: general "work" properties of the Proposal.  The back-reference in the Work
+	#: model is a Query named 'proposal'.
+	#: 
+	#: work.authors:  the Authors of the Work referred to by this relation
+	#: are the authors of the Proposal.
+	#: work.title:  the title of the Proposal.
+	#: work.abstract:  publicly displayed as a proposal abstract or summary.
+	#: work.reviews:  reviews of the Proposal by Reviewers.
+  work = db.ReferenceProperty(reference_class=soc.models.work.Work, required=True,
+                              collection_name="proposal")
+
+  #: Required db.TextProperty describing the proposal in detail.
+  #: Unlike the work.abstract, which is considered "public" information,
+	#: the contents of 'details' is only to be displayed to Persons in roles
+  #: that have a "need to know" the details.
+  details = db.TextProperty(required=True)