1 package org.apache.maven.search;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.util.List;
23
24 /**
25 * A search engine response.
26 */
27 public interface SearchResponse
28 {
29 /**
30 * Returns the {@link SearchRequest} used for this response, never {@code null}.
31 */
32 SearchRequest getSearchRequest();
33
34 /**
35 * Returns the total count of hits produced by {@link #getSearchRequest()}.
36 */
37 int getTotalHits();
38
39 /**
40 * Returns the count of current hits in current "page". It may be less or equal to page size of {@link
41 * SearchRequest#getPaging()}.
42 */
43 int getCurrentHits();
44
45 /**
46 * Returns current "page" of results as list of records, never {@code null}.
47 */
48 List<Record> getPage();
49 }