Interface AbstractEntityManager.SearchResponse<T>
-
- Type Parameters:
T- The entity type.
- All Known Implementing Classes:
SearchResponseImpl
- Enclosing interface:
- AbstractEntityManager<T,S extends Settings>
public static interface AbstractEntityManager.SearchResponse<T>The response values for a search operation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetPage()The page number for the search cursor.intgetPageSize()The number of items for each page.List<T>getResults()The entities resulting from the search operation.StringgetSearchPattern()The search pattern string.intgetTotal()The total entities count.booleanhasNextPage()Indicates if there are more results (next pages).
-
-
-
Method Detail
-
getResults
List<T> getResults()
The entities resulting from the search operation.
- Returns:
- The entities resulting from the search operation.
-
getTotal
int getTotal()
The total entities count.
- Returns:
By convention, if the service provider implementation class is not able to get the row count, this method should return
-1.Otherwise, returns search results count for this entity type.
-
hasNextPage
boolean hasNextPage()
Indicates if there are more results (next pages).
If the service provider implementation class is not able to return a value for
getTotal, this method can be used to find out if there are more pages.- Returns:
- Indicates if there are more results (next pages).
-
getSearchPattern
String getSearchPattern()
The search pattern string.
- Returns:
- The search pattern.
-
getPage
int getPage()
The page number for the search cursor.
IMPORTANT NOTE: Page number starts with value
1.- Returns:
- The page for the returned results.
-
getPageSize
int getPageSize()
The number of items for each page.
- Returns:
- The page size.
-
-