lib/pkp/classes/controlledVocab/ControlledVocabEntry.inc.php

   1 <?php
   2
   3 /**
   4  * @file ControlledVocabEntry.inc.php
   5  *
   6  * Copyright (c) 2000-2009 John Willinsky
   7  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
   8  *
   9  * @class ControlledVocabEntry
  10  * @ingroup controlled_vocabs
  11  * @see ControlledVocabEntryDAO
  12  *
  13  * @brief Basic class describing a controlled vocab.
  14  */
  15
  16 //$Id: ControlledVocabEntry.inc.php,v 1.2 2009/04/08 21:34:53 asmecher Exp $
  17
  18 class ControlledVocabEntry extends DataObject {
  19         //
  20         // Get/set methods
  21         //
  22
  23         /**
  24          * Get the ID of the controlled vocab.
  25          * @return int
  26          */
  27         function getControlledVocabId() {
  28                 return $this->getData('controlledVocabId');
  29         }
  30
  31         /**
  32          * Set the ID of the controlled vocab.
  33          * @param $controlledVocabId int
  34          */
  35         function setControlledVocabId($controlledVocabId) {
  36                 return $this->setData('controlledVocabId', $controlledVocabId);
  37         }
  38
  39         /**
  40          * Get sequence number.
  41          * @return float
  42          */
  43         function getSequence() {
  44                 return $this->getData('sequence');
  45         }
  46
  47         /**
  48          * Set sequence number.
  49          * @param $sequence float
  50          */
  51         function setSequence($sequence) {
  52                 return $this->setData('sequence', $sequence);
  53         }
  54
  55         /**
  56          * Get the localized name.
  57          * @return string
  58          */
  59         function getLocalizedName() {
  60                 return $this->getLocalizedData('name');
  61         }
  62
  63         /**
  64          * Get the name of the controlled vocabulary entry.
  65          * @param $locale string
  66          * @return string
  67          */
  68         function getName($locale) {
  69                 return $this->getData('name', $locale);
  70         }
  71
  72         /**
  73          * Set the name of the controlled vocabulary entry.
  74          * @param $name string
  75          * @param $locale string
  76          */
  77         function setName($name, $locale) {
  78                 return $this->setData('name', $name, $locale);
  79         }
  80 }
  81
  82 ?>