View Javadoc

1   /*
2    *  XNap - A P2P framework and client.
3    *
4    *  See the file AUTHORS for copyright information.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation.
9    *
10   *  This program is distributed in the hope that it will be useful,
11   *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12   *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   *  GNU General Public License for more details.
14   *
15   *  You should have received a copy of the GNU General Public License
16   *  along with this program; if not, write to the Free Software
17   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  
20  package org.xnap.search;
21  
22  /***
23   * Defines the requirements for classes that provide search support.
24   */
25  public interface SearchProvider {
26  
27      // --- Constants(s) ---
28  
29      // --- Method(s) ---
30  
31      /***
32       * Returns an array of {@link MediaType} objects that are supported
33       * by the provider.
34       */
35      MediaType[] getSupportedMediaTypes();
36  
37      /***
38       * Returns the name of the search network that is displayed to the user.
39       */
40      String getName();
41  
42      /***
43       * Invoked when a search is requested.
44       */
45      Search search(SearchFilter filter);
46  
47  }
48