SearchScrollResult (Hibernate Search 6.1.8.Final)

Type Parameters:

H - The type of hits.

All Known Subinterfaces:

ElasticsearchSearchScrollResult<H>, LuceneSearchScrollResult<H>

All Known Implementing Classes:

SimpleSearchScrollResult
```
public interface SearchScrollResult<H>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`hasHits()`	Returns true if this scrolling result contains some index hits.
`List<H>`	`hits()`
`boolean`	`timedOut()`
`Duration`	`took()`
`SearchResultTotal`	`total()`

- Method Detail
  - total
```
SearchResultTotal total()
```
    Returns:
    
    The total for a search result, pertaining to all matched documents, independently from the current chunk of hits(). Includes in particular the total hit count.
  - hasHits
```
boolean hasHits()
```
    Returns true if this scrolling result contains some index hits.
    Notice that it is possible for this method to return true while hits() returns an empty list, e.g.: if matching entities could not be found in the database.
    This methods is mainly useful as a stop condition in loops.
    
    Returns:
    
    if there are still some index result hits.
  - hits
```
List<H> hits()
```
    Returns:
    
    The hits of this scrolling result as a List containing one element for each matched entity.
  - took
```
Duration took()
```
    Returns:
    
    the time taken to process the request, as a Duration
  - timedOut
```
boolean timedOut()
```
    Returns:
    
    whether or not a timeout occurred processing the request.