Package com.pingidentity.sdk

Class SearchCriteria

java.lang.Object

com.pingidentity.sdk.SearchCriteria

public class SearchCriteria
extends Object

SearchCriteria object to hold all the relevant data for searching. Specify criteria such as startIndex, query, orderBy

Since:

8.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchCriteria.Builder	A helper to create SearchCriteria instances
static final class	SearchCriteria.FilterItem	Class to hold filterable name, value pairs to further narrow down the search results
static enum	SearchCriteria.Order	Indicator of order direction
static final class	SearchCriteria.OrderByItem	Class to hold the sortFieldName to order by and the direction of the order

Method Summary

Modifier and Type	Method	Description
void	addFilterBy(SearchCriteria.FilterItem filterItem)
void	addOrderBy(SearchCriteria.OrderByItem orderByItem)
List<SearchCriteria.FilterItem>	getFilterBy()	filter the returned results based on FilterItem
int	getItemsRequested()	Get the number of items requested
List<SearchCriteria.OrderByItem>	getOrderBy()	get the search results order by field
String	getQuery()	Get the search Query string
int	getStartIndex()	Get the start index of the search results
void	setFilterBy(List<SearchCriteria.FilterItem> filterBy)
void	setItemsRequested(int itemsRequested)
void	setOrderBy(List<SearchCriteria.OrderByItem> orderBy)
void	setQuery(String query)
void	setStartIndex(int startIndex)

Methods inherited from class java.lang.Object

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

Method Details

getQuery

public String getQuery()

Get the search Query string

Returns:

search query

setQuery

public void setQuery(String query)

getStartIndex

public int getStartIndex()

Get the start index of the search results

Returns:

start index of the search results

setStartIndex

public void setStartIndex(int startIndex)

getItemsRequested

public int getItemsRequested()

Get the number of items requested

Returns:

number of items requested

setItemsRequested

public void setItemsRequested(int itemsRequested)

addOrderBy

public void addOrderBy(SearchCriteria.OrderByItem orderByItem)

addFilterBy

public void addFilterBy(SearchCriteria.FilterItem filterItem)

getFilterBy

public List<SearchCriteria.FilterItem> getFilterBy()

filter the returned results based on FilterItem

Returns:

filtered search results based on the given criteria

setFilterBy

public void setFilterBy(List<SearchCriteria.FilterItem> filterBy)

getOrderBy

public List<SearchCriteria.OrderByItem> getOrderBy()

get the search results order by field

Returns:

order by field of search results

setOrderBy

public void setOrderBy(List<SearchCriteria.OrderByItem> orderBy)