1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rest.internal.resources.search

File SearchSource.java

 

Code metrics

0
0
0
1
42
12
0
-
-
0
-

Classes

Class Line # Actions
SearchSource 37 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.rest.internal.resources.search;
21   
22    import java.util.List;
23   
24    import javax.ws.rs.core.UriInfo;
25   
26    import org.xwiki.component.annotation.Role;
27    import org.xwiki.rest.model.jaxb.SearchResult;
28   
29    /**
30    * Execute a search query.
31    *
32    * @version $Id: 219069bb5e0a8b3ed4f75188e5a6eed2b2eb9df3 $
33    * @since 6.1M2
34    */
35    // TODO: this is wrong, each search type should provide it's own REST API
36    @Role
 
37    public interface SearchSource
38    {
39    List<SearchResult> search(String query, String wikiName, String wikis, boolean hasProgrammingRights,
40    String orderField, String order, boolean distinct, int number, int start, Boolean withPrettyNames,
41    String className, UriInfo uriInfo) throws Exception;
42    }