View Javadoc
1   /*
2    * This file is part of ***  M y C o R e  ***
3    * See http://www.mycore.de/ for details.
4    *
5    * MyCoRe is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * MyCoRe 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 MyCoRe.  If not, see <http://www.gnu.org/licenses/>.
17   */
18  
19  package org.mycore.oai;
20  
21  import java.util.List;
22  import java.util.Optional;
23  
24  import org.mycore.oai.pmh.Header;
25  
26  /**
27   * The result of a searcher query.
28   * 
29   * @author Matthias Eichner
30   */
31  public interface MCROAIResult {
32  
33      /**
34       * Returns a list of mycore object identifiers.
35       * 
36       * @return list of mycore object identifiers
37       */
38      List<Header> list();
39  
40      /**
41       * Number of all hits
42       * 
43       * @return number of hits
44       */
45      int getNumHits();
46  
47      /**
48       * @return the next cursor
49       */
50      Optional<String> nextCursor();
51  
52  }