EventSearchResult (XWiki Platform - Event Stream - API 15.4 API)

All Superinterfaces:

AutoCloseable
```
public interface EventSearchResult
extends AutoCloseable
```
The result of a search in the EventStore.

Since:

12.4RC1

Version:

$Id: e71ea78cb4f91f6f1b537e525ba496e5394b5e25 $

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static EventSearchResult EMPTY
  An empty instance of EventSearchResult.
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  long getOffset()
  
  long getSize()
  
  long getTotalHits()
  
  Stream<Event> stream()
  - Methods inherited from interface java.lang.AutoCloseable
    close

- Field Detail
  - EMPTY
```
static final EventSearchResult EMPTY
```
    An empty instance of EventSearchResult.
- Method Detail
  - getTotalHits
```
long getTotalHits()
```
    Returns:
    
    the total number of possible results without offset or maximum results limits
  - getOffset
```
long getOffset()
```
    Returns:
    
    the index in the total number of possible search result where this extract starts
  - getSize
```
long getSize()
```
    Returns:
    
    the number of found events
  - stream
```
Stream<Event> stream()
```
    Returns:
    
    a Stream containing the found events