]> git.mxchange.org Git - core.git/blob - framework/main/interfaces/criteria/store/class_StoreableCriteria.php
Continued:
[core.git] / framework / main / interfaces / criteria / store / 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 use Org\Mxchange\CoreFramework\Criteria\Local\LocalSearchCriteria;
8
9 /**
10  * An interface for storeable data sets
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.shipsimu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 interface StoreableCriteria extends Criteria {
32         /**
33          * Setter for table name
34          *
35          * @param       $tableName      Name of the table to set
36          * @return      void
37          */
38         function setTableName (string $tableName);
39
40         /**
41          * Getter for table name
42          *
43          * @return      $tableName      Name of the table to set
44          */
45         function getTableName ();
46
47         /**
48          * Setter for unique key
49          *
50          * @param       $uniqueKey      Column to use as unique key
51          * @return      void
52          */
53         function setUniqueKey (string $uniqueKey);
54
55         /**
56          * Getter for unique key
57          *
58          * @return      $uniqueKey      Column to use as unique key
59          */
60         function getUniqueKey ();
61
62         /**
63          * Setter for primary key
64          *
65          * @param       $primaryKey             Primary key to set
66          * @return      void
67          */
68         function setPrimaryKey (string $primaryKey);
69
70         /**
71          * Setter for primary key array
72          *
73          * @param       $primaryKeys    Primary key array to set
74          * @return      void
75          */
76         public function setPrimaryKeyCombined (array $primaryKeys);
77
78         /**
79          * Getter for primary keys
80          *
81          * @return      $primaryKeys    Primary key array
82          */
83         function getPrimaryKeys ();
84
85         /**
86          * Setter for search instance
87          *
88          * @param       $searchInstance         Searchable criteria instance
89          * @return      void
90          */
91         function setSearchInstance (LocalSearchCriteria $searchInstance);
92
93         /**
94          * Getter for search instance
95          *
96          * @return      $searchInstance         Searchable criteria instance
97          */
98         function getSearchInstance ();
99
100         /**
101          * Getter for unique key value
102          *
103          * @return      $uniqueValue    Value of the unique key
104          */
105         function getUniqueValue ();
106
107         /**
108          * Getter for primary key or unique key if not set
109          *
110          * @return      $primaryKey             Primary key or unique key if not set
111          */
112         function getPrimaryKey ();
113
114 }