org.craftercms.search.service

Interface Query

All Known Implementing Classes:

QueryParams, SolrQuery

public interface Query

Base query that is passed to SearchService.search(Query).

Author:

Alfonso Vásquez

Method Summary

Modifier and Type	Method and Description
String[]	getFieldsToReturn() Returns the fields that should be returned.
int	getNumResults() Returns the number of results to return.
int	getOffset() Returns the offset of the results.
String	getQuery() Returns the actual query.
boolean	isDisableAdditionalFilters() Returns true if the additional Crafter Search filters should be disabled on query execution.
Query	setDisableAdditionalFilters(boolean disableAdditionalFilters) Sets if the additional Crafter Search filters should be disabled on query execution.
Query	setFieldsToReturn(String... fieldsToReturn) Sets the fields that should be returned.
Query	setNumResults(int numResults) Sets the number of results to return.
Query	setOffset(int offset) Sets the offset of the results.
Query	setQuery(String query) Sets the actual query.
String	toUrlQueryString() Converts this query to an URL query string.

Method Detail

setOffset

Query setOffset(int offset)

Sets the offset of the results.

getOffset

int getOffset()

Returns the offset of the results.

setNumResults

Query setNumResults(int numResults)

Sets the number of results to return.

getNumResults

int getNumResults()

Returns the number of results to return.

setFieldsToReturn

Query setFieldsToReturn(String... fieldsToReturn)

Sets the fields that should be returned.

getFieldsToReturn

String[] getFieldsToReturn()

Returns the fields that should be returned.

setQuery

Query setQuery(String query)

Sets the actual query.

getQuery

String getQuery()

Returns the actual query.

setDisableAdditionalFilters

Query setDisableAdditionalFilters(boolean disableAdditionalFilters)

Sets if the additional Crafter Search filters should be disabled on query execution.

isDisableAdditionalFilters

boolean isDisableAdditionalFilters()

Returns true if the additional Crafter Search filters should be disabled on query execution.

toUrlQueryString

String toUrlQueryString()

Converts this query to an URL query string.