[GitHub/WoltLab/WCF.git] / wcfsetup / install / files / lib / data / ISearchAction.class.php

<?php
namespace wcf\data;

/**
 * Every database object action whose objects can be searched via AJAX has to
 * implement this interface.
 * 
 * @author	Matthias Schmidt
 * @copyright	2001-2014 WoltLab GmbH
 * @license	GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
 * @package	com.woltlab.wcf
 * @subpackage	data
 * @category	Community Framework
 */
interface ISearchAction {
	/**
	 * Returns a list with data of objects that match the given search criteria.
	 * 
	 * @return	array<array>
	 */
	public function getSearchResultList();
	
	/**
	 * Validates the "getSearchResultList" action.
	 */
	public function validateGetSearchResultList();
}
Commit	Line	Data
a427a8c8 MS	1	<?php
	2	namespace wcf\data;
	3
	4	/**
	5	* Every database object action whose objects can be searched via AJAX has to
	6	* implement this interface.
	7	*
	8	* @author Matthias Schmidt
ca4ba303	9	* @copyright 2001-2014 WoltLab GmbH
a427a8c8 MS	10	* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
	11	* @package com.woltlab.wcf
	12	* @subpackage data
0c166126	13	* @category Community Framework
a427a8c8 MS	14	*/
	15	interface ISearchAction {
	16	/**
	17	* Returns a list with data of objects that match the given search criteria.
	18	*
	19	* @return array<array>
	20	*/
	21	public function getSearchResultList();
	22
	23	/**
	24	* Validates the "getSearchResultList" action.
	25	*/
	26	public function validateGetSearchResultList();
58e1d71f	27	}