Package org.alfresco.opencmis.search

Class CMISQueryOptions

java.lang.Object

org.alfresco.repo.search.impl.querymodel.QueryOptions

org.alfresco.opencmis.search.CMISQueryOptions

public class CMISQueryOptions
extends QueryOptions

The options for a CMIS query

Author:

andyh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CMISQueryOptions.CMISQueryFilter	Allows to filter CMIS query results.
static enum	CMISQueryOptions.CMISQueryMode

Nested classes/interfaces inherited from class org.alfresco.repo.search.impl.querymodel.QueryOptions

QueryOptions.Connective

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	clearQueryFilter()
static CMISQueryOptions	create(SearchParameters searchParameters)
SearchParameters	getAsSearchParmeters()
org.apache.chemistry.opencmis.commons.enums.CmisVersion	getCmisVersion()
CMISQueryOptions.CMISQueryFilter	getQueryFilter()
CMISQueryOptions.CMISQueryMode	getQueryMode()	Get the query mode.
void	setCmisVersion(org.apache.chemistry.opencmis.commons.enums.CmisVersion cmisVersion)
void	setQueryFilter(CMISQueryOptions.CMISQueryFilter queryFilter)
void	setQueryMode(CMISQueryOptions.CMISQueryMode queryMode)	Set the query mode.

Methods inherited from class org.alfresco.repo.search.impl.querymodel.QueryOptions

addQueryTemplate, getDefaultFieldName, getDefaultFTSConnective, getDefaultFTSFieldConnective, getExcludeTenantFilter, getLocales, getMaxItems, getMaxPermissionChecks, getMaxPermissionCheckTimeMillis, getMaxRawResultSetSizeForInMemorySort, getMlAnalaysisMode, getQuery, getQueryConsistency, getQueryParameterDefinitions, getQueryTemplates, getSinceTxId, getSkipCount, getStores, getUseInMemorySort, isBulkFetchEnabled, isIncludeInTransactionData, setBulkFetchEnabled, setDefaultFieldName, setDefaultFTSConnective, setDefaultFTSFieldConnective, setExcludeTenantFilter, setIncludeInTransactionData, setLocales, setMaxItems, setMaxPermissionChecks, setMaxPermissionCheckTimeMillis, setMaxRawResultSetSizeForInMemorySort, setMlAnalaysisMode, setQuery, setQueryConsistency, setQueryParameterDefinitions, setSinceTxId, setSkipCount, setStores, setUseInMemorySort

Methods inherited from class java.lang.Object

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

Constructor Details

CMISQueryOptions

public CMISQueryOptions(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

CMISQueryOptions

public CMISQueryOptions(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 Details

create

public static CMISQueryOptions create(SearchParameters searchParameters)

getCmisVersion

public org.apache.chemistry.opencmis.commons.enums.CmisVersion getCmisVersion()

setCmisVersion

public void setCmisVersion(org.apache.chemistry.opencmis.commons.enums.CmisVersion cmisVersion)

getQueryMode

public CMISQueryOptions.CMISQueryMode getQueryMode()

Get the query mode.

Returns:

the queryMode

setQueryMode

public void setQueryMode(CMISQueryOptions.CMISQueryMode queryMode)

Set the query mode.

Parameters:

queryMode - the queryMode to set

setQueryFilter

public void setQueryFilter(CMISQueryOptions.CMISQueryFilter queryFilter)

clearQueryFilter

public void clearQueryFilter()

getQueryFilter

public CMISQueryOptions.CMISQueryFilter getQueryFilter()

getAsSearchParmeters

public SearchParameters getAsSearchParmeters()

Overrides:

getAsSearchParmeters in class QueryOptions

Returns:

SearchParameters