1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21 package org.opencastproject.oaipmh.persistence;
22
23 import java.util.List;
24
25 /**
26 * A single result of OAI-PMH.
27 */
28 public interface SearchResult {
29
30 /**
31 * The search item list
32 *
33 * @return Item list.
34 */
35 List<SearchResultItem> getItems();
36
37 /**
38 * Get the total number of items found, limited by the value returned by {@link #getLimit()}.
39 *
40 * @return The number.
41 */
42 long size();
43
44 /**
45 * Get the offset.
46 *
47 * @return The offset.
48 */
49 long getOffset();
50
51 /**
52 * Get the limit.
53 *
54 * @return The limit.
55 */
56 long getLimit();
57
58 }