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 asstartIndex, query, orderBy- Since:
- 8.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSearchCriteria.BuilderA helper to createSearchCriteriainstancesstatic classSearchCriteria.FilterItemClass to hold filterable name, value pairs to further narrow down the search resultsstatic classSearchCriteria.OrderIndicator of order directionstatic classSearchCriteria.OrderByItemClass to hold the sortFieldName to order by and the direction of the order
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddFilterBy(SearchCriteria.FilterItem filterItem)voidaddOrderBy(SearchCriteria.OrderByItem orderByItem)List<SearchCriteria.FilterItem>getFilterBy()filter the returned results based on FilterItemintgetItemsRequested()Get the number of items requestedList<SearchCriteria.OrderByItem>getOrderBy()get the search results order by fieldStringgetQuery()Get the search Query stringintgetStartIndex()Get the start index of the search resultsvoidsetFilterBy(List<SearchCriteria.FilterItem> filterBy)voidsetItemsRequested(int itemsRequested)voidsetOrderBy(List<SearchCriteria.OrderByItem> orderBy)voidsetQuery(String query)voidsetStartIndex(int startIndex)
-
-
-
Method Detail
-
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)
-
-