org.uberfire.ext.security.management.impl

Class SearchRequestImpl

java.lang.Object

org.uberfire.ext.security.management.impl.SearchRequestImpl

All Implemented Interfaces:

AbstractEntityManager.SearchRequest

@Portable
public class SearchRequestImpl
extends Object
implements AbstractEntityManager.SearchRequest

A default search request implementation for the users system management.

Since:

0.8.0

Constructor Summary

Constructors

Constructor and Description
SearchRequestImpl()
SearchRequestImpl(String searchPattern, int page, int pageSize)
SearchRequestImpl(String searchPattern, int page, int pageSize, Set<String> constrainedIdentifiers)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRequestImpl

public SearchRequestImpl()

SearchRequestImpl

public SearchRequestImpl(String searchPattern,
                         int page,
                         int pageSize)

SearchRequestImpl

public SearchRequestImpl(String searchPattern,
                         int page,
                         int pageSize,
                         Set<String> constrainedIdentifiers)

Method Detail

getSearchPattern

public String getSearchPattern()

Description copied from interface: AbstractEntityManager.SearchRequest

The search pattern string.

Specified by:

getSearchPattern in interface AbstractEntityManager.SearchRequest

Returns:

The search pattern.

setConstrainedIdentifiers

public AbstractEntityManager.SearchRequest setConstrainedIdentifiers(Set<String> constrainedIdentifiers)

Description copied from interface: AbstractEntityManager.SearchRequest

Constrained (not available to use) identifiers.

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

Specified by:

setConstrainedIdentifiers in interface AbstractEntityManager.SearchRequest

getConstrainedIdentifiers

public Set<String> getConstrainedIdentifiers()

Description copied from interface: AbstractEntityManager.SearchRequest

Constrained (not available to use) identifiers.

Specified by:

getConstrainedIdentifiers in interface AbstractEntityManager.SearchRequest

getPage

public int getPage()

Description copied from interface: AbstractEntityManager.SearchRequest

The page number for the search cursor.

IMPORTANT NOTE: Page number starts with value 1.

Specified by:

getPage in interface AbstractEntityManager.SearchRequest

Returns:

The page for the returned results.

getPageSize

public int getPageSize()

Description copied from interface: AbstractEntityManager.SearchRequest

The number of items for each page.

Specified by:

getPageSize in interface AbstractEntityManager.SearchRequest

Returns:

The page size.