java.lang.Object
- org.alfresco.repo.search.impl.querymodel.QueryOptions

Direct Known Subclasses:

CMISQueryOptions
```
public class QueryOptions
extends Object
```
The options for a query

Author:

andyh

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class QueryOptions.Connective

Constructor Summary

Constructors
Constructor	Description
`QueryOptions(String query, StoreRef storeRef)`	Create a CMISQueryOptions instance with the default options other than the query and store ref.
`QueryOptions(String query, StoreRef storeRef, Locale locale)`	Create a CMISQueryOptions instance with the default options other than the query, store ref and locale.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addQueryTemplate(String name, String template)`	Add/replace a query template Not all languages support query templates
`static QueryOptions`	`create(SearchParameters searchParameters)`
`SearchParameters`	`getAsSearchParmeters()`
`String`	`getDefaultFieldName()`
`QueryOptions.Connective`	`getDefaultFTSConnective()`	Get the default connective used when OR and AND are not specified for the FTS contains() function.
`QueryOptions.Connective`	`getDefaultFTSFieldConnective()`	As getDefaultFTSConnective() but for field groups
`boolean`	`getExcludeTenantFilter()`
`List<Locale>`	`getLocales()`	Get the list of locales to use for the query
`int`	`getMaxItems()`	Get the max number of rows for the result set 0 or less is unlimited
`int`	`getMaxPermissionChecks()`
`long`	`getMaxPermissionCheckTimeMillis()`
`Integer`	`getMaxRawResultSetSizeForInMemorySort()`
`MLAnalysisMode`	`getMlAnalaysisMode()`	Get the mode for multi-lingual text analaysis
`String`	`getQuery()`	Get the query string
`QueryConsistency`	`getQueryConsistency()`
`List<QueryParameterDefinition>`	`getQueryParameterDefinitions()`	Get the query parameters
`Map<String,String>`	`getQueryTemplates()`	Get the query templates
`Long`	`getSinceTxId()`
`int`	`getSkipCount()`	Get the skip count - the number of rows to skip at the start of the query.
`List<StoreRef>`	`getStores()`	Get the list of stores in which to run the query.
`Boolean`	`getUseInMemorySort()`
`boolean`	`isBulkFetchEnabled()`
`boolean`	`isIncludeInTransactionData()`	Does the search include any changes made in the current transaction?
`void`	`setBulkFetchEnabled(boolean isBulkFetchEnabled)`
`void`	`setDefaultFieldName(String defaultFieldName)`
`void`	`setDefaultFTSConnective(QueryOptions.Connective defaultFTSConnective)`	Set the default connective used when OR and AND are not specified for the FTS contains() function.
`void`	`setDefaultFTSFieldConnective(QueryOptions.Connective defaultFTSFieldConnective)`	As setDefaultFTSConnective() but for field groups
`void`	`setExcludeTenantFilter(boolean excludeTenantFilter)`
`void`	`setIncludeInTransactionData(boolean includeInTransactionData)`	Set to true if the search include any changes made in the current transaction.
`void`	`setLocales(List<Locale> locales)`	sSet the list of locales to use for the query
`void`	`setMaxItems(int maxItems)`	Set the max number of rows for the result set 0 or less is unlimited
`void`	`setMaxPermissionChecks(int maxPermissionChecks)`
`void`	`setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)`
`void`	`setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort)`
`void`	`setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)`	Set the mode for multi-lingual text analaysis
`void`	`setQuery(String query)`	Set the query string
`void`	`setQueryConsistency(QueryConsistency queryConsistency)`
`void`	`setQueryParameterDefinitions(List<QueryParameterDefinition> queryParameterDefinitions)`	Set the query parameters
`void`	`setSinceTxId(Long sinceTxId)`
`void`	`setSkipCount(int skipCount)`	Set the skip count - the number of rows to skip at the start of the query.
`void`	`setStores(List<StoreRef> stores)`	Set the stores against which to run the query.
`void`	`setUseInMemorySort(Boolean useInMemorySort)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryOptions
```
public QueryOptions(String query,
                    StoreRef storeRef)
```
    Create a CMISQueryOptions instance with the default options other than the query and store ref. The query will be run using the locale returned by I18NUtil.getLocale()
    
    Parameters:
    
    query - - the query to run
    
    storeRef - - the store against which to run the query
  - QueryOptions
```
public QueryOptions(String query,
                    StoreRef storeRef,
                    Locale locale)
```
    Create a CMISQueryOptions instance with the default options other than the query, store ref and locale.
    
    Parameters:
    
    query - - the query to run
    
    storeRef - - the store against which to run the query
- Method Detail
  - create
```
public static QueryOptions create(SearchParameters searchParameters)
```
  - getQuery
```
public String getQuery()
```
    Get the query string
    
    Returns:
    
    the query
  - setQuery
```
public void setQuery(String query)
```
    Set the query string
    
    Parameters:
    
    query - the query to set
  - getStores
```
public List<StoreRef> getStores()
```
    Get the list of stores in which to run the query. Only one store is supported at the momentOnly one store is supported at the moment
    
    Returns:
    
    the stores
  - setStores
```
public void setStores(List<StoreRef> stores)
```
    Set the stores against which to run the query. Only one store is supported at the moment.
    
    Parameters:
    
    stores - the stores to set
  - getMaxItems
```
public int getMaxItems()
```
    Get the max number of rows for the result set 0 or less is unlimited
    
    Returns:
    
    the maxItems
  - setMaxItems
```
public void setMaxItems(int maxItems)
```
    Set the max number of rows for the result set 0 or less is unlimited
    
    Parameters:
    
    maxItems - the maxItems to set
  - getSkipCount
```
public int getSkipCount()
```
    Get the skip count - the number of rows to skip at the start of the query.
    
    Returns:
    
    the skipCount
  - setSkipCount
```
public void setSkipCount(int skipCount)
```
    Set the skip count - the number of rows to skip at the start of the query.
    
    Parameters:
    
    skipCount - the skipCount to set
  - getDefaultFTSConnective
```
public QueryOptions.Connective getDefaultFTSConnective()
```
    Get the default connective used when OR and AND are not specified for the FTS contains() function.
    
    Returns:
    
    the defaultFTSConnective
  - setDefaultFTSConnective
```
public void setDefaultFTSConnective(QueryOptions.Connective defaultFTSConnective)
```
    Set the default connective used when OR and AND are not specified for the FTS contains() function.
    
    Parameters:
    
    defaultFTSConnective - the defaultFTSConnective to set
  - getDefaultFTSFieldConnective
```
public QueryOptions.Connective getDefaultFTSFieldConnective()
```
    As getDefaultFTSConnective() but for field groups
    
    Returns:
    
    the defaultFTSFieldConnective
  - setDefaultFTSFieldConnective
```
public void setDefaultFTSFieldConnective(QueryOptions.Connective defaultFTSFieldConnective)
```
    As setDefaultFTSConnective() but for field groups
    
    Parameters:
    
    defaultFTSFieldConnective - the defaultFTSFieldConnective to set
  - getLocales
```
public List<Locale> getLocales()
```
    Get the list of locales to use for the query
    
    Returns:
    
    the locales
  - setLocales
```
public void setLocales(List<Locale> locales)
```
    sSet the list of locales to use for the query
    
    Parameters:
    
    locales - the locales to set
  - getMlAnalaysisMode
```
public MLAnalysisMode getMlAnalaysisMode()
```
    Get the mode for multi-lingual text analaysis
    
    Returns:
    
    the mlAnalaysisMode
  - setMlAnalaysisMode
```
public void setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)
```
    Set the mode for multi-lingual text analaysis
    
    Parameters:
    
    mlAnalaysisMode - the mlAnalaysisMode to set
  - getQueryParameterDefinitions
```
public List<QueryParameterDefinition> getQueryParameterDefinitions()
```
    Get the query parameters
    
    Returns:
    
    the queryParameterDefinitions
  - setQueryParameterDefinitions
```
public void setQueryParameterDefinitions(List<QueryParameterDefinition> queryParameterDefinitions)
```
    Set the query parameters
    
    Parameters:
    
    queryParameterDefinitions - the queryParameterDefinitions to set
  - isIncludeInTransactionData
```
public boolean isIncludeInTransactionData()
```
    Does the search include any changes made in the current transaction?
    
    Returns:
    
    the includeInTransactionData
  - setIncludeInTransactionData
```
public void setIncludeInTransactionData(boolean includeInTransactionData)
```
    Set to true if the search include any changes made in the current transaction.
    
    Parameters:
    
    includeInTransactionData - the includeInTransactionData to set
  - getMaxPermissionCheckTimeMillis
```
public long getMaxPermissionCheckTimeMillis()
```
    Returns:
    
    the timeout in millis for permission checks
  - setMaxPermissionCheckTimeMillis
```
public void setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)
```
    Parameters:
    
    maxPermissionCheckTimeMillis - - the timeout in millis for permission checks
  - getMaxPermissionChecks
```
public int getMaxPermissionChecks()
```
    Returns:
    
    the max number of permission checks to carry out
  - setMaxPermissionChecks
```
public void setMaxPermissionChecks(int maxPermissionChecks)
```
    Parameters:
    
    maxPermissionChecks - - the max number of permission checks to carry out
  - getDefaultFieldName
```
public String getDefaultFieldName()
```
    Returns:
    
    the default field name
  - setDefaultFieldName
```
public void setDefaultFieldName(String defaultFieldName)
```
    Parameters:
    
    defaultFieldName - - the default field name to use
  - getUseInMemorySort
```
public Boolean getUseInMemorySort()
```
    Returns:
    
    the useInMemorySort
  - setUseInMemorySort
```
public void setUseInMemorySort(Boolean useInMemorySort)
```
    Parameters:
    
    useInMemorySort - the useInMemorySort to set
  - getMaxRawResultSetSizeForInMemorySort
```
public Integer getMaxRawResultSetSizeForInMemorySort()
```
    Returns:
    
    the maxRawResultSetSizeForInMemorySort
  - setMaxRawResultSetSizeForInMemorySort
```
public void setMaxRawResultSetSizeForInMemorySort(Integer maxRawResultSetSizeForInMemorySort)
```
    Parameters:
    
    maxRawResultSetSizeForInMemorySort - the maxRawResultSetSizeForInMemorySort to set
  - isBulkFetchEnabled
```
public boolean isBulkFetchEnabled()
```
    Returns:
    
    true if bulk fetch is enabled
  - setBulkFetchEnabled
```
public void setBulkFetchEnabled(boolean isBulkFetchEnabled)
```
    Parameters:
    
    isBulkFetchEnabled - boolean
  - getExcludeTenantFilter
```
public boolean getExcludeTenantFilter()
```
    Returns:
    
    the tenants
  - setExcludeTenantFilter
```
public void setExcludeTenantFilter(boolean excludeTenantFilter)
```
    Parameters:
    
    excludeTenantFilter - boolean
  - getQueryConsistency
```
public QueryConsistency getQueryConsistency()
```
    Returns:
    
    the queryConsistency
  - setQueryConsistency
```
public void setQueryConsistency(QueryConsistency queryConsistency)
```
    Parameters:
    
    queryConsistency - the queryConsistency to set
  - getSinceTxId
```
public Long getSinceTxId()
```
    Returns:
    
    the sinceTxId
  - setSinceTxId
```
public void setSinceTxId(Long sinceTxId)
```
    Parameters:
    
    sinceTxId - the sinceTxId to set
  - getQueryTemplates
```
public Map<String,String> getQueryTemplates()
```
    Get the query templates
    
    Returns:
    
    - the query templates
  - addQueryTemplate
```
public String addQueryTemplate(String name,
                               String template)
```
    Add/replace a query template Not all languages support query templates
    
    Parameters:
    
    name - String
    
    template - String
    
    Returns:
    
    any removed template or null
  - getAsSearchParmeters
```
public SearchParameters getAsSearchParmeters()
```
    Returns:
    
    SearchParameters

Class QueryOptions

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryOptions

QueryOptions

Method Detail

create

getQuery

setQuery

getStores

setStores

getMaxItems

setMaxItems

getSkipCount

setSkipCount

getDefaultFTSConnective

setDefaultFTSConnective

getDefaultFTSFieldConnective

setDefaultFTSFieldConnective

getLocales

setLocales

getMlAnalaysisMode

setMlAnalaysisMode

getQueryParameterDefinitions

setQueryParameterDefinitions

isIncludeInTransactionData

setIncludeInTransactionData

getMaxPermissionCheckTimeMillis

setMaxPermissionCheckTimeMillis

getMaxPermissionChecks

setMaxPermissionChecks

getDefaultFieldName

setDefaultFieldName

getUseInMemorySort

setUseInMemorySort

getMaxRawResultSetSizeForInMemorySort

setMaxRawResultSetSizeForInMemorySort

isBulkFetchEnabled

setBulkFetchEnabled

getExcludeTenantFilter

setExcludeTenantFilter

getQueryConsistency

setQueryConsistency

getSinceTxId

setSinceTxId

getQueryTemplates

addQueryTemplate

getAsSearchParmeters