3 * An interface for storeable data sets
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
24 interface StoreableCriteria extends Criteria {
26 * Setter for table name
28 * @param $tableName Name of the table to set
31 function setTableName ($tableName);
34 * Getter for table name
36 * @return $tableName Name of the table to set
38 function getTableName ();
41 * Setter for unique key
43 * @param $uniqueKey Column to use as unique key
46 function setUniqueKey ($uniqueKey);
49 * Getter for unique key
51 * @return $uniqueKey Column to use as unique key
53 function getUniqueKey ();
56 * Getter for unique key value
58 * @return $uniqueValue Value of the unique key
60 function getUniqueValue ();
63 * Getter for primary key or unique key if not set
65 * @return $primaryKey Primary key or unique key if not set
67 function getPrimaryKey ();
70 * Setter for primary key
72 * @param $primaryKey Primary key to set
75 function setPrimaryKey ($primaryKey);
78 * Setter for primary key array
80 * @param $primaryKeys Primary key array to set
83 function setPrimaryKeyCombined (array $primaryKeys);
86 * Getter for primary keys
88 * @return $primaryKeys Primary key array
90 function getPrimaryKeys ();