Package org.alfresco.rest.search

Class SearchRequest

java.lang.Object

org.alfresco.utility.model.TestModel

org.alfresco.rest.search.SearchRequest

All Implemented Interfaces:

org.alfresco.utility.model.Model

public class SearchRequest
extends org.alfresco.utility.model.TestModel

Search Query object.

Author:

msuzuki

Constructor Summary

Constructors

Constructor	Description
SearchRequest()
SearchRequest(RestRequestQueryModel query)
SearchRequest(RestRequestQueryModel query, RestRequestHighlightModel highlight)

Method Summary

Modifier and Type	Method	Description
SearchRequest	addSortClause(java.lang.String type, java.lang.String fieldname, boolean ascending)	Adds a new sort clause to this request.
RestRequestFacetFieldsModel	getFacetFields()
java.lang.String	getFacetFormat()
RestRequestFacetIntervalsModel	getFacetIntervals()
java.util.List<FacetQuery>	getFacetQueries()
java.util.List<java.lang.String>	getFields()
RestRequestFilterQueryModel	getFilterQueries()
RestRequestHighlightModel	getHighlight()
java.util.List<java.lang.String>	getInclude()	Returns the include options in this request.
java.lang.Boolean	getIncludeRequest()
java.lang.String	getLanguage()
Pagination	getPaging()
java.util.List<RestRequestPivotModel>	getPivots()
RestRequestQueryModel	getQuery()
java.util.List<RestRequestRangesModel>	getRanges()
java.util.List<SortClause>	getSort()
RestRequestSpellcheckModel	getSpellcheck()
java.util.List<RestRequestStatsModel>	getStats()
void	setFacetFields(RestRequestFacetFieldsModel facetFields)
void	setFacetFormat(java.lang.String facetFormat)
void	setFacetIntervals(RestRequestFacetIntervalsModel facetIntervals)
void	setFacetQueries(java.util.List<FacetQuery> facetQueries)
void	setFields(java.util.List<java.lang.String> fields)
void	setFilterQueries(RestRequestFilterQueryModel filterQueries)
void	setHighlight(RestRequestHighlightModel highlight)
void	setInclude(java.util.List<java.lang.String> options)	Sets the include options within this request.
void	setIncludeRequest(java.lang.Boolean includeRequest)
void	setLanguage(java.lang.String language)
void	setPaging(Pagination paging)
void	setPivots(java.util.List<RestRequestPivotModel> pivots)
void	setQuery(RestRequestQueryModel query)
void	setRanges(java.util.List<RestRequestRangesModel> ranges)
void	setSpellcheck(RestRequestSpellcheckModel spellcheck)
void	setStats(java.util.List<RestRequestStatsModel> stats)

Methods inherited from class org.alfresco.utility.model.TestModel

setRandomValuesForAllFields, toInfo, toJson, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(RestRequestQueryModel query)

SearchRequest

public SearchRequest(RestRequestQueryModel query,
                     RestRequestHighlightModel highlight)

Method Detail

getQuery

public RestRequestQueryModel getQuery()

setQuery

public void setQuery(RestRequestQueryModel query)

getLanguage

public java.lang.String getLanguage()

setLanguage

public void setLanguage(java.lang.String language)

getInclude

public java.util.List<java.lang.String> getInclude()

Returns the include options in this request.

Returns:

the include options in this request.

setInclude

public void setInclude(java.util.List<java.lang.String> options)

Sets the include options within this request.

Parameters:

options - the include options.

getHighlight

public RestRequestHighlightModel getHighlight()

setHighlight

public void setHighlight(RestRequestHighlightModel highlight)

getFacetFields

public RestRequestFacetFieldsModel getFacetFields()

setFacetFields

public void setFacetFields(RestRequestFacetFieldsModel facetFields)

getFacetQueries

public java.util.List<FacetQuery> getFacetQueries()

setFacetQueries

public void setFacetQueries(java.util.List<FacetQuery> facetQueries)

getFacetIntervals

public RestRequestFacetIntervalsModel getFacetIntervals()

setFacetIntervals

public void setFacetIntervals(RestRequestFacetIntervalsModel facetIntervals)

getSpellcheck

public RestRequestSpellcheckModel getSpellcheck()

setSpellcheck

public void setSpellcheck(RestRequestSpellcheckModel spellcheck)

getIncludeRequest

public java.lang.Boolean getIncludeRequest()

setIncludeRequest

public void setIncludeRequest(java.lang.Boolean includeRequest)

getPivots

public java.util.List<RestRequestPivotModel> getPivots()

setPivots

public void setPivots(java.util.List<RestRequestPivotModel> pivots)

getStats

public java.util.List<RestRequestStatsModel> getStats()

setStats

public void setStats(java.util.List<RestRequestStatsModel> stats)

getPaging

public Pagination getPaging()

setPaging

public void setPaging(Pagination paging)

getFilterQueries

public RestRequestFilterQueryModel getFilterQueries()

setFilterQueries

public void setFilterQueries(RestRequestFilterQueryModel filterQueries)

getRanges

public java.util.List<RestRequestRangesModel> getRanges()

setRanges

public void setRanges(java.util.List<RestRequestRangesModel> ranges)

getFacetFormat

public java.lang.String getFacetFormat()

setFacetFormat

public void setFacetFormat(java.lang.String facetFormat)

getFields

public java.util.List<java.lang.String> getFields()

setFields

public void setFields(java.util.List<java.lang.String> fields)

getSort

public java.util.List<SortClause> getSort()

addSortClause

public SearchRequest addSortClause(java.lang.String type,
                                   java.lang.String fieldname,
                                   boolean ascending)

Adds a new sort clause to this request. The method uses a fluent approach and it returns the same SearchRequest instance.

Parameters:

type - the sort clause type (e.g. FIELD)

fieldname - the field name.

ascending - the sort criterion.

Returns:

this SearchRequest instance.