com.flowable.engage.message.api

Interface MessageQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<MessageQuery,Message>

All Known Implementing Classes:

MessageQueryImpl

public interface MessageQuery
extends org.flowable.common.engine.api.query.Query<MessageQuery,Message>

Author:

Filip Hrisafov

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
default MessageQuery	accessibleByUser(String userId) Query all messages for the given user (it will also fetch private messages for that user).
MessageQuery	accessibleByUserOrGroups(String userId, Collection<String> groupIds) Query all messages for the given user (it will also fetch private messages for that user) or the given groups.
MessageQuery	actionInstanceId(String actionInstanceId)
MessageQuery	category(Category category)
MessageQuery	conversationId(String conversationId)
MessageQuery	createdAfter(Date createdAfter)
MessageQuery	createdAfterOrEqual(Date createdAfterOrEqual)
MessageQuery	createdBefore(Date createdBefore)
MessageQuery	createdBeforeOrEqual(Date createdBeforeOrEqual)
MessageQuery	externalId(String externalId)
MessageQuery	id(String id)
MessageQuery	includeMessageAudits() Include the message audits for the queried messages
MessageQuery	includeOnlyStickyMessages() Query on sticky messages only.
MessageQuery	includePrivate() Query all messages (even private ones).
MessageQuery	includeSticky() Query on sticky messages.
MessageQuery	isNotType(String notType)
MessageQuery	orderByConversationId()
MessageQuery	orderByCreationTime()
MessageQuery	referenceId(String referenceId)
MessageQuery	referenceType(String referenceType)
MessageQuery	senderId(String senderId) Query all messages send by the user with the senderId.
MessageQuery	senderIdIn(Collection<String> senderIds)
MessageQuery	senderIdNotIn(Collection<String> senderIds)
MessageQuery	subType(String subType)
MessageQuery	type(String type)

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

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

Method Detail

id

MessageQuery id(String id)

externalId

MessageQuery externalId(String externalId)

category

MessageQuery category(Category category)

conversationId

MessageQuery conversationId(String conversationId)

actionInstanceId

MessageQuery actionInstanceId(String actionInstanceId)

createdAfter

MessageQuery createdAfter(Date createdAfter)

createdAfterOrEqual

MessageQuery createdAfterOrEqual(Date createdAfterOrEqual)

createdBefore

MessageQuery createdBefore(Date createdBefore)

createdBeforeOrEqual

MessageQuery createdBeforeOrEqual(Date createdBeforeOrEqual)

accessibleByUser

default MessageQuery accessibleByUser(String userId)

Query all messages for the given user (it will also fetch private messages for that user). conversationId(String) must be set when doing the query. NB: This will only fetch messages that the user has direct access to (not via groups).

Parameters:

userId - the id of the user for which the messages should be queried

accessibleByUserOrGroups

MessageQuery accessibleByUserOrGroups(String userId,
                                      Collection<String> groupIds)

Query all messages for the given user (it will also fetch private messages for that user) or the given groups. conversationId(String) must bbe set when doing the query.

Parameters:

userId - the id of the user for which messages should be queried

groupIds - the groups ids for which the messages should be queried

subType

MessageQuery subType(String subType)

type

MessageQuery type(String type)

isNotType

MessageQuery isNotType(String notType)

referenceId

MessageQuery referenceId(String referenceId)

referenceType

MessageQuery referenceType(String referenceType)

senderId

MessageQuery senderId(String senderId)

Query all messages send by the user with the senderId.

Parameters:

senderId - the id of the sender

senderIdIn

MessageQuery senderIdIn(Collection<String> senderIds)

senderIdNotIn

MessageQuery senderIdNotIn(Collection<String> senderIds)

includePrivate

MessageQuery includePrivate()

Query all messages (even private ones). If accessibleByUser(String) is used than this has no effect.

includeSticky

MessageQuery includeSticky()

Query on sticky messages.

includeOnlyStickyMessages

MessageQuery includeOnlyStickyMessages()

Query on sticky messages only.

includeMessageAudits

MessageQuery includeMessageAudits()

Include the message audits for the queried messages

orderByCreationTime

MessageQuery orderByCreationTime()

orderByConversationId

MessageQuery orderByConversationId()