framework/main/interfaces/result/class_SearchableResult.php

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