Package com.flowable.engage.conversation.api

Interface ConversationQuery

All Superinterfaces:

Query<ConversationQuery,Conversation>

All Known Implementing Classes:

ConversationQueryImpl

public interface ConversationQuery
extends Query<ConversationQuery,Conversation>

Allows for programmatic querying of conversations.

Author:

Filip Hrisafov, Joram Barrez

Nested Class Summary

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

Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method	Description
default ConversationQuery	accessibleByParticipant(String userId)
ConversationQuery	accessibleByParticipantOrGroups(String participantId, Collection<String> groups)
ConversationQuery	conversationDefinitionId(String conversationDefinitionId)
ConversationQuery	createdAfter(Date createdAfter)
ConversationQuery	createdBefore(Date createdBefore)
ConversationQuery	externalId(String externalId)	Select conversation with the given external id.
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()
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> participants)
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 tag)
ConversationQuery	tagsNotIn(String tag, String... tags)
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	variableValueEquals(String name, Object value)	Checks for a conversation with the given variable name and value.
ConversationQuery	variableValueEqualsIgnoreCase(String name, String value)	Checks for a conversation with the given variable name and value ignoring the case of the value.
ConversationQuery	variableValueLike(String name, String valueLike)	Checks for a conversation with the given variable name and value like.
ConversationQuery	variableValueLikeIgnoreCase(String name, String valueLike)	Checks for a conversation with the given variable name and value like ignoring the case of the value.
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 interface org.flowable.common.engine.api.query.Query

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

Method Details

id

ConversationQuery id(String id)

Select a conversation with the given id.

ids

ConversationQuery ids(Collection<String> ids)

Select all conversations with the given ids.

externalId

ConversationQuery externalId(String externalId)

Select conversation with the given external id.

type

ConversationQuery type(String type)

subType

ConversationQuery subType(String subType)

name

ConversationQuery name(String name)

conversationDefinitionId

ConversationQuery conversationDefinitionId(String conversationDefinitionId)

referenceId

ConversationQuery referenceId(String referenceId)

referenceType

ConversationQuery referenceType(String referenceType)

referenceDefinitionId

ConversationQuery referenceDefinitionId(String referenceDefinitionId)

ownerId

ConversationQuery ownerId(String ownerId)

withAllParticipants

ConversationQuery withAllParticipants(Collection<String> withAllParticipants)

Conversations that contain exactly the given withAllParticipants collection and nothing else

withAnyParticipants

ConversationQuery withAnyParticipants(Collection<String> withAnyParticipants)

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

participantsOrOwner

ConversationQuery participantsOrOwner(Collection<String> participants)

accessibleByParticipant

default ConversationQuery accessibleByParticipant(String userId)

accessibleByParticipantOrGroups

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

withoutParent

ConversationQuery withoutParent()

createdAfter

ConversationQuery createdAfter(Date createdAfter)

createdBefore

ConversationQuery createdBefore(Date createdBefore)

lastMessageAfter

ConversationQuery lastMessageAfter(Date lastMessageAfter)

lastMessageBefore

ConversationQuery lastMessageBefore(Date lastMessageBefore)

userAccountId

ConversationQuery userAccountId(String userAccountId)

userAccountSubType

ConversationQuery userAccountSubType(String userAccountSubType)

updateTimeAfter

ConversationQuery updateTimeAfter(Date updateTimeAfter)

updateTimeBefore

ConversationQuery updateTimeBefore(Date updateTimeBefore)

tags

ConversationQuery tags(Collection<String> tags)

tags

ConversationQuery tags(String tag)

tags

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

tagsNotIn

ConversationQuery tagsNotIn(Collection<String> tagsNotIn)

tagsNotIn

ConversationQuery tagsNotIn(String tag)

tagsNotIn

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

state

ConversationQuery state(String state)

variableValueEquals

ConversationQuery variableValueEquals(String name,
 Object value)

Checks for a conversation with the given variable name and value.

Parameters:

name - the name of the variable

value - the value that the variable should have

variableValueEqualsIgnoreCase

ConversationQuery variableValueEqualsIgnoreCase(String name,
 String value)

Checks for a conversation with the given variable name and value ignoring the case of the value.

Parameters:

name - the name of the variable

value - the value that the variable should have

variableValueLike

ConversationQuery variableValueLike(String name,
 String valueLike)

Checks for a conversation with the given variable name and value like.

Parameters:

name - the name of the variable

valueLike - the value like the variable should have ('%' has to be added by the caller itself)

variableValueLikeIgnoreCase

ConversationQuery variableValueLikeIgnoreCase(String name,
 String valueLike)

Checks for a conversation with the given variable name and value like ignoring the case of the value.

Parameters:

name - the name of the variable

valueLike - the value like the variable should have ('%' has to be added by the caller itself)

tenantId

ConversationQuery tenantId(String tenantId)

withoutTenantId

ConversationQuery withoutTenantId()

withoutMessages

ConversationQuery withoutMessages()

starredByUser

ConversationQuery starredByUser(String userId)

Select conversations that have been starred by the given user.

mutedByUser

ConversationQuery mutedByUser(String userId)

Select conversations that have been muted by the given user.

includeIdentityLinks

ConversationQuery includeIdentityLinks()

includeVariables

ConversationQuery includeVariables()

orderByLastMessageTime

ConversationQuery orderByLastMessageTime()