org.uberfire.ext.security.management.api

Interface AbstractEntityManager.SearchRequest

All Known Implementing Classes:

SearchRequestImpl

Enclosing interface:

AbstractEntityManager<T,S extends Settings>

public static interface AbstractEntityManager.SearchRequest

The request parameters for performing entity searching on the backend security server.

Method Summary

Modifier and Type	Method and Description
Set<String>	getConstrainedIdentifiers() Constrained (not available to use) identifiers.
int	getPage() The page number for the search cursor.
int	getPageSize() The number of items for each page.
String	getSearchPattern() The search pattern string.
AbstractEntityManager.SearchRequest	setConstrainedIdentifiers(Set<String> constrainedIdentifiers) Constrained (not available to use) identifiers.

Method Detail

getSearchPattern

String getSearchPattern()

The search pattern string.

Returns:

The search pattern.

setConstrainedIdentifiers

AbstractEntityManager.SearchRequest setConstrainedIdentifiers(Set<String> constrainedIdentifiers)

Constrained (not available to use) identifiers.

If you don't want to include some entities in the response, add their identifiers in the collection.

getConstrainedIdentifiers

Set<String> getConstrainedIdentifiers()

Constrained (not available to use) identifiers.

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.