8e18e48f11853062c93330e06b0b4aef8d141dec
[core.git] / inc / main / interfaces / result / class_SearchableResult.php
1 <?php
2 /**
3  * An interface for searchable results
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
23  */
24 interface SearchableResult extends FrameworkInterface {
25         /**
26          * Searches for an entry in the data result and returns it
27          *
28          * @param       $criteriaInstance       The criteria to look inside the data set
29          * @return      $result                         Found result entry
30          */
31         function searchEntry (LocalSearchCriteria $criteriaInstance);
32
33         /**
34          * Solver for result index value with call-back method
35          *
36          * @param       $databaseColumn         Database column where the index might be found
37          * @para        $callBack                       Call-back object for setting the index
38          * @return      void
39          */
40         function solveResultIndex ($databaseColumn, DatabaseWrapper $wrapperInstance, array $callBack);
41 }
42
43 // [EOF]
44 ?>