<?php
/*
     SearchInterface.php, interface for use by applications that wish to
                          participate in the search system
     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 applications using the Aukyla General Search System.
 *
 * You should implement this simple interface if your application wants to
 * collaborate in the Aukyla General Search System.
 *
 * Besides implementing this interface, your application should report its
 * documents using the Document::index() function to keep the database
 * up-to-date.
 *
 * @since Aukyla 1.1
 *
 * @sa Search, Document::index()
 */
interface SearchInterface
{
	/**
	 * Returns the full display name of the interface.
	 *
	 * @return The name of the interface.
	 */
	public function name();

	/**
	 * Index and report all documents the application contains.
	 *
	 * You should call Search::indexDocument() for reporting your documents.
	 */
	public function indexAll();
}

?>