Package org.alfresco.rest.api.search.model

Class SearchQuery

java.lang.Object

org.alfresco.rest.api.search.model.SearchQuery

public class SearchQuery
extends Object

POJO class representing the JSON body for a search request

Author:

Gethin James

Field Summary

Fields

Modifier and Type	Field	Description
static SearchQuery	EMPTY

Constructor Summary

Constructors

Constructor

Description

SearchQuery(Query query, Paging paging, Boolean includeRequest, List<String> include, List<String> fields, List<SortDef> sort, List<Template> templates, Default defaults, List<FilterQuery> filterQueries, FacetFields facetFields, List<FacetQuery> facetQueries, Spelling spellcheck, Scope scope, Limits limits, org.alfresco.service.cmr.search.GeneralHighlightParameters highlight, org.alfresco.service.cmr.search.IntervalParameters facetIntervals, List<Pivot> pivots, List<org.alfresco.service.cmr.search.StatsRequestParameters> stats, List<org.alfresco.service.cmr.search.RangeParameters> ranges, Localization localization, org.alfresco.service.cmr.search.FacetFormat facetFormat)

Method Summary

Modifier and Type	Method	Description
Default	getDefaults()
FacetFields	getFacetFields()
org.alfresco.service.cmr.search.FacetFormat	getFacetFormat()
org.alfresco.service.cmr.search.IntervalParameters	getFacetIntervals()
List<FacetQuery>	getFacetQueries()
List<org.alfresco.service.cmr.search.RangeParameters>	getFacetRanges()
List<String>	getFields()
List<FilterQuery>	getFilterQueries()
org.alfresco.service.cmr.search.GeneralHighlightParameters	getHighlight()
List<String>	getInclude()
Limits	getLimits()
Localization	getLocalization()
Paging	getPaging()
List<Pivot>	getPivots()
Query	getQuery()
Scope	getScope()
List<SortDef>	getSort()
Spelling	getSpellcheck()
List<org.alfresco.service.cmr.search.StatsRequestParameters>	getStats()
List<Template>	getTemplates()
boolean	includeRequest()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final SearchQuery EMPTY

Constructor Detail

SearchQuery

public SearchQuery(Query query,
                   Paging paging,
                   Boolean includeRequest,
                   List<String> include,
                   List<String> fields,
                   List<SortDef> sort,
                   List<Template> templates,
                   Default defaults,
                   List<FilterQuery> filterQueries,
                   FacetFields facetFields,
                   List<FacetQuery> facetQueries,
                   Spelling spellcheck,
                   Scope scope,
                   Limits limits,
                   org.alfresco.service.cmr.search.GeneralHighlightParameters highlight,
                   org.alfresco.service.cmr.search.IntervalParameters facetIntervals,
                   List<Pivot> pivots,
                   List<org.alfresco.service.cmr.search.StatsRequestParameters> stats,
                   List<org.alfresco.service.cmr.search.RangeParameters> ranges,
                   Localization localization,
                   org.alfresco.service.cmr.search.FacetFormat facetFormat)

Method Detail

getQuery

public Query getQuery()

getPaging

public Paging getPaging()

getInclude

public List<String> getInclude()

getFields

public List<String> getFields()

getSort

public List<SortDef> getSort()

getTemplates

public List<Template> getTemplates()

getDefaults

public Default getDefaults()

getFilterQueries

public List<FilterQuery> getFilterQueries()

getFacetQueries

public List<FacetQuery> getFacetQueries()

getSpellcheck

public Spelling getSpellcheck()

getScope

public Scope getScope()

getFacetFields

public FacetFields getFacetFields()

getHighlight

public org.alfresco.service.cmr.search.GeneralHighlightParameters getHighlight()

getFacetIntervals

public org.alfresco.service.cmr.search.IntervalParameters getFacetIntervals()

getLimits

public Limits getLimits()

includeRequest

public boolean includeRequest()

getPivots

public List<Pivot> getPivots()

getStats

public List<org.alfresco.service.cmr.search.StatsRequestParameters> getStats()

getFacetRanges

public List<org.alfresco.service.cmr.search.RangeParameters> getFacetRanges()

getLocalization

public Localization getLocalization()

getFacetFormat

public org.alfresco.service.cmr.search.FacetFormat getFacetFormat()