<?php
/*
     SearchGatewayInterface.php, interface for creating gateways so searches
                                 can be hooked up to external search systems.
     Copyright (C) 2005 Arend van Beelen, Auton Rijnsburg

     This program is free software; you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by the Free
     Software Foundation; either version 2 of the License, or (at your option)
     any later version.

     This program is distributed in the hope that it will be useful, but WITHOUT
     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
     more details.

     You should have received a copy of the GNU General Public License along
     with this program; if not, write to the Free Software Foundation, Inc.,
     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

     For any questions, comments or whatever, you may mail me at: hide@address.com
*/

/**
 * @brief Interface for search gateways.
 *
 * You should implement this simple interface if you want to implement a
 * gateway to forward searches from the Aukyla General Search System.
 *
 * @since Aukyla 1.1
 *
 * @sa Search
 */
interface SearchGatewayInterface
{
	/**
	 * Returns the full display name of the gateway.
	 *
	 * @return The name of the gateway.
	 */
	public function name();

	/**
	 * Performs a search through the gateway.
	 *
	 * @param keywords   An array containing all keywords to search for.
	 * @param maxResults The maximum number of results to return per
	 *                   selected interface.
	 * @param offset     The offset of the results to return per interface.
	 *
	 * @return An array of SearchResult objects.
	 */
	public function search($keywords, $maxResults, $offset);
}

?>