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	Description
`default MessageQuery`	`accessibleByUser(java.lang.String userId)`	Query all messages for the given user (it will also fetch private messages for that user).
`MessageQuery`	`accessibleByUserOrGroups(java.lang.String userId, java.util.Collection<java.lang.String> groupIds)`	Query all messages for the given user (it will also fetch private messages for that user) or the given groups.
`MessageQuery`	`actionInstanceId(java.lang.String actionInstanceId)`
`MessageQuery`	`category(Category category)`
`MessageQuery`	`conversationId(java.lang.String conversationId)`
`MessageQuery`	`createdAfter(java.util.Date createdAfter)`
`MessageQuery`	`createdAfterOrEqual(java.util.Date createdAfterOrEqual)`
`MessageQuery`	`createdBefore(java.util.Date createdBefore)`
`MessageQuery`	`createdBeforeOrEqual(java.util.Date createdBeforeOrEqual)`
`MessageQuery`	`externalId(java.lang.String externalId)`
`MessageQuery`	`id(java.lang.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(java.lang.String notType)`
`MessageQuery`	`orderByConversationId()`
`MessageQuery`	`orderByCreationTime()`
`MessageQuery`	`referenceId(java.lang.String referenceId)`
`MessageQuery`	`referenceType(java.lang.String referenceType)`
`MessageQuery`	`senderId(java.lang.String senderId)`	Query all messages send by the user with the `senderId`.
`MessageQuery`	`senderIdIn(java.util.Collection<java.lang.String> senderIds)`
`MessageQuery`	`senderIdNotIn(java.util.Collection<java.lang.String> senderIds)`
`MessageQuery`	`subType(java.lang.String subType)`
`MessageQuery`	`type(java.lang.String type)`

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

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

Method Details
- id
  
  MessageQuery id(java.lang.String id)
- externalId
  
  MessageQuery externalId(java.lang.String externalId)
- category
  
  MessageQuery category(Category category)
- conversationId
  
  MessageQuery conversationId(java.lang.String conversationId)
- actionInstanceId
  
  MessageQuery actionInstanceId(java.lang.String actionInstanceId)
- createdAfter
  
  MessageQuery createdAfter(java.util.Date createdAfter)
- createdAfterOrEqual
  
  MessageQuery createdAfterOrEqual(java.util.Date createdAfterOrEqual)
- createdBefore
  
  MessageQuery createdBefore(java.util.Date createdBefore)
- createdBeforeOrEqual
  
  MessageQuery createdBeforeOrEqual(java.util.Date createdBeforeOrEqual)
- accessibleByUser
  
  default MessageQuery accessibleByUser(java.lang.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(java.lang.String userId, java.util.Collection<java.lang.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(java.lang.String subType)
- type
  
  MessageQuery type(java.lang.String type)
- isNotType
  
  MessageQuery isNotType(java.lang.String notType)
- referenceId
  
  MessageQuery referenceId(java.lang.String referenceId)
- referenceType
  
  MessageQuery referenceType(java.lang.String referenceType)
- senderId
  
  MessageQuery senderId(java.lang.String senderId)
  
  Query all messages send by the user with the senderId.
  
  Parameters:
  
  senderId - the id of the sender
- senderIdIn
  
  MessageQuery senderIdIn(java.util.Collection<java.lang.String> senderIds)
- senderIdNotIn
  
  MessageQuery senderIdNotIn(java.util.Collection<java.lang.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()

Interface MessageQuery

Nested Class Summary

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

Method Summary

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

Method Details