]> git.mxchange.org Git - core.git/blob - inc/main/interfaces/criteria/extended/class_StoreableCriteria.php
07fa5573f9242292992e03f808860034e0591260
[core.git] / inc / main / interfaces / criteria / extended / class_StoreableCriteria.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Criteria;
4
5 /**
6  * An interface for storeable data sets
7  *
8  * @author              Roland Haeder <webmaster@shipsimu.org>
9  * @version             0.0.0
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
13  *
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.
18  *
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.
23  *
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/>.
26  */
27 interface StoreableCriteria extends Criteria {
28         /**
29          * Setter for table name
30          *
31          * @param       $tableName      Name of the table to set
32          * @return      void
33          */
34         function setTableName ($tableName);
35
36         /**
37          * Getter for table name
38          *
39          * @return      $tableName      Name of the table to set
40          */
41         function getTableName ();
42
43         /**
44          * Setter for unique key
45          *
46          * @param       $uniqueKey      Column to use as unique key
47          * @return      void
48          */
49         function setUniqueKey ($uniqueKey);
50
51         /**
52          * Getter for unique key
53          *
54          * @return      $uniqueKey      Column to use as unique key
55          */
56         function getUniqueKey ();
57
58         /**
59          * Getter for unique key value
60          *
61          * @return      $uniqueValue    Value of the unique key
62          */
63         function getUniqueValue ();
64
65         /**
66          * Getter for primary key or unique key if not set
67          *
68          * @return      $primaryKey             Primary key or unique key if not set
69          */
70         function getPrimaryKey ();
71
72         /**
73          * Setter for primary key
74          *
75          * @param       $primaryKey             Primary key to set
76          * @return      void
77          */
78         function setPrimaryKey ($primaryKey);
79
80         /**
81          * Setter for primary key array
82          *
83          * @param       $primaryKeys    Primary key array to set
84          * @return      void
85          */
86         function setPrimaryKeyCombined (array $primaryKeys);
87
88         /**
89          * Getter for primary keys
90          *
91          * @return      $primaryKeys    Primary key array
92          */
93         function getPrimaryKeys ();
94
95 }