1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.extension.repository.search

File AdvancedSearchable.java

 

Code metrics

0
0
0
1
51
9
0
-
-
0
-

Classes

Class Line # Actions
AdvancedSearchable 31 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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 search capabilities.
27    *
28    * @version $Id: cdf5121251ceb3b2f86903df0adc46c33447546c $
29    * @since 7.0M2
30    */
 
31    public interface AdvancedSearchable extends Searchable
32    {
33    /**
34    * @return true if the searched extensions can be filtered
35    */
36    boolean isFilterable();
37   
38    /**
39    * @return true if the searched extensions can be ordered
40    */
41    boolean isSortable();
42   
43    /**
44    * Search extension based of the provided query.
45    *
46    * @param query the query
47    * @return the found extensions descriptors, empty list if nothing could be found
48    * @throws SearchException error when trying to search provided query
49    */
50    IterableResult<Extension> search(ExtensionQuery query) throws SearchException;
51    }