Source for file SearchModule.interface.php

Documentation is available at SearchModule.interface.php

  1. <?php
    2. 

  2. /**
    3. 

  3.  * @package harmoni.osid_v2.repository.search
    4. 

  4.  * 
    5. 

  5.  * @copyright Copyright &copy; 2005, Middlebury College
    6. 

  6.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
    7. 

  7.  *
    8. 

  8.  * @version $Id: SearchModule.interface.php,v 1.6 2007/09/04 20:25:47 adamfranco Exp $
    9. 

  9.  */
    10. 

  10.  
    11. 

  11. /**
    12. 

  12.  * Search Modules implement the functionality of searching the digital repository
    13. 

  13.  * 
    14. 

  14.  *
    15. 

  15.  * @package harmoni.osid_v2.repository.search
    16. 

  16.  * 
    17. 

  17.  * @copyright Copyright &copy; 2005, Middlebury College
    18. 

  18.  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License (GPL)
    19. 

  19.  *
    20. 

  20.  * @version $Id: SearchModule.interface.php,v 1.6 2007/09/04 20:25:47 adamfranco Exp $
    21. 

  21.  */
    22. 

  22.  
    23. 

  23. class SearchModuleInterface {
    24. 

  24.         
    25. 

  25.     /**
    26. 

  26.      * Get the ids of the assets that match the search criteria
    27. 

  27.      * 
    28. 

  28.      * @param mixed $searchCriteria 
    29. 

  29.      * @return array 
    30. 

  30.      * @access public
    31. 

  31.      * @since 11/2/04
    32. 

  32.      */
    33. 

  33.     function searchAssets ( $searchCriteria ) {
    34. 

  34.         die ("Method <b>".__FUNCTION__."()</b> declared in interface <b> ".__CLASS__."</b> has not been overloaded in a child class.");
    35. 

  35.     }
    36. 

  36.     
    37. 

  37. }
    38. 

  38.  
    39. 

  39. ?>
    40.

Documentation generated on Wed, 19 Sep 2007 10:26:20 -0400 by phpDocumentor 1.3.0RC3