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