Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
Searchable | 32 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software 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 GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.extension.repository.search; | |
21 | ||
22 | import org.xwiki.extension.Extension; | |
23 | import org.xwiki.extension.repository.result.IterableResult; | |
24 | ||
25 | /** | |
26 | * A repository can implements it to provide basic search capabilities. | |
27 | * | |
28 | * @version $Id: 95e30244ddb74f61315d306f62a8b5eb28ff124c $ | |
29 | * @since 4.0M1 | |
30 | * @see AdvancedSearchable | |
31 | */ | |
32 | public interface Searchable | |
33 | { | |
34 | /** | |
35 | * Search extension based of the provided pattern. | |
36 | * <p> | |
37 | * The pattern is a simple character chain. | |
38 | * | |
39 | * @param pattern the pattern to search | |
40 | * @param offset the offset from where to start returning search results | |
41 | * @param nb the maximum number of search results to return | |
42 | * @return the found extensions descriptors, empty list if nothing could be found | |
43 | * @throws SearchException error when trying to search provided pattern | |
44 | */ | |
45 | IterableResult<Extension> search(String pattern, int offset, int nb) throws SearchException; | |
46 | } |