Interface SearchRequest

All Known Implementing Classes:

AbstractSearchRequest, PathSearchRequest

public interface SearchRequest

can be used to build queries from REST requests, use a SearchRequest.Builder to create the request and RestSearchService to execute it

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SearchRequest.Base
static interface	SearchRequest.Builder

Method Summary

Modifier and Type	Method	Description
void	addAdditionalCondition(Condition condition)
EntityBeanListFactory	createEntityBeanListFactory()
List<Condition>	getAdditionalConditions()
SearchRequest.Base	getBase()
Optional<Integer>	getLimit()
Optional<Integer>	getOffset()
Optional<RequestedPaths>	getPaths()
jakarta.ws.rs.core.MultivaluedMap<String,String>	getQueryParameters()
Optional<String>	getSort()
boolean	isAllKeys()	If set to true, the request returns the key path only and the whole result set without paging
void	setAllKeys(boolean allKeys)
void	setBase(SearchRequest.Base base)
void	setLimit(@Nullable Integer limit)
void	setOffset(@Nullable Integer offset)
void	setPaths(@Nullable RequestedPaths paths)
void	setSort(@Nullable String sort)

Method Details

getBase

SearchRequest.Base getBase()

setBase

void setBase(SearchRequest.Base base)

getOffset

Optional<Integer> getOffset()

setOffset

void setOffset(@Nullable Integer offset)

getLimit

Optional<Integer> getLimit()

setLimit

void setLimit(@Nullable Integer limit)

getSort

Optional<String> getSort()

setPaths

void setPaths(@Nullable RequestedPaths paths)

getPaths

Optional<RequestedPaths> getPaths()

setSort

void setSort(@Nullable String sort)

getQueryParameters

jakarta.ws.rs.core.MultivaluedMap<String,String> getQueryParameters()

getAdditionalConditions

List<Condition> getAdditionalConditions()

addAdditionalCondition

void addAdditionalCondition(Condition condition)

createEntityBeanListFactory

EntityBeanListFactory createEntityBeanListFactory()

setAllKeys

void setAllKeys(boolean allKeys)

isAllKeys

boolean isAllKeys()

If set to true, the request returns the key path only and the whole result set without paging