|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.alfresco.repo.search.impl.querymodel.QueryOptions
public class QueryOptions
The options for a query
Nested Class Summary | |
---|---|
static class |
QueryOptions.Connective
|
Constructor Summary | |
---|---|
QueryOptions(java.lang.String query,
StoreRef storeRef)
Create a CMISQueryOptions instance with the default options other than the query and store ref. |
|
QueryOptions(java.lang.String query,
StoreRef storeRef,
java.util.Locale locale)
Create a CMISQueryOptions instance with the default options other than the query, store ref and locale. |
Method Summary | |
---|---|
static QueryOptions |
create(SearchParameters searchParameters)
|
java.lang.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 |
java.util.List |
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()
|
MLAnalysisMode |
getMlAnalaysisMode()
Get the mode for multi-lingual text analaysis |
java.lang.String |
getQuery()
Get the query string |
java.util.List |
getQueryParameterDefinitions()
Get the query parameters |
int |
getSkipCount()
Get the skip count - the number of rows to skip at the start of the query. |
java.util.List |
getStores()
Get the list of stores in which to run the query. |
boolean |
isIncludeInTransactionData()
Does the search include any changes made in the current transaction? |
void |
setDefaultFieldName(java.lang.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 |
setIncludeInTransactionData(boolean includeInTransactionData)
Set to true if the search include any changes made in the current transaction. |
void |
setLocales(java.util.List 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 |
setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)
Set the mode for multi-lingual text analaysis |
void |
setQuery(java.lang.String query)
Set the query string |
void |
setQueryParameterDefinitions(java.util.List queryParameterDefinitions)
Set the query parameters |
void |
setSkipCount(int skipCount)
Set the skip count - the number of rows to skip at the start of the query. |
void |
setStores(java.util.List stores)
Set the stores against which to run the query. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QueryOptions(java.lang.String query, StoreRef storeRef)
query
- -
the query to runstoreRef
- -
the store against which to run the querypublic QueryOptions(java.lang.String query, StoreRef storeRef, java.util.Locale locale)
query
- -
the query to runstoreRef
- -
the store against which to run the queryMethod Detail |
---|
public static QueryOptions create(SearchParameters searchParameters)
public java.lang.String getQuery()
public void setQuery(java.lang.String query)
query
- the query to setpublic java.util.List getStores()
public void setStores(java.util.List stores)
stores
- the stores to setpublic int getMaxItems()
public void setMaxItems(int maxItems)
maxItems
- the maxItems to setpublic int getSkipCount()
public void setSkipCount(int skipCount)
skipCount
- the skipCount to setpublic QueryOptions.Connective getDefaultFTSConnective()
public void setDefaultFTSConnective(QueryOptions.Connective defaultFTSConnective)
defaultFTSConnective
- the defaultFTSConnective to setpublic QueryOptions.Connective getDefaultFTSFieldConnective()
public void setDefaultFTSFieldConnective(QueryOptions.Connective defaultFTSFieldConnective)
defaultFTSFieldConnective
- the defaultFTSFieldConnective to setpublic java.util.List getLocales()
public void setLocales(java.util.List locales)
locales
- the locales to setpublic MLAnalysisMode getMlAnalaysisMode()
public void setMlAnalaysisMode(MLAnalysisMode mlAnalaysisMode)
mlAnalaysisMode
- the mlAnalaysisMode to setpublic java.util.List getQueryParameterDefinitions()
public void setQueryParameterDefinitions(java.util.List queryParameterDefinitions)
queryParameterDefinitions
- the queryParameterDefinitions to setpublic boolean isIncludeInTransactionData()
public void setIncludeInTransactionData(boolean includeInTransactionData)
includeInTransactionData
- the includeInTransactionData to setpublic long getMaxPermissionCheckTimeMillis()
public void setMaxPermissionCheckTimeMillis(long maxPermissionCheckTimeMillis)
maxPermissionCheckTimeMillis
- -
the timeout in millis for permission checkspublic int getMaxPermissionChecks()
public void setMaxPermissionChecks(int maxPermissionChecks)
maxPermissionChecks
- -
the max number of permission checks to carry outpublic java.lang.String getDefaultFieldName()
public void setDefaultFieldName(java.lang.String defaultFieldName)
defaultFieldName
- - the default field name to use
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |