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

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