Continued:
[core.git] / inc / main / interfaces / result / class_SearchableResult.php
1 <?php
2 // Own namespace
3 namespace CoreFramework\Database\Result;
4
5 // Import framework stuff
6 use CoreFramework\Criteria\Local\LocalSearchCriteria;
7 use CoreFramework\Generic\FrameworkInterface;
8
9 /**
10  * An interface for searchable results
11  *
12  * @author              Roland Haeder <webmaster@shipsimu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 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 SearchableResult extends FrameworkInterface {
32         /**
33          * Searches for an entry in the data result and returns it
34          *
35          * @param       $criteriaInstance       The criteria to look inside the data set
36          * @return      $result                         Found result entry
37          */
38         function searchEntry (LocalSearchCriteria $criteriaInstance);
39
40         /**
41          * Solver for result index value with call-back method
42          *
43          * @param       $databaseColumn         Database column where the index might be found
44          * @para        $callBack                       Call-back object for setting the index
45          * @return      void
46          */
47         function solveResultIndex ($databaseColumn, DatabaseWrapper $wrapperInstance, array $callBack);
48
49 }