classes/reviewForm/ReviewForm.inc.php

   1 <?php
   2
   3 /**
   4  * @defgroup reviewForm
   5  */
   6
   7 /**
   8  * @file classes/reviewForm/ReviewForm.inc.php
   9  *
  10  * Copyright (c) 2003-2009 John Willinsky
  11  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  12  *
  13  * @class ReviewForm
  14  * @ingroup reviewForm
  15  * @see ReviewerFormDAO
  16  *
  17  * @brief Basic class describing a review form.
  18  *
  19  */
  20
  21 class ReviewForm extends DataObject {
  22
  23         /**
  24          * Constructor.
  25          */
  26         function ReviewForm() {
  27                 parent::DataObject();
  28         }
  29
  30         /**
  31          * Get localized title.
  32          * @return string
  33          */
  34         function getReviewFormTitle() {
  35                 return $this->getLocalizedData('title');
  36         }
  37
  38         /**
  39          * Get localized description.
  40          * @return array
  41          */
  42         function getReviewFormDescription() {
  43                 return $this->getLocalizedData('description');
  44         }
  45
  46         //
  47         // Get/set methods
  48         //
  49
  50         /**
  51          * Get the ID of the review form.
  52          * @return int
  53          */
  54         function getReviewFormId() {
  55                 return $this->getData('reviewFormId');
  56         }
  57
  58         /**
  59          * Set the ID of the review form.
  60          * @param $reviewFormId int
  61          */
  62         function setReviewFormId($reviewFormId) {
  63                 return $this->setData('reviewFormId', $reviewFormId);
  64         }
  65
  66         /**
  67          * Get the number of completed reviews for this review form.
  68          * @return int
  69          */
  70         function getCompleteCount() {
  71                 return $this->getData('completeCount');
  72         }
  73
  74         /**
  75          * Set the number of complete reviews for this review form.
  76          * @param $completeCount int
  77          */
  78         function setCompleteCount($completeCount) {
  79                 return $this->setData('completeCount', $completeCount);
  80         }
  81
  82         /**
  83          * Get the number of incomplete reviews for this review form.
  84          * @return int
  85          */
  86         function getIncompleteCount() {
  87                 return $this->getData('incompleteCount');
  88         }
  89
  90         /**
  91          * Set the number of incomplete reviews for this review form.
  92          * @param $incompleteCount int
  93          */
  94         function setIncompleteCount($incompleteCount) {
  95                 return $this->setData('incompleteCount', $incompleteCount);
  96         }
  97
  98         /**
  99          * Get ID of the press.
 100          * @return int
 101          */
 102         function getPressId() {
 103                 return $this->getData('pressId');
 104         }
 105
 106         /**
 107          * Set ID of the press.
 108          * @param $pressId int
 109          */
 110         function setPressId($pressId) {
 111                 return $this->setData('pressId', $pressId);
 112         }
 113
 114         /**
 115          * Get sequence of review form.
 116          * @return float
 117          */
 118         function getSequence() {
 119                 return $this->getData('sequence');
 120         }
 121
 122         /**
 123          * Set sequence of review form.
 124          * @param $sequence float
 125          */
 126         function setSequence($sequence) {
 127                 return $this->setData('sequence', $sequence);
 128         }
 129
 130         /**
 131          * Get active flag
 132          * @return int
 133          */
 134         function getActive() {
 135                 return $this->getData('active');
 136         }
 137
 138         /**
 139          * Set active flag
 140          * @param $active int
 141          */
 142         function setActive($active) {
 143                 return $this->setData('active', $active);
 144         }
 145
 146         /**
 147          * Get title.
 148          * @param $locale string
 149          * @return string
 150          */
 151         function getTitle($locale) {
 152                 return $this->getData('title', $locale);
 153         }
 154
 155         /**
 156          * Set title.
 157          * @param $title string
 158          * @param $locale string
 159          */
 160         function setTitle($title, $locale) {
 161                 return $this->setData('title', $title, $locale);
 162         }
 163
 164         /**
 165          * Get description.
 166          * @param $locale string
 167          * @return string
 168          */
 169         function getDescription($locale) {
 170                 return $this->getData('description', $locale);
 171         }
 172
 173         /**
 174          * Set description.
 175          * @param $description string
 176          * @param $locale string
 177          */
 178         function setDescription($description, $locale) {
 179                 return $this->setData('description', $description, $locale);
 180         }
 181 }
 182
 183 ?>