3 namespace CoreFramework\Criteria;
6 * An interface for storeable data sets
8 * @author Roland Haeder <webmaster@shipsimu.org>
10 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
11 * @license GNU GPL 3.0 or any newer version
12 * @link http://www.shipsimu.org
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 interface StoreableCriteria extends Criteria {
29 * Setter for table name
31 * @param $tableName Name of the table to set
34 function setTableName ($tableName);
37 * Getter for table name
39 * @return $tableName Name of the table to set
41 function getTableName ();
44 * Setter for unique key
46 * @param $uniqueKey Column to use as unique key
49 function setUniqueKey ($uniqueKey);
52 * Getter for unique key
54 * @return $uniqueKey Column to use as unique key
56 function getUniqueKey ();
59 * Getter for unique key value
61 * @return $uniqueValue Value of the unique key
63 function getUniqueValue ();
66 * Getter for primary key or unique key if not set
68 * @return $primaryKey Primary key or unique key if not set
70 function getPrimaryKey ();
73 * Setter for primary key
75 * @param $primaryKey Primary key to set
78 function setPrimaryKey ($primaryKey);
81 * Setter for primary key array
83 * @param $primaryKeys Primary key array to set
86 function setPrimaryKeyCombined (array $primaryKeys);
89 * Getter for primary keys
91 * @return $primaryKeys Primary key array
93 function getPrimaryKeys ();