Package com.flowable.content.engine.impl

Class CoreContentItemQueryImpl

java.lang.Object

org.flowable.common.engine.impl.db.ListQueryParameterObject

org.flowable.common.engine.impl.query.AbstractQuery<T,U>

org.flowable.variable.service.impl.AbstractVariableQueryImpl<T,C>

com.flowable.content.engine.impl.ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

com.flowable.content.engine.impl.CoreContentItemQueryImpl

All Implemented Interfaces:

CoreContentItemQuery, Serializable, CacheAwareQuery<CoreContentItem>, Query<CoreContentItemQuery,CoreContentItem>, Command<Object>, ContentItemBaseQuery<CoreContentItemQuery,CoreContentItem>

public class CoreContentItemQueryImpl
extends ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>
implements CoreContentItemQuery

Author:

Tijs Rademakers, Joram Barrez

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	accessibleByGroups
protected String	accessibleByUser
protected String	definitionId
protected boolean	includeCachedItems
protected boolean	includeMetadataValues
protected boolean	includeRenditions
protected boolean	latest
protected String	mimeTypeNotEquals
protected String	nameIgnoreCase
protected String	nameLikeIgnoreCase
protected Collection<? extends Collection<String>>	safeAccessibleByGroups
protected String	state
protected String	subState
protected String	subType
protected String	type
protected Integer	version
protected String	versionInfo
protected String	versionInfoLike
protected String	versionParentId

Fields inherited from class com.flowable.content.engine.impl.ContentItemBaseQueryImpl

baseFolderId, contentAvailable, contentSize, contentStoreId, contentStoreIdLike, contentStoreName, contentStoreNameLike, createdBy, createdByLike, createdDate, createdDateAfter, createdDateBefore, id, ids, isRootFolder, lastModifiedBy, lastModifiedByLike, lastModifiedDate, lastModifiedDateAfter, lastModifiedDateBefore, maxContentSize, mimeType, mimeTypeLike, minContentSize, name, nameLike, parentFolderId, parentFolderIds, processInstanceId, processInstanceIdLike, scopeId, scopeIdLike, scopeType, scopeTypeLike, taskId, taskIdLike, tenantId, tenantIdLike, withoutTenantId

Fields inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

queryVariableValues, variableValueProvider

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
CoreContentItemQueryImpl(CommandContext commandContext)
CoreContentItemQueryImpl(CommandExecutor commandExecutor, ContentEngineConfiguration contentEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
CoreContentItemQuery	accessibleByUserOrGroups(String userId, Collection<String> groupKeys)	Only select content items that are accessible by the given userId or groupKeys.
CoreContentItemQuery	definitionId(String definitionId)	Only select content items with the given definition id.
protected long	executeFindContentItemCount(CommandContext commandContext)
protected List<CoreContentItem>	executeFindContentItemList(CommandContext commandContext)
Collection<String>	getAccessibleByGroups()
String	getAccessibleByUser()
String	getDefinitionId()
String	getMimeTypeNotEquals()
String	getNameIgnoreCase()
String	getNameLikeIgnoreCase()
List<QueryVariableValue>	getQueryMetadataValues()
Collection<? extends Collection<String>>	getSafeAccessibleByGroups()
String	getState()
String	getSubState()
String	getSubType()
String	getType()
Integer	getVersion()
String	getVersionInfo()
String	getVersionInfoLike()
String	getVersionParentId()
CoreContentItemQuery	includeCachedItems()	Include cached content items, only implemented for queries with mimetype = folder, a filled parent folder id and a process instance id, task id, or scope id.
CoreContentItemQuery	includeMetadataValues()
CoreContentItemQuery	includeRenditions()
boolean	isIncludeCachedItems()
boolean	isIncludeMetadataValues()
boolean	isIncludeRenditions()
boolean	isLatest()
CoreContentItemQuery	latest()	Only select content items with the latest version.
CoreContentItemQuery	metadataExists(String name)
CoreContentItemQuery	metadataNotExists(String name)
CoreContentItemQuery	metadataValueEquals(Object value)
CoreContentItemQuery	metadataValueEquals(String key, Object value)
CoreContentItemQuery	metadataValueEqualsIgnoreCase(String name, String value)
CoreContentItemQuery	metadataValueGreaterThan(String name, Object value)
CoreContentItemQuery	metadataValueGreaterThanOrEqual(String name, Object value)
CoreContentItemQuery	metadataValueLessThan(String name, Object value)
CoreContentItemQuery	metadataValueLessThanOrEqual(String name, Object value)
CoreContentItemQuery	metadataValueLike(String name, String value)
CoreContentItemQuery	metadataValueLikeIgnoreCase(String name, String value)
CoreContentItemQuery	metadataValueNotEquals(String name, Object value)
CoreContentItemQuery	metadataValueNotEqualsIgnoreCase(String name, String value)
CoreContentItemQuery	mimeTypeNotEquals(String mimeTypeNotEquals)	Only select content items with a mime type that is not equal to the given mime type.
CoreContentItemQuery	nameIgnoreCase(String nameIgnoreCase)	Only select content items with the given name ignoring case.
CoreContentItemQuery	nameLikeIgnoreCase(String nameLikeIgnoreCase)	Only select content items with a name like the given value ignoring case.
CoreContentItemQuery	orderByLastModified()
CoreContentItemQuery	orderByName()
CoreContentItemQuery	orderBySize()
void	setSafeAccessibleByGroups(Collection<? extends Collection<String>> safeAccessibleByGroups)
CoreContentItemQuery	state(String state)	Only select content items with the given state.
CoreContentItemQuery	subState(String subState)	Only select content items with the given sub state.
CoreContentItemQuery	subType(String subType)	Only select content items with the given sub type.
CoreContentItemQuery	type(String type)	Only select content items with the given type.
CoreContentItemQuery	version(Integer version)	Only select content items with the given version.
CoreContentItemQuery	versionInfo(String versionInfo)	Only select content items with the given version info.
CoreContentItemQuery	versionInfoLike(String versionInfoLike)	Only select content items with a version info like the given string.
CoreContentItemQuery	versionParentId(String versionParentId)	Only select content items with the given version parent id.

Methods inherited from class com.flowable.content.engine.impl.ContentItemBaseQueryImpl

baseFolderId, contentAvailable, contentSize, contentStoreId, contentStoreIdLike, contentStoreName, contentStoreNameLike, createdBy, createdByLike, createdDate, createdDateAfter, createdDateBefore, executeCount, executeList, field, fieldLike, getBaseFolderId, getContentAvailable, getContentSize, getContentStoreId, getContentStoreIdLike, getContentStoreName, getContentStoreNameLike, getCreatedBy, getCreatedByLike, getCreatedDate, getCreatedDateAfter, getCreatedDateBefore, getId, getIds, getLastModifiedBy, getLastModifiedByLike, getLastModifiedDate, getLastModifiedDateAfter, getLastModifiedDateBefore, getMaxContentSize, getMimeType, getMimeTypeLike, getMinContentSize, getParentFolderId, getParentFolderIds, getProcessInstanceId, getProcessInstanceIdLike, getScopeId, getScopeIdLike, getScopeType, getScopeTypeLike, getTaskId, getTaskIdLike, getTenantId, getTenantIdLike, id, ids, isRootFolder, isWithoutTenantId, lastModifiedBy, lastModifiedByLike, lastModifiedDate, lastModifiedDateAfter, lastModifiedDateBefore, maxContentSize, mimeType, mimeTypeLike, minContentSize, name, nameLike, orderByCreatedDate, orderByTenantId, parentFolderId, parentFolderIds, processInstanceId, processInstanceIdLike, scopeId, scopeIdLike, scopeType, scopeTypeLike, taskId, taskIdLike, tenantId, tenantIdLike, withoutTenantId

Methods inherited from class org.flowable.variable.service.impl.AbstractVariableQueryImpl

addVariable, addVariable, ensureVariablesInitialized, getQueryVariableValues, hasLocalQueryVariableValue, hasNonLocalQueryVariableValue, hasValueComparisonQueryVariables, isBoolean, scopedVariableExists, scopedVariableNotExists, scopedVariableValueEquals, scopedVariableValueEquals, scopedVariableValueEqualsIgnoreCase, scopedVariableValueGreaterThan, scopedVariableValueGreaterThanOrEqual, scopedVariableValueLessThan, scopedVariableValueLessThanOrEqual, scopedVariableValueLike, scopedVariableValueLikeIgnoreCase, scopedVariableValueNotEquals, scopedVariableValueNotEqualsIgnoreCase, variableExists, variableExists, variableNotExists, variableNotExists, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEquals, variableValueEqualsIgnoreCase, variableValueEqualsIgnoreCase, variableValueGreaterThan, variableValueGreaterThan, variableValueGreaterThanOrEqual, variableValueGreaterThanOrEqual, variableValueLessThan, variableValueLessThan, variableValueLessThanOrEqual, variableValueLessThanOrEqual, variableValueLike, variableValueLike, variableValueLikeIgnoreCase, variableValueLikeIgnoreCase, variableValueNotEquals, variableValueNotEquals, variableValueNotEqualsIgnoreCase, variableValueNotEqualsIgnoreCase

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery

enhanceCachedValue

Methods inherited from interface org.flowable.content.api.ContentItemBaseQuery

contentAvailable, contentSize, contentStoreId, contentStoreIdLike, contentStoreName, contentStoreNameLike, createdBy, createdByLike, createdDate, createdDateAfter, createdDateBefore, field, fieldLike, id, ids, lastModifiedBy, lastModifiedByLike, lastModifiedDate, lastModifiedDateAfter, lastModifiedDateBefore, maxContentSize, mimeType, mimeTypeLike, minContentSize, name, nameLike, orderByCreatedDate, orderByTenantId, processInstanceId, processInstanceIdLike, scopeId, scopeIdLike, scopeType, scopeTypeLike, taskId, taskIdLike, tenantId, tenantIdLike, withoutTenantId

Methods inherited from interface com.flowable.core.content.api.CoreContentItemQuery

baseFolderId, isRootFolder, parentFolderId

Methods inherited from interface org.flowable.common.engine.api.query.Query

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Field Details

nameIgnoreCase

protected String nameIgnoreCase

nameLikeIgnoreCase

protected String nameLikeIgnoreCase

version

protected Integer version

versionInfo

protected String versionInfo

versionInfoLike

protected String versionInfoLike

versionParentId

protected String versionParentId

definitionId

protected String definitionId

type

protected String type

subType

protected String subType

state

protected String state

subState

protected String subState

mimeTypeNotEquals

protected String mimeTypeNotEquals

latest

protected boolean latest

includeCachedItems

protected boolean includeCachedItems

accessibleByUser

protected String accessibleByUser

accessibleByGroups

protected Collection<String> accessibleByGroups

safeAccessibleByGroups

protected Collection<? extends Collection<String>> safeAccessibleByGroups

includeMetadataValues

protected boolean includeMetadataValues

includeRenditions

protected boolean includeRenditions

Constructor Details

CoreContentItemQueryImpl

public CoreContentItemQueryImpl(CommandContext commandContext)

CoreContentItemQueryImpl

public CoreContentItemQueryImpl(CommandExecutor commandExecutor,
 ContentEngineConfiguration contentEngineConfiguration)

Method Details

nameIgnoreCase

public CoreContentItemQuery nameIgnoreCase(String nameIgnoreCase)

Description copied from interface: CoreContentItemQuery

Only select content items with the given name ignoring case.

Specified by:

nameIgnoreCase in interface CoreContentItemQuery

nameLikeIgnoreCase

public CoreContentItemQuery nameLikeIgnoreCase(String nameLikeIgnoreCase)

Description copied from interface: CoreContentItemQuery

Only select content items with a name like the given value ignoring case.

Specified by:

nameLikeIgnoreCase in interface CoreContentItemQuery

version

public CoreContentItemQuery version(Integer version)

Description copied from interface: CoreContentItemQuery

Only select content items with the given version.

Specified by:

version in interface CoreContentItemQuery

versionInfo

public CoreContentItemQuery versionInfo(String versionInfo)

Description copied from interface: CoreContentItemQuery

Only select content items with the given version info.

Specified by:

versionInfo in interface CoreContentItemQuery

versionInfoLike

public CoreContentItemQuery versionInfoLike(String versionInfoLike)

Description copied from interface: CoreContentItemQuery

Only select content items with a version info like the given string.

Specified by:

versionInfoLike in interface CoreContentItemQuery

versionParentId

public CoreContentItemQuery versionParentId(String versionParentId)

Description copied from interface: CoreContentItemQuery

Only select content items with the given version parent id.

Specified by:

versionParentId in interface CoreContentItemQuery

definitionId

public CoreContentItemQuery definitionId(String definitionId)

Description copied from interface: CoreContentItemQuery

Only select content items with the given definition id.

Specified by:

definitionId in interface CoreContentItemQuery

type

public CoreContentItemQuery type(String type)

Description copied from interface: CoreContentItemQuery

Only select content items with the given type.

Specified by:

type in interface CoreContentItemQuery

subType

public CoreContentItemQuery subType(String subType)

Description copied from interface: CoreContentItemQuery

Only select content items with the given sub type.

Specified by:

subType in interface CoreContentItemQuery

state

public CoreContentItemQuery state(String state)

Description copied from interface: CoreContentItemQuery

Only select content items with the given state.

Specified by:

state in interface CoreContentItemQuery

subState

public CoreContentItemQuery subState(String subState)

Description copied from interface: CoreContentItemQuery

Only select content items with the given sub state.

Specified by:

subState in interface CoreContentItemQuery

mimeTypeNotEquals

public CoreContentItemQuery mimeTypeNotEquals(String mimeTypeNotEquals)

Description copied from interface: CoreContentItemQuery

Only select content items with a mime type that is not equal to the given mime type.

Specified by:

mimeTypeNotEquals in interface CoreContentItemQuery

latest

public CoreContentItemQuery latest()

Description copied from interface: CoreContentItemQuery

Only select content items with the latest version.

Specified by:

latest in interface CoreContentItemQuery

includeCachedItems

public CoreContentItemQuery includeCachedItems()

Description copied from interface: CoreContentItemQuery

Include cached content items, only implemented for queries with mimetype = folder, a filled parent folder id and a process instance id, task id, or scope id. This is to prevent folders from getting created multiple times

Specified by:

includeCachedItems in interface CoreContentItemQuery

accessibleByUserOrGroups

public CoreContentItemQuery accessibleByUserOrGroups(String userId,
 Collection<String> groupKeys)

Description copied from interface: CoreContentItemQuery

Only select content items that are accessible by the given userId or groupKeys. This will check accessibility to the references of a content item. e.g. if a ContentItem is linked to a process instance it will check the process instance identity links.

Specified by:

accessibleByUserOrGroups in interface CoreContentItemQuery

metadataValueEquals

public CoreContentItemQuery metadataValueEquals(String key,
 Object value)

Specified by:

metadataValueEquals in interface CoreContentItemQuery

metadataValueEquals

public CoreContentItemQuery metadataValueEquals(Object value)

Specified by:

metadataValueEquals in interface CoreContentItemQuery

metadataValueEqualsIgnoreCase

public CoreContentItemQuery metadataValueEqualsIgnoreCase(String name,
 String value)

Specified by:

metadataValueEqualsIgnoreCase in interface CoreContentItemQuery

metadataValueNotEqualsIgnoreCase

public CoreContentItemQuery metadataValueNotEqualsIgnoreCase(String name,
 String value)

Specified by:

metadataValueNotEqualsIgnoreCase in interface CoreContentItemQuery

metadataValueNotEquals

public CoreContentItemQuery metadataValueNotEquals(String name,
 Object value)

Specified by:

metadataValueNotEquals in interface CoreContentItemQuery

metadataValueGreaterThan

public CoreContentItemQuery metadataValueGreaterThan(String name,
 Object value)

Specified by:

metadataValueGreaterThan in interface CoreContentItemQuery

metadataValueGreaterThanOrEqual

public CoreContentItemQuery metadataValueGreaterThanOrEqual(String name,
 Object value)

Specified by:

metadataValueGreaterThanOrEqual in interface CoreContentItemQuery

metadataValueLessThan

public CoreContentItemQuery metadataValueLessThan(String name,
 Object value)

Specified by:

metadataValueLessThan in interface CoreContentItemQuery

metadataValueLessThanOrEqual

public CoreContentItemQuery metadataValueLessThanOrEqual(String name,
 Object value)

Specified by:

metadataValueLessThanOrEqual in interface CoreContentItemQuery

metadataValueLike

public CoreContentItemQuery metadataValueLike(String name,
 String value)

Specified by:

metadataValueLike in interface CoreContentItemQuery

metadataValueLikeIgnoreCase

public CoreContentItemQuery metadataValueLikeIgnoreCase(String name,
 String value)

Specified by:

metadataValueLikeIgnoreCase in interface CoreContentItemQuery

metadataExists

public CoreContentItemQuery metadataExists(String name)

Specified by:

metadataExists in interface CoreContentItemQuery

metadataNotExists

public CoreContentItemQuery metadataNotExists(String name)

Specified by:

metadataNotExists in interface CoreContentItemQuery

includeMetadataValues

public CoreContentItemQuery includeMetadataValues()

Specified by:

includeMetadataValues in interface CoreContentItemQuery

includeRenditions

public CoreContentItemQuery includeRenditions()

Specified by:

includeRenditions in interface CoreContentItemQuery

executeFindContentItemCount

protected long executeFindContentItemCount(CommandContext commandContext)

Specified by:

executeFindContentItemCount in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

executeFindContentItemList

protected List<CoreContentItem> executeFindContentItemList(CommandContext commandContext)

Specified by:

executeFindContentItemList in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

orderByName

public CoreContentItemQuery orderByName()

Specified by:

orderByName in interface CoreContentItemQuery

orderByLastModified

public CoreContentItemQuery orderByLastModified()

Specified by:

orderByLastModified in interface CoreContentItemQuery

orderBySize

public CoreContentItemQuery orderBySize()

Specified by:

orderBySize in interface CoreContentItemQuery

getNameIgnoreCase

public String getNameIgnoreCase()

getNameLikeIgnoreCase

public String getNameLikeIgnoreCase()

getVersion

public Integer getVersion()

Overrides:

getVersion in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getVersionInfo

public String getVersionInfo()

Overrides:

getVersionInfo in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getVersionInfoLike

public String getVersionInfoLike()

Overrides:

getVersionInfoLike in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getVersionParentId

public String getVersionParentId()

Overrides:

getVersionParentId in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getDefinitionId

public String getDefinitionId()

Overrides:

getDefinitionId in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getType

public String getType()

Overrides:

getType in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getSubType

public String getSubType()

Overrides:

getSubType in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getState

public String getState()

Overrides:

getState in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getSubState

public String getSubState()

Overrides:

getSubState in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getMimeTypeNotEquals

public String getMimeTypeNotEquals()

Overrides:

getMimeTypeNotEquals in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

isLatest

public boolean isLatest()

Overrides:

isLatest in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

isIncludeCachedItems

public boolean isIncludeCachedItems()

Overrides:

isIncludeCachedItems in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getAccessibleByUser

public String getAccessibleByUser()

Overrides:

getAccessibleByUser in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getAccessibleByGroups

public Collection<String> getAccessibleByGroups()

Overrides:

getAccessibleByGroups in class ContentItemBaseQueryImpl<CoreContentItemQuery,CoreContentItem>

getSafeAccessibleByGroups

public Collection<? extends Collection<String>> getSafeAccessibleByGroups()

setSafeAccessibleByGroups

public void setSafeAccessibleByGroups(Collection<? extends Collection<String>> safeAccessibleByGroups)

getQueryMetadataValues

public List<QueryVariableValue> getQueryMetadataValues()

isIncludeMetadataValues

public boolean isIncludeMetadataValues()

isIncludeRenditions

public boolean isIncludeRenditions()