inc/main/interfaces/criteria/extended/class_StoreableCriteria.php

   1 <?php
   2 /**
   3  * An interface for storeable data sets
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface StoreableCriteria extends Criteria {
  25         /**
  26          * Setter for table name
  27          *
  28          * @param       $tableName      Name of the table to set
  29          * @return      void
  30          */
  31         function setTableName ($tableName);
  32
  33         /**
  34          * Getter for table name
  35          *
  36          * @return      $tableName      Name of the table to set
  37          */
  38         function getTableName ();
  39
  40         /**
  41          * Setter for unique key
  42          *
  43          * @param       $uniqueKey      Column to use as unique key
  44          * @return      void
  45          */
  46         function setUniqueKey ($uniqueKey);
  47
  48         /**
  49          * Getter for unique key
  50          *
  51          * @return      $uniqueKey      Column to use as unique key
  52          */
  53         function getUniqueKey ();
  54
  55         /**
  56          * Getter for unique key value
  57          *
  58          * @return      $uniqueValue    Value of the unique key
  59          */
  60         function getUniqueValue ();
  61
  62         /**
  63          * Getter for primary key or unique key if not set
  64          *
  65          * @return      $primaryKey             Primary key or unique key if not set
  66          */
  67         function getPrimaryKey ();
  68
  69         /**
  70          * Setter for primary key
  71          *
  72          * @param       $primaryKey             Primary key to set
  73          * @return      void
  74          */
  75         function setPrimaryKey ($primaryKey);
  76
  77         /**
  78          * Setter for primary key array
  79          *
  80          * @param       $primaryKeys    Primary key array to set
  81          * @return      void
  82          */
  83         function setPrimaryKeyCombined (array $primaryKeys);
  84
  85         /**
  86          * Getter for primary keys
  87          *
  88          * @return      $primaryKeys    Primary key array
  89          */
  90         function getPrimaryKeys ();
  91 }
  92
  93 // [EOF]
  94 ?>