Package com.flowable.platform.engine.impl.work

Class WorkInstanceInfoQueryImpl<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<Q,R>

com.flowable.platform.engine.impl.work.WorkInstanceInfoQueryImpl<Q,R>

All Implemented Interfaces:

WorkInstanceInfoQuery<Q,R>, Serializable, org.flowable.common.engine.api.query.Query<Q,R>, org.flowable.common.engine.impl.interceptor.Command<Object>

Direct Known Subclasses:

HistoricWorkInstanceQueryImpl, WorkInstanceQueryImpl

public abstract class WorkInstanceInfoQueryImpl<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>
extends org.flowable.common.engine.impl.query.AbstractQuery<Q,R>
implements WorkInstanceInfoQuery<Q,R>

Author:

Filip Hrisafov

See Also:

• Serialized Form

Nested Class Summary

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

org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy, org.flowable.common.engine.impl.db.ListQueryParameterObject.ResultType

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

org.flowable.common.engine.api.query.Query.NullHandlingOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<String>	accessibleByGroups
protected String	accessibleByUser
protected String	assigneeUserId
protected String	businessKey
protected String	businessStatus
protected static final org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy	DEFAULT_ORDER_BY
protected Collection<String>	definitionCategories
protected String	definitionCategory
protected String	definitionId
protected String	definitionKey
protected String	definitionName
protected Date	finishedAfter
protected Date	finishedBefore
protected String	id
protected boolean	includeOnlyRoot
protected boolean	includeTranslations
protected String	name
protected String	parentScopeId
protected String	rootScopeId
protected List<List<String>>	safeAccessibleByGroups
protected String	searchText
protected Date	startedAfter
protected Date	startedBefore
protected String	startUserId
protected String	state
protected String	tenantId
protected String	type

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, defaultOrderBy, firstResult, ignoreOrderBy, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
WorkInstanceInfoQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
Q	accessibleByUserOrGroups(String userId, Collection<String> groupKeys)	Only select work instances accessible by the give user or groups
Q	assigneeUserId(String userId)	Only select work instance assigned to the given userid
Q	businessKey(String businessKey)	Only select work instance with the given businessKey
Q	businessStatus(String businessStatus)	Only select work instance with the given businessStatus
protected void	checkQueryOk()
Q	definitionCategories(Collection<String> definitionCategories)	Only select work instances with the given definition categories
Q	definitionCategory(String definitionCategory)	Only select work instances with the given definition category
Q	definitionId(String definitionId)	Only select work instances with the given definition id
Q	definitionKey(String definitionKey)	Only select work instances with the given definition key
Q	definitionName(String definitionName)	Only select work instances with the given definition name
Q	finishedAfter(Date finishedAfter)
Q	finishedBefore(Date finishedBefore)
Collection<String>	getAccessibleByGroups()
String	getAccessibleByUser()
String	getAssigneeUserId()
Collection<String>	getDefinitionCategories()
String	getDefinitionCategory()
String	getDefinitionId()
String	getDefinitionKey()
String	getDefinitionName()
Date	getEndedAfter()
Date	getEndedBefore()
String	getId()
String	getName()
String	getParentScopeId()
String	getRootScopeId()
List<List<String>>	getSafeAccessibleByGroups()
String	getSearchText()
Date	getStartedAfter()
Date	getStartedBefore()
String	getStartUserId()
String	getState()
String	getTenantId()
String	getType()
Q	id(String id)	Only select work instances with the given id
Q	includeAllInstances()	Select all instances.
Q	includeTranslation()	Whether translations for the work instances should also be fetched.
boolean	isIncludeOnlyRoot()
boolean	isIncludeTranslations()
Q	name(String name)	Only select work instances with the given name
Q	parentScopeId(String parentScopeId)
Q	rootScopeId(String rootScopeId)
Q	searchText(String searchText)	Only select work instances with the given search text
protected void	setSafeLists()
Q	startedAfter(Date startedAfter)
Q	startedBefore(Date startedBefore)
Q	startUserId(String startUserId)	Only select work instances with the given start user id
Q	state(String state)	Only select work instances with the given state
Q	tenantId(String tenantId)	Only select work instances with the given tenantId
Q	type(String type)	Only select work instances with the given type

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

asc, count, desc, direction, execute, executeCount, executeList, executeSingleResult, getSafeList, 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, setIgnoreOrderBy, 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.Query

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

Field Details

DEFAULT_ORDER_BY

protected static final org.flowable.common.engine.impl.db.ListQueryParameterObject.OrderBy DEFAULT_ORDER_BY

id

protected String id

name

protected String name

definitionId

protected String definitionId

definitionName

protected String definitionName

definitionKey

protected String definitionKey

definitionCategory

protected String definitionCategory

definitionCategories

protected Collection<String> definitionCategories

state

protected String state

type

protected String type

startUserId

protected String startUserId

searchText

protected String searchText

tenantId

protected String tenantId

accessibleByUser

protected String accessibleByUser

accessibleByGroups

protected Collection<String> accessibleByGroups

safeAccessibleByGroups

protected List<List<String>> safeAccessibleByGroups

includeTranslations

protected boolean includeTranslations

assigneeUserId

protected String assigneeUserId

businessKey

protected String businessKey

businessStatus

protected String businessStatus

includeOnlyRoot

protected boolean includeOnlyRoot

parentScopeId

protected String parentScopeId

rootScopeId

protected String rootScopeId

startedBefore

protected Date startedBefore

startedAfter

protected Date startedAfter

finishedBefore

protected Date finishedBefore

finishedAfter

protected Date finishedAfter

Constructor Details

WorkInstanceInfoQueryImpl

public WorkInstanceInfoQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)

Method Details

id

public Q id(String id)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given id

Specified by:

id in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

name

public Q name(String name)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given name

Specified by:

name in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

definitionId

public Q definitionId(String definitionId)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given definition id

Specified by:

definitionId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

definitionName

public Q definitionName(String definitionName)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given definition name

Specified by:

definitionName in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

definitionKey

public Q definitionKey(String definitionKey)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given definition key

Specified by:

definitionKey in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

definitionCategory

public Q definitionCategory(String definitionCategory)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given definition category

Specified by:

definitionCategory in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

definitionCategories

public Q definitionCategories(Collection<String> definitionCategories)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given definition categories

Specified by:

definitionCategories in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

state

public Q state(String state)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given state

Specified by:

state in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

type

public Q type(String type)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given type

Specified by:

type in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

startUserId

public Q startUserId(String startUserId)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given start user id

Specified by:

startUserId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

searchText

public Q searchText(String searchText)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given search text

Specified by:

searchText in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

tenantId

public Q tenantId(String tenantId)

Description copied from interface: WorkInstanceInfoQuery

Only select work instances with the given tenantId

Specified by:

tenantId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

accessibleByUserOrGroups

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

Description copied from interface: WorkInstanceInfoQuery

Only select work instances accessible by the give user or groups

Specified by:

accessibleByUserOrGroups in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

includeTranslation

public Q includeTranslation()

Description copied from interface: WorkInstanceInfoQuery

Whether translations for the work instances should also be fetched.

Specified by:

includeTranslation in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

assigneeUserId

public Q assigneeUserId(String userId)

Description copied from interface: WorkInstanceInfoQuery

Only select work instance assigned to the given userid

Specified by:

assigneeUserId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

checkQueryOk

protected void checkQueryOk()

Overrides:

checkQueryOk in class org.flowable.common.engine.impl.query.AbstractQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

businessKey

public Q businessKey(String businessKey)

Description copied from interface: WorkInstanceInfoQuery

Only select work instance with the given businessKey

Specified by:

businessKey in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

businessStatus

public Q businessStatus(String businessStatus)

Description copied from interface: WorkInstanceInfoQuery

Only select work instance with the given businessStatus

Specified by:

businessStatus in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

includeAllInstances

public Q includeAllInstances()

Description copied from interface: WorkInstanceInfoQuery

Select all instances. Not only the root instances.

Specified by:

includeAllInstances in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

parentScopeId

public Q parentScopeId(String parentScopeId)

Specified by:

parentScopeId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

startedBefore

public Q startedBefore(Date startedBefore)

Specified by:

startedBefore in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

startedAfter

public Q startedAfter(Date startedAfter)

Specified by:

startedAfter in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

finishedBefore

public Q finishedBefore(Date finishedBefore)

Specified by:

finishedBefore in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

finishedAfter

public Q finishedAfter(Date finishedAfter)

Specified by:

finishedAfter in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

rootScopeId

public Q rootScopeId(String rootScopeId)

Specified by:

rootScopeId in interface WorkInstanceInfoQuery<Q extends WorkInstanceInfoQuery<Q,R>,R extends WorkInstanceInfo>

setSafeLists

protected void setSafeLists()

getId

public String getId()

getName

public String getName()

getDefinitionId

public String getDefinitionId()

getDefinitionName

public String getDefinitionName()

getDefinitionKey

public String getDefinitionKey()

getDefinitionCategory

public String getDefinitionCategory()

getDefinitionCategories

public Collection<String> getDefinitionCategories()

getState

public String getState()

getType

public String getType()

getStartUserId

public String getStartUserId()

getSearchText

public String getSearchText()

getTenantId

public String getTenantId()

getAccessibleByUser

public String getAccessibleByUser()

getAccessibleByGroups

public Collection<String> getAccessibleByGroups()

getSafeAccessibleByGroups

public List<List<String>> getSafeAccessibleByGroups()

isIncludeTranslations

public boolean isIncludeTranslations()

getAssigneeUserId

public String getAssigneeUserId()

isIncludeOnlyRoot

public boolean isIncludeOnlyRoot()

getParentScopeId

public String getParentScopeId()

getRootScopeId

public String getRootScopeId()

getStartedBefore

public Date getStartedBefore()

getStartedAfter

public Date getStartedAfter()

getEndedBefore

public Date getEndedBefore()

getEndedAfter

public Date getEndedAfter()