Package org.alfresco.search.model

Class SearchRequest

java.lang.Object

org.alfresco.search.model.SearchRequest

@Validated
public class SearchRequest
extends Object

SearchRequest

Constructor Summary

Constructors

Constructor	Description
SearchRequest()

Method Summary

Modifier and Type	Method	Description
SearchRequest	addPivotsItem(RequestPivot pivotsItem)
SearchRequest	addRangesItem(RequestRange rangesItem)
SearchRequest	addStatsItem(RequestStats statsItem)
SearchRequest	defaults(RequestDefaults defaults)
boolean	equals(Object o)
SearchRequest	facetFields(RequestFacetFields facetFields)
SearchRequest	facetIntervals(RequestFacetIntervals facetIntervals)
SearchRequest	facetQueries(RequestFacetQueries facetQueries)
SearchRequest	fields(RequestFields fields)
SearchRequest	filterQueries(RequestFilterQueries filterQueries)
@Valid RequestDefaults	getDefaults()	Get defaults
@Valid RequestFacetFields	getFacetFields()	Get facetFields
@Valid RequestFacetIntervals	getFacetIntervals()	Get facetIntervals
@Valid RequestFacetQueries	getFacetQueries()	Get facetQueries
@Valid RequestFields	getFields()	Get fields
@Valid RequestFilterQueries	getFilterQueries()	Get filterQueries
@Valid RequestHighlight	getHighlight()	Get highlight
@Valid RequestInclude	getInclude()	Get include
@Valid RequestLimits	getLimits()	Get limits
@Valid RequestLocalization	getLocalization()	Get localization
@Valid RequestPagination	getPaging()	Get paging
@Valid List<RequestPivot>	getPivots()	Get pivots
@NotNull @Valid RequestQuery	getQuery()	Get query
@Valid List<RequestRange>	getRanges()	Get ranges
@Valid RequestScope	getScope()	Get scope
@Valid RequestSortDefinition	getSort()	Get sort
@Valid RequestSpellcheck	getSpellcheck()	Get spellcheck
@Valid List<RequestStats>	getStats()	Get stats
@Valid RequestTemplates	getTemplates()	Get templates
int	hashCode()
SearchRequest	highlight(RequestHighlight highlight)
SearchRequest	include(RequestInclude include)
SearchRequest	includeRequest(Boolean includeRequest)
Boolean	isIncludeRequest()	When true, include the original request in the response
SearchRequest	limits(RequestLimits limits)
SearchRequest	localization(RequestLocalization localization)
SearchRequest	paging(RequestPagination paging)
SearchRequest	pivots(List<RequestPivot> pivots)
SearchRequest	query(RequestQuery query)
SearchRequest	ranges(List<RequestRange> ranges)
SearchRequest	scope(RequestScope scope)
void	setDefaults(RequestDefaults defaults)
void	setFacetFields(RequestFacetFields facetFields)
void	setFacetIntervals(RequestFacetIntervals facetIntervals)
void	setFacetQueries(RequestFacetQueries facetQueries)
void	setFields(RequestFields fields)
void	setFilterQueries(RequestFilterQueries filterQueries)
void	setHighlight(RequestHighlight highlight)
void	setInclude(RequestInclude include)
void	setIncludeRequest(Boolean includeRequest)
void	setLimits(RequestLimits limits)
void	setLocalization(RequestLocalization localization)
void	setPaging(RequestPagination paging)
void	setPivots(List<RequestPivot> pivots)
void	setQuery(RequestQuery query)
void	setRanges(List<RequestRange> ranges)
void	setScope(RequestScope scope)
void	setSort(RequestSortDefinition sort)
void	setSpellcheck(RequestSpellcheck spellcheck)
void	setStats(List<RequestStats> stats)
void	setTemplates(RequestTemplates templates)
SearchRequest	sort(RequestSortDefinition sort)
SearchRequest	spellcheck(RequestSpellcheck spellcheck)
SearchRequest	stats(List<RequestStats> stats)
SearchRequest	templates(RequestTemplates templates)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SearchRequest

public SearchRequest()

Method Details

query

public SearchRequest query(RequestQuery query)

getQuery

@NotNull
@Valid
public @NotNull @Valid RequestQuery getQuery()

Get query

Returns:

query

setQuery

public void setQuery(RequestQuery query)

paging

public SearchRequest paging(RequestPagination paging)

getPaging

@Valid
public @Valid RequestPagination getPaging()

Get paging

Returns:

paging

setPaging

public void setPaging(RequestPagination paging)

include

public SearchRequest include(RequestInclude include)

getInclude

@Valid
public @Valid RequestInclude getInclude()

Get include

Returns:

include

setInclude

public void setInclude(RequestInclude include)

includeRequest

public SearchRequest includeRequest(Boolean includeRequest)

isIncludeRequest

public Boolean isIncludeRequest()

When true, include the original request in the response

Returns:

includeRequest

setIncludeRequest

public void setIncludeRequest(Boolean includeRequest)

fields

public SearchRequest fields(RequestFields fields)

getFields

@Valid
public @Valid RequestFields getFields()

Get fields

Returns:

fields

setFields

public void setFields(RequestFields fields)

sort

public SearchRequest sort(RequestSortDefinition sort)

getSort

@Valid
public @Valid RequestSortDefinition getSort()

Get sort

Returns:

sort

setSort

public void setSort(RequestSortDefinition sort)

templates

public SearchRequest templates(RequestTemplates templates)

getTemplates

@Valid
public @Valid RequestTemplates getTemplates()

Get templates

Returns:

templates

setTemplates

public void setTemplates(RequestTemplates templates)

defaults

public SearchRequest defaults(RequestDefaults defaults)

getDefaults

@Valid
public @Valid RequestDefaults getDefaults()

Get defaults

Returns:

defaults

setDefaults

public void setDefaults(RequestDefaults defaults)

localization

public SearchRequest localization(RequestLocalization localization)

getLocalization

@Valid
public @Valid RequestLocalization getLocalization()

Get localization

Returns:

localization

setLocalization

public void setLocalization(RequestLocalization localization)

filterQueries

public SearchRequest filterQueries(RequestFilterQueries filterQueries)

getFilterQueries

@Valid
public @Valid RequestFilterQueries getFilterQueries()

Get filterQueries

Returns:

filterQueries

setFilterQueries

public void setFilterQueries(RequestFilterQueries filterQueries)

facetQueries

public SearchRequest facetQueries(RequestFacetQueries facetQueries)

getFacetQueries

@Valid
public @Valid RequestFacetQueries getFacetQueries()

Get facetQueries

Returns:

facetQueries

setFacetQueries

public void setFacetQueries(RequestFacetQueries facetQueries)

facetFields

public SearchRequest facetFields(RequestFacetFields facetFields)

getFacetFields

@Valid
public @Valid RequestFacetFields getFacetFields()

Get facetFields

Returns:

facetFields

setFacetFields

public void setFacetFields(RequestFacetFields facetFields)

facetIntervals

public SearchRequest facetIntervals(RequestFacetIntervals facetIntervals)

getFacetIntervals

@Valid
public @Valid RequestFacetIntervals getFacetIntervals()

Get facetIntervals

Returns:

facetIntervals

setFacetIntervals

public void setFacetIntervals(RequestFacetIntervals facetIntervals)

pivots

public SearchRequest pivots(List<RequestPivot> pivots)

addPivotsItem

public SearchRequest addPivotsItem(RequestPivot pivotsItem)

getPivots

@Valid
public @Valid List<RequestPivot> getPivots()

Get pivots

Returns:

pivots

setPivots

public void setPivots(List<RequestPivot> pivots)

stats

public SearchRequest stats(List<RequestStats> stats)

addStatsItem

public SearchRequest addStatsItem(RequestStats statsItem)

getStats

@Valid
public @Valid List<RequestStats> getStats()

Get stats

Returns:

stats

setStats

public void setStats(List<RequestStats> stats)

spellcheck

public SearchRequest spellcheck(RequestSpellcheck spellcheck)

getSpellcheck

@Valid
public @Valid RequestSpellcheck getSpellcheck()

Get spellcheck

Returns:

spellcheck

setSpellcheck

public void setSpellcheck(RequestSpellcheck spellcheck)

scope

public SearchRequest scope(RequestScope scope)

getScope

@Valid
public @Valid RequestScope getScope()

Get scope

Returns:

scope

setScope

public void setScope(RequestScope scope)

limits

public SearchRequest limits(RequestLimits limits)

getLimits

@Valid
public @Valid RequestLimits getLimits()

Get limits

Returns:

limits

setLimits

public void setLimits(RequestLimits limits)

highlight

public SearchRequest highlight(RequestHighlight highlight)

getHighlight

@Valid
public @Valid RequestHighlight getHighlight()

Get highlight

Returns:

highlight

setHighlight

public void setHighlight(RequestHighlight highlight)

ranges

public SearchRequest ranges(List<RequestRange> ranges)

addRangesItem

public SearchRequest addRangesItem(RequestRange rangesItem)

getRanges

@Valid
public @Valid List<RequestRange> getRanges()

Get ranges

Returns:

ranges

setRanges

public void setRanges(List<RequestRange> ranges)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object