PaginationStorage (ipf-commons-ihe-hpd 4.3.2 API)

All Known Implementing Classes:

EhcachePaginationStorage
```
public interface PaginationStorage
```
Since:

4.3

Author:

Dmytro Rud

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class PaginationStorage.TakeResult

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`store(byte[] cookie, List<SearchResultEntry> entries)`	Stores an initial set of result entries.
`PaginationStorage.TakeResult`	`take(PagedResultsResponseControl pagination)`	Removes at most the given count of result entries from the storage and returns them together with a flag indicating whether some more entries remain in the storage.

- Method Detail
  - store
```
void store(byte[] cookie,
           List<SearchResultEntry> entries)
```
    Stores an initial set of result entries.
    
    Parameters:
    
    cookie - cookie (key).
    
    entries - entries.
  - take
```
PaginationStorage.TakeResult take(PagedResultsResponseControl pagination)
                           throws Exception
```
    Removes at most the given count of result entries from the storage and returns them together with a flag indicating whether some more entries remain in the storage. If the cookie is unknown, the list of result entries will be empty.
    
    Parameters:
    
    pagination - an object containing the cookie (key) and the maximal count of result entries to return.
    
    Returns:
    
    result entries and the remaining entries' availability flag.
    
    Throws:
    
    Exception