org.uberfire.ext.security.management.impl

Class SearchResponseImpl<T>

java.lang.Object

org.uberfire.ext.security.management.impl.SearchResponseImpl<T>

All Implemented Interfaces:

AbstractEntityManager.SearchResponse<T>

@Portable
public class SearchResponseImpl<T>
extends Object
implements AbstractEntityManager.SearchResponse<T>

A default search response implementation for the users system management.

Since:

0.8.0

Constructor Summary

Constructors

Constructor and Description
SearchResponseImpl()
SearchResponseImpl(List<T> results, int page, int pageSize, int total, boolean hasNextPage)

Method Summary

Modifier and Type	Method and Description
int	getPage() The page number for the search cursor.
int	getPageSize() The number of items for each page.
List<T>	getResults() The entities resulting from the search operation.
String	getSearchPattern() The search pattern string.
int	getTotal() The total entities count.
boolean	hasNextPage() Indicates if there are more results (next pages).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResponseImpl

public SearchResponseImpl()

SearchResponseImpl

public SearchResponseImpl(List<T> results,
                          int page,
                          int pageSize,
                          int total,
                          boolean hasNextPage)

Method Detail

getResults

public List<T> getResults()

Description copied from interface: AbstractEntityManager.SearchResponse

The entities resulting from the search operation.

Specified by:

getResults in interface AbstractEntityManager.SearchResponse<T>

Returns:

The entities resulting from the search operation.

getTotal

public int getTotal()

Description copied from interface: AbstractEntityManager.SearchResponse

The total entities count.

Specified by:

getTotal in interface AbstractEntityManager.SearchResponse<T>

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

public boolean hasNextPage()

Description copied from interface: AbstractEntityManager.SearchResponse

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.

Specified by:

hasNextPage in interface AbstractEntityManager.SearchResponse<T>

Returns:

Indicates if there are more results (next pages).

getSearchPattern

public String getSearchPattern()

Description copied from interface: AbstractEntityManager.SearchResponse

The search pattern string.

Specified by:

getSearchPattern in interface AbstractEntityManager.SearchResponse<T>

Returns:

The search pattern.

getPage

public int getPage()

Description copied from interface: AbstractEntityManager.SearchResponse

The page number for the search cursor.

IMPORTANT NOTE: Page number starts with value 1.

Specified by:

getPage in interface AbstractEntityManager.SearchResponse<T>

Returns:

The page for the returned results.

getPageSize

public int getPageSize()

Description copied from interface: AbstractEntityManager.SearchResponse

The number of items for each page.

Specified by:

getPageSize in interface AbstractEntityManager.SearchResponse<T>

Returns:

The page size.