Renamed Registry -> GenericRegistry to make it clear that this registry does
[core.git] / 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  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
14  * @license             GNU GPL 3.0 or any newer version
15  * @link                http://www.shipsimu.org
16  *
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.
21  *
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.
26  *
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/>.
29  */
30 interface StoreableCriteria extends Criteria {
31         /**
32          * Setter for table name
33          *
34          * @param       $tableName      Name of the table to set
35          * @return      void
36          */
37         function setTableName ($tableName);
38
39         /**
40          * Getter for table name
41          *
42          * @return      $tableName      Name of the table to set
43          */
44         function getTableName ();
45
46         /**
47          * Setter for unique key
48          *
49          * @param       $uniqueKey      Column to use as unique key
50          * @return      void
51          */
52         function setUniqueKey ($uniqueKey);
53
54         /**
55          * Getter for unique key
56          *
57          * @return      $uniqueKey      Column to use as unique key
58          */
59         function getUniqueKey ();
60
61         /**
62          * Getter for unique key value
63          *
64          * @return      $uniqueValue    Value of the unique key
65          */
66         function getUniqueValue ();
67
68         /**
69          * Getter for primary key or unique key if not set
70          *
71          * @return      $primaryKey             Primary key or unique key if not set
72          */
73         function getPrimaryKey ();
74
75         /**
76          * Setter for primary key
77          *
78          * @param       $primaryKey             Primary key to set
79          * @return      void
80          */
81         function setPrimaryKey ($primaryKey);
82
83         /**
84          * Setter for primary key array
85          *
86          * @param       $primaryKeys    Primary key array to set
87          * @return      void
88          */
89         function setPrimaryKeyCombined (array $primaryKeys);
90
91         /**
92          * Getter for primary keys
93          *
94          * @return      $primaryKeys    Primary key array
95          */
96         function getPrimaryKeys ();
97
98 }