3 namespace Org\Mxchange\CoreFramework\Criteria\Storing;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Criteria\Criteria;
9 * An interface for storeable data sets
11 * @author Roland Haeder <webmaster@shipsimu.org>
13 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
14 * @license GNU GPL 3.0 or any newer version
15 * @link http://www.shipsimu.org
17 * This program is free software: you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published by
19 * the Free Software Foundation, either version 3 of the License, or
20 * (at your option) any later version.
22 * This program is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
27 * You should have received a copy of the GNU General Public License
28 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 interface StoreableCriteria extends Criteria {
32 * Setter for table name
34 * @param $tableName Name of the table to set
37 function setTableName ($tableName);
40 * Getter for table name
42 * @return $tableName Name of the table to set
44 function getTableName ();
47 * Setter for unique key
49 * @param $uniqueKey Column to use as unique key
52 function setUniqueKey ($uniqueKey);
55 * Getter for unique key
57 * @return $uniqueKey Column to use as unique key
59 function getUniqueKey ();
62 * Getter for unique key value
64 * @return $uniqueValue Value of the unique key
66 function getUniqueValue ();
69 * Getter for primary key or unique key if not set
71 * @return $primaryKey Primary key or unique key if not set
73 function getPrimaryKey ();
76 * Setter for primary key
78 * @param $primaryKey Primary key to set
81 function setPrimaryKey ($primaryKey);
84 * Setter for primary key array
86 * @param $primaryKeys Primary key array to set
89 function setPrimaryKeyCombined (array $primaryKeys);
92 * Getter for primary keys
94 * @return $primaryKeys Primary key array
96 function getPrimaryKeys ();