Package com.flowable.engage.engine.impl.conversation

Class ConversationQueryImpl

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<ConversationQuery,Conversation>

com.flowable.engage.engine.impl.conversation.ConversationQueryImpl

All Implemented Interfaces:

ConversationQuery, Serializable, CacheAwareQuery<ConversationEntity>, Query<ConversationQuery,Conversation>, Command<Object>

public class ConversationQueryImpl
extends AbstractVariableQueryImpl<ConversationQuery,Conversation>
implements ConversationQuery, CacheAwareQuery<ConversationEntity>

Author:

Filip Hrisafov, 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	accessibleByParticipant
protected String	conversationDefinitionId
protected Date	createdAfter
protected Date	createdBefore
protected static final ListQueryParameterObject.OrderBy	DEFAULT_ORDER_BY
protected String	externalId
protected String	id
protected Collection<String>	ids
protected boolean	includeIdentityLinks
protected boolean	includeVariables
protected Date	lastMessageAfter
protected Date	lastMessageBefore
protected String	mutedByUser
protected String	name
protected String	ownerId
protected Collection<String>	participantsOrOwner
protected String	referenceDefinitionId
protected String	referenceId
protected String	referenceType
protected boolean	requiresIdentityLinks
protected String	starredByUser
protected String	state
protected String	subType
protected List<String>	tags
protected List<String>	tagsNotIn
protected String	tenantId
protected String	type
protected Date	updateTimeAfter
protected Date	updateTimeBefore
protected String	userAccountId
protected String	userAccountSubType
protected Collection<String>	withAllParticipants
protected Collection<String>	withAnyParticipants
protected boolean	withoutMessages
protected boolean	withoutParent
protected boolean	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, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor	Description
ConversationQueryImpl(CommandExecutor commandExecutor, EngageEngineConfiguration engageEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
ConversationQuery	accessibleByParticipantOrGroups(String participantId, Collection<String> groups)
protected ConversationQuery	addTag(String tag)
protected ConversationQuery	addTagNotIn(String tagNotIn)
ConversationQuery	conversationDefinitionId(String conversationDefinitionId)
ConversationQuery	createdAfter(Date createdAfter)
ConversationQuery	createdBefore(Date createdBefore)
void	enhanceCachedValue(ConversationEntity conversation)
long	executeCount(CommandContext commandContext)
List<Conversation>	executeList(CommandContext commandContext)
ConversationQuery	externalId(String externalId)	Select conversation with the given external id.
Collection<String>	getAccessibleByGroups()
String	getAccessibleByParticipant()
String	getConversationDefinitionId()
Date	getCreatedAfter()
Date	getCreatedBefore()
String	getExternalId()
String	getId()
Collection<String>	getIds()
Date	getLastMessageAfter()
Date	getLastMessageBefore()
String	getMutedByUser()
String	getName()
String	getOwnerId()
Collection<String>	getParticipantsOrOwner()
int	getParticipantsOrOwnerSize()
String	getReferenceDefinitionId()
String	getReferenceId()
String	getReferenceType()
String	getStarredByUser()
String	getState()
String	getSubType()
List<String>	getTags()
List<String>	getTagsNotIn()
String	getTenantId()
String	getType()
Date	getUpdateTimeAfter()
Date	getUpdateTimeBefore()
String	getUserAccountId()
String	getUserAccountSubType()
Collection<String>	getWithAllParticipants()
int	getWithAllParticipantsSize()
Collection<String>	getWithAnyParticipants()
ConversationQuery	id(String id)	Select a conversation with the given id.
ConversationQuery	ids(Collection<String> ids)	Select all conversations with the given ids.
ConversationQuery	includeIdentityLinks()
ConversationQuery	includeVariables()
boolean	isFalse()	We can't use false in SQL in a DB agnostic way.
boolean	isIncludeIdentityLinks()
boolean	isIncludeVariables()
boolean	isRequiresIdentityLinks()
boolean	isTrue()	We can't use true in SQL in a DB agnostic way.
boolean	isWithoutMessages()
boolean	isWithoutParent()
boolean	isWithoutTenantId()
ConversationQuery	lastMessageAfter(Date lastMessageAfter)
ConversationQuery	lastMessageBefore(Date lastMessageBefore)
ConversationQuery	mutedByUser(String userId)	Select conversations that have been muted by the given user.
ConversationQuery	name(String name)
ConversationQuery	orderByLastMessageTime()
ConversationQuery	ownerId(String ownerId)
ConversationQuery	participantsOrOwner(Collection<String> participantsOrOwner)
ConversationQuery	referenceDefinitionId(String referenceDefinitionId)
ConversationQuery	referenceId(String referenceId)
ConversationQuery	referenceType(String referenceType)
ConversationQuery	starredByUser(String userId)	Select conversations that have been starred by the given user.
ConversationQuery	state(String state)
ConversationQuery	subType(String subType)
ConversationQuery	tags(String tag)
ConversationQuery	tags(String tag, String... tags)
ConversationQuery	tags(Collection<String> tags)
ConversationQuery	tagsNotIn(String tagNotIn)
ConversationQuery	tagsNotIn(String tagNotIn, String... tagsNotIn)
ConversationQuery	tagsNotIn(Collection<String> tagsNotIn)
ConversationQuery	tenantId(String tenantId)
ConversationQuery	type(String type)
ConversationQuery	updateTimeAfter(Date updateTimeAfter)
ConversationQuery	updateTimeBefore(Date updateTimeBefore)
ConversationQuery	userAccountId(String userAccountId)
ConversationQuery	userAccountSubType(String userAccountSubType)
ConversationQuery	withAllParticipants(Collection<String> withAllParticipants)	Conversations that contain exactly the given withAllParticipants collection and nothing else
ConversationQuery	withAnyParticipants(Collection<String> withAnyParticipants)	Conversations that have at least one of the given withAnyParticipants collection as participant
ConversationQuery	withoutMessages()
ConversationQuery	withoutParent()
ConversationQuery	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 com.flowable.engage.conversation.api.ConversationQuery

accessibleByParticipant, variableValueEquals, variableValueEqualsIgnoreCase, variableValueLike, variableValueLikeIgnoreCase

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 ListQueryParameterObject.OrderBy DEFAULT_ORDER_BY

id

protected String id

ids

protected Collection<String> ids

externalId

protected String externalId

type

protected String type

subType

protected String subType

name

protected String name

conversationDefinitionId

protected String conversationDefinitionId

referenceId

protected String referenceId

referenceType

protected String referenceType

referenceDefinitionId

protected String referenceDefinitionId

ownerId

protected String ownerId

withAllParticipants

protected Collection<String> withAllParticipants

withAnyParticipants

protected Collection<String> withAnyParticipants

participantsOrOwner

protected Collection<String> participantsOrOwner

accessibleByParticipant

protected String accessibleByParticipant

accessibleByGroups

protected Collection<String> accessibleByGroups

lastMessageAfter

protected Date lastMessageAfter

lastMessageBefore

protected Date lastMessageBefore

userAccountId

protected String userAccountId

userAccountSubType

protected String userAccountSubType

updateTimeAfter

protected Date updateTimeAfter

updateTimeBefore

protected Date updateTimeBefore

createdBefore

protected Date createdBefore

createdAfter

protected Date createdAfter

tags

protected List<String> tags

tagsNotIn

protected List<String> tagsNotIn

state

protected String state

tenantId

protected String tenantId

withoutTenantId

protected boolean withoutTenantId

withoutParent

protected boolean withoutParent

withoutMessages

protected boolean withoutMessages

starredByUser

protected String starredByUser

mutedByUser

protected String mutedByUser

requiresIdentityLinks

protected boolean requiresIdentityLinks

includeIdentityLinks

protected boolean includeIdentityLinks

includeVariables

protected boolean includeVariables

Constructor Details

ConversationQueryImpl

public ConversationQueryImpl(CommandExecutor commandExecutor,
 EngageEngineConfiguration engageEngineConfiguration)

Method Details

getId

public String getId()

Specified by:

getId in interface CacheAwareQuery<ConversationEntity>

id

public ConversationQuery id(String id)

Description copied from interface: ConversationQuery

Select a conversation with the given id.

Specified by:

id in interface ConversationQuery

ids

public ConversationQuery ids(Collection<String> ids)

Description copied from interface: ConversationQuery

Select all conversations with the given ids.

Specified by:

ids in interface ConversationQuery

externalId

public ConversationQuery externalId(String externalId)

Description copied from interface: ConversationQuery

Select conversation with the given external id.

Specified by:

externalId in interface ConversationQuery

type

public ConversationQuery type(String type)

Specified by:

type in interface ConversationQuery

subType

public ConversationQuery subType(String subType)

Specified by:

subType in interface ConversationQuery

name

public ConversationQuery name(String name)

Specified by:

name in interface ConversationQuery

conversationDefinitionId

public ConversationQuery conversationDefinitionId(String conversationDefinitionId)

Specified by:

conversationDefinitionId in interface ConversationQuery

referenceId

public ConversationQuery referenceId(String referenceId)

Specified by:

referenceId in interface ConversationQuery

referenceType

public ConversationQuery referenceType(String referenceType)

Specified by:

referenceType in interface ConversationQuery

referenceDefinitionId

public ConversationQuery referenceDefinitionId(String referenceDefinitionId)

Specified by:

referenceDefinitionId in interface ConversationQuery

ownerId

public ConversationQuery ownerId(String ownerId)

Specified by:

ownerId in interface ConversationQuery

withAllParticipants

public ConversationQuery withAllParticipants(Collection<String> withAllParticipants)

Description copied from interface: ConversationQuery

Conversations that contain exactly the given withAllParticipants collection and nothing else

Specified by:

withAllParticipants in interface ConversationQuery

withAnyParticipants

public ConversationQuery withAnyParticipants(Collection<String> withAnyParticipants)

Description copied from interface: ConversationQuery

Conversations that have at least one of the given withAnyParticipants collection as participant

Specified by:

withAnyParticipants in interface ConversationQuery

participantsOrOwner

public ConversationQuery participantsOrOwner(Collection<String> participantsOrOwner)

Specified by:

participantsOrOwner in interface ConversationQuery

accessibleByParticipantOrGroups

public ConversationQuery accessibleByParticipantOrGroups(String participantId,
 Collection<String> groups)

Specified by:

accessibleByParticipantOrGroups in interface ConversationQuery

withoutParent

public ConversationQuery withoutParent()

Specified by:

withoutParent in interface ConversationQuery

lastMessageAfter

public ConversationQuery lastMessageAfter(Date lastMessageAfter)

Specified by:

lastMessageAfter in interface ConversationQuery

lastMessageBefore

public ConversationQuery lastMessageBefore(Date lastMessageBefore)

Specified by:

lastMessageBefore in interface ConversationQuery

userAccountId

public ConversationQuery userAccountId(String userAccountId)

Specified by:

userAccountId in interface ConversationQuery

userAccountSubType

public ConversationQuery userAccountSubType(String userAccountSubType)

Specified by:

userAccountSubType in interface ConversationQuery

updateTimeAfter

public ConversationQuery updateTimeAfter(Date updateTimeAfter)

Specified by:

updateTimeAfter in interface ConversationQuery

updateTimeBefore

public ConversationQuery updateTimeBefore(Date updateTimeBefore)

Specified by:

updateTimeBefore in interface ConversationQuery

createdBefore

public ConversationQuery createdBefore(Date createdBefore)

Specified by:

createdBefore in interface ConversationQuery

createdAfter

public ConversationQuery createdAfter(Date createdAfter)

Specified by:

createdAfter in interface ConversationQuery

tagsNotIn

public ConversationQuery tagsNotIn(Collection<String> tagsNotIn)

Specified by:

tagsNotIn in interface ConversationQuery

tagsNotIn

public ConversationQuery tagsNotIn(String tagNotIn)

Specified by:

tagsNotIn in interface ConversationQuery

tagsNotIn

public ConversationQuery tagsNotIn(String tagNotIn,
 String... tagsNotIn)

Specified by:

tagsNotIn in interface ConversationQuery

tags

public ConversationQuery tags(Collection<String> tags)

Specified by:

tags in interface ConversationQuery

tags

public ConversationQuery tags(String tag)

Specified by:

tags in interface ConversationQuery

tags

public ConversationQuery tags(String tag,
 String... tags)

Specified by:

tags in interface ConversationQuery

state

public ConversationQuery state(String state)

Specified by:

state in interface ConversationQuery

tenantId

public ConversationQuery tenantId(String tenantId)

Specified by:

tenantId in interface ConversationQuery

withoutTenantId

public ConversationQuery withoutTenantId()

Specified by:

withoutTenantId in interface ConversationQuery

withoutMessages

public ConversationQuery withoutMessages()

Specified by:

withoutMessages in interface ConversationQuery

starredByUser

public ConversationQuery starredByUser(String userId)

Description copied from interface: ConversationQuery

Select conversations that have been starred by the given user.

Specified by:

starredByUser in interface ConversationQuery

mutedByUser

public ConversationQuery mutedByUser(String userId)

Description copied from interface: ConversationQuery

Select conversations that have been muted by the given user.

Specified by:

mutedByUser in interface ConversationQuery

addTag

protected ConversationQuery addTag(String tag)

addTagNotIn

protected ConversationQuery addTagNotIn(String tagNotIn)

includeIdentityLinks

public ConversationQuery includeIdentityLinks()

Specified by:

includeIdentityLinks in interface ConversationQuery

includeVariables

public ConversationQuery includeVariables()

Specified by:

includeVariables in interface ConversationQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractVariableQueryImpl<ConversationQuery,Conversation>

executeList

public List<Conversation> executeList(CommandContext commandContext)

Specified by:

executeList in class AbstractVariableQueryImpl<ConversationQuery,Conversation>

enhanceCachedValue

public void enhanceCachedValue(ConversationEntity conversation)

Specified by:

enhanceCachedValue in interface CacheAwareQuery<ConversationEntity>

isFalse

public boolean isFalse()

We can't use false in SQL in a DB agnostic way. Therefore this method that always returns false

Returns:

false

isTrue

public boolean isTrue()

We can't use true in SQL in a DB agnostic way. Therefore this method that always returns true

Returns:

true

getIds

public Collection<String> getIds()

getExternalId

public String getExternalId()

getType

public String getType()

getSubType

public String getSubType()

getName

public String getName()

getConversationDefinitionId

public String getConversationDefinitionId()

getReferenceId

public String getReferenceId()

getReferenceType

public String getReferenceType()

getReferenceDefinitionId

public String getReferenceDefinitionId()

getCreatedBefore

public Date getCreatedBefore()

getCreatedAfter

public Date getCreatedAfter()

getTenantId

public String getTenantId()

isWithoutTenantId

public boolean isWithoutTenantId()

getOwnerId

public String getOwnerId()

getWithAllParticipants

public Collection<String> getWithAllParticipants()

getWithAllParticipantsSize

public int getWithAllParticipantsSize()

getWithAnyParticipants

public Collection<String> getWithAnyParticipants()

getParticipantsOrOwner

public Collection<String> getParticipantsOrOwner()

getParticipantsOrOwnerSize

public int getParticipantsOrOwnerSize()

getAccessibleByParticipant

public String getAccessibleByParticipant()

getAccessibleByGroups

public Collection<String> getAccessibleByGroups()

isWithoutParent

public boolean isWithoutParent()

isRequiresIdentityLinks

public boolean isRequiresIdentityLinks()

isWithoutMessages

public boolean isWithoutMessages()

getStarredByUser

public String getStarredByUser()

getMutedByUser

public String getMutedByUser()

getLastMessageAfter

public Date getLastMessageAfter()

getLastMessageBefore

public Date getLastMessageBefore()

getUserAccountId

public String getUserAccountId()

getUserAccountSubType

public String getUserAccountSubType()

getUpdateTimeAfter

public Date getUpdateTimeAfter()

getUpdateTimeBefore

public Date getUpdateTimeBefore()

getTags

public List<String> getTags()

getTagsNotIn

public List<String> getTagsNotIn()

getState

public String getState()

isIncludeIdentityLinks

public boolean isIncludeIdentityLinks()

isIncludeVariables

public boolean isIncludeVariables()

orderByLastMessageTime

public ConversationQuery orderByLastMessageTime()

Specified by:

orderByLastMessageTime in interface ConversationQuery