3 namespace CoreFramework\Database\Result;
5 // Import framework stuff
6 use CoreFramework\Criteria\Local\LocalSearchCriteria;
7 use CoreFramework\Generic\FrameworkInterface;
10 * An interface for searchable results
12 * @author Roland Haeder <webmaster@shipsimu.org>
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
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.
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.
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/>.
31 interface SearchableResult extends FrameworkInterface {
33 * Searches for an entry in the data result and returns it
35 * @param $criteriaInstance The criteria to look inside the data set
36 * @return $result Found result entry
38 function searchEntry (LocalSearchCriteria $criteriaInstance);
41 * Solver for result index value with call-back method
43 * @param $databaseColumn Database column where the index might be found
44 * @para $callBack Call-back object for setting the index
47 function solveResultIndex ($databaseColumn, DatabaseWrapper $wrapperInstance, array $callBack);