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