java.lang.Object

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

org.flowable.common.engine.impl.query.AbstractQuery<MessageQuery,Message>

com.flowable.engage.engine.impl.message.MessageQueryImpl

All Implemented Interfaces:: MessageQuery, java.io.Serializable, org.flowable.common.engine.api.query.CacheAwareQuery<MessageEntity>, org.flowable.common.engine.api.query.Query<MessageQuery,Message>, org.flowable.common.engine.impl.interceptor.Command<java.lang.Object>

public class MessageQueryImpl
extends org.flowable.common.engine.impl.query.AbstractQuery<MessageQuery,Message>
implements MessageQuery, org.flowable.common.engine.api.query.CacheAwareQuery<MessageEntity>

Author:: Filip Hrisafov
See Also:: Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class MessageQueryImpl.Range

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
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 java.util.Collection<java.lang.String>`	`accessibleByGroups`
`protected java.lang.String`	`accessibleByUser`
`protected java.lang.String`	`actionInstanceId`
`protected boolean`	`bothAccessibleByUserAndGroups`
`protected Category`	`category`
`protected java.lang.String`	`conversationId`
`protected java.util.Date`	`createdAfter`
`protected java.util.Date`	`createdAfterOrEqual`
`protected java.util.Date`	`createdBefore`
`protected java.util.Date`	`createdBeforeOrEqual`
`protected java.lang.String`	`externalId`
`protected java.lang.String`	`id`
`protected boolean`	`includeMessageAudits`
`protected boolean`	`includeOnlyStickyMessages`
`protected boolean`	`includePrivate`
`protected boolean`	`includeSticky`
`protected java.lang.String`	`isNotType`
`protected java.util.Collection<java.lang.String>`	`notSenderIds`
`protected java.util.List<MessageQueryImpl.Range>`	`ranges`
`protected java.lang.String`	`referenceId`
`protected java.lang.String`	`referenceType`
`protected java.lang.String`	`senderId`
`protected java.util.Collection<java.lang.String>`	`senderIds`
`protected java.lang.String`	`subType`
`protected java.lang.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, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByColumnMap, orderByColumns, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors

Constructor Description

MessageQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
`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)`
`protected void`	`computeAccessibleRanges(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)`
`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)`
`long`	`executeCount(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)`
`java.util.List<Message>`	`executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)`
`MessageQuery`	`externalId(java.lang.String externalId)`
`java.lang.String`	`getAccessibleByUser()`
`java.lang.String`	`getActionInstanceId()`
`Category`	`getCategory()`
`java.lang.String`	`getConversationId()`
`java.util.Date`	`getCreatedAfter()`
`java.util.Date`	`getCreatedAfterOrEqual()`
`java.util.Date`	`getCreatedBefore()`
`java.util.Date`	`getCreatedBeforeOrEqual()`
`java.lang.String`	`getExternalId()`
`java.lang.String`	`getId()`
`java.util.Collection<java.lang.String>`	`getNotSenderIds()`
`java.lang.String`	`getOrderByColumns()`
`java.util.List<MessageQueryImpl.Range>`	`getRanges()`
`java.lang.String`	`getReferenceId()`
`java.lang.String`	`getReferenceType()`
`java.lang.String`	`getSenderId()`
`java.util.Collection<java.lang.String>`	`getSenderIds()`
`java.lang.String`	`getSubType()`
`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.
`boolean`	`isBothAccessibleByUserAndGroups()`
`boolean`	`isFalse()`	We can't use `false` in SQL in a DB agnostic way.
`boolean`	`isIncludeMessageAudits()`
`boolean`	`isIncludePrivate()`
`boolean`	`isIncludeSticky()`
`MessageQuery`	`isNotType(java.lang.String notType)`
`boolean`	`isTrue()`
`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> notSenderIds)`
`MessageQuery`	`subType(java.lang.String subType)`
`MessageQuery`	`type(java.lang.String type)`

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, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByColumnMap, getParameter, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setOrderByColumns, 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.CacheAwareQuery

enhanceCachedValue

Methods inherited from interface com.flowable.engage.message.api.MessageQuery

accessibleByUser

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

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

Field Details
- id
  
  protected java.lang.String id
- externalId
  
  protected java.lang.String externalId
- category
  
  protected Category category
- conversationId
  
  protected java.lang.String conversationId
- actionInstanceId
  
  protected java.lang.String actionInstanceId
- createdAfter
  
  protected java.util.Date createdAfter
- createdAfterOrEqual
  
  protected java.util.Date createdAfterOrEqual
- createdBefore
  
  protected java.util.Date createdBefore
- createdBeforeOrEqual
  
  protected java.util.Date createdBeforeOrEqual
- accessibleByUser
  
  protected java.lang.String accessibleByUser
- accessibleByGroups
  
  protected java.util.Collection<java.lang.String> accessibleByGroups
- subType
  
  protected java.lang.String subType
- type
  
  protected java.lang.String type
- isNotType
  
  protected java.lang.String isNotType
- referenceId
  
  protected java.lang.String referenceId
- referenceType
  
  protected java.lang.String referenceType
- senderId
  
  protected java.lang.String senderId
- senderIds
  
  protected java.util.Collection<java.lang.String> senderIds
- notSenderIds
  
  protected java.util.Collection<java.lang.String> notSenderIds
- ranges
  
  protected java.util.List<MessageQueryImpl.Range> ranges
- includePrivate
  
  protected boolean includePrivate
- includeSticky
  
  protected boolean includeSticky
- includeOnlyStickyMessages
  
  protected boolean includeOnlyStickyMessages
- includeMessageAudits
  
  protected boolean includeMessageAudits
- bothAccessibleByUserAndGroups
  
  protected boolean bothAccessibleByUserAndGroups
Constructor Details
- MessageQueryImpl
  
  public MessageQueryImpl(org.flowable.common.engine.impl.interceptor.CommandExecutor commandExecutor)
Method Details
- id
  
  public MessageQuery id(java.lang.String id)
  
  Specified by:
  
  id in interface MessageQuery
- externalId
  
  public MessageQuery externalId(java.lang.String externalId)
  
  Specified by:
  
  externalId in interface MessageQuery
- category
  
  public MessageQuery category(Category category)
  
  Specified by:
  
  category in interface MessageQuery
- conversationId
  
  public MessageQuery conversationId(java.lang.String conversationId)
  
  Specified by:
  
  conversationId in interface MessageQuery
- actionInstanceId
  
  public MessageQuery actionInstanceId(java.lang.String actionInstanceId)
  
  Specified by:
  
  actionInstanceId in interface MessageQuery
- createdAfter
  
  public MessageQuery createdAfter(java.util.Date createdAfter)
  
  Specified by:
  
  createdAfter in interface MessageQuery
- createdAfterOrEqual
  
  public MessageQuery createdAfterOrEqual(java.util.Date createdAfterOrEqual)
  
  Specified by:
  
  createdAfterOrEqual in interface MessageQuery
- createdBefore
  
  public MessageQuery createdBefore(java.util.Date createdBefore)
  
  Specified by:
  
  createdBefore in interface MessageQuery
- createdBeforeOrEqual
  
  public MessageQuery createdBeforeOrEqual(java.util.Date createdBeforeOrEqual)
  
  Specified by:
  
  createdBeforeOrEqual in interface MessageQuery
- accessibleByUserOrGroups
  
  public MessageQuery accessibleByUserOrGroups(java.lang.String userId, java.util.Collection<java.lang.String> groupIds)
  
  Description copied from interface: MessageQuery
  
  Query all messages for the given user (it will also fetch private messages for that user) or the given groups. MessageQuery.conversationId(String) must bbe set when doing the query.
  
  Specified by:
  
  accessibleByUserOrGroups in interface MessageQuery
  
  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
  
  public MessageQuery subType(java.lang.String subType)
  
  Specified by:
  
  subType in interface MessageQuery
- type
  
  public MessageQuery type(java.lang.String type)
  
  Specified by:
  
  type in interface MessageQuery
- isNotType
  
  public MessageQuery isNotType(java.lang.String notType)
  
  Specified by:
  
  isNotType in interface MessageQuery
- referenceId
  
  public MessageQuery referenceId(java.lang.String referenceId)
  
  Specified by:
  
  referenceId in interface MessageQuery
- referenceType
  
  public MessageQuery referenceType(java.lang.String referenceType)
  
  Specified by:
  
  referenceType in interface MessageQuery
- senderId
  
  public MessageQuery senderId(java.lang.String senderId)
  
  Description copied from interface: MessageQuery
  
  Query all messages send by the user with the senderId.
  
  Specified by:
  
  senderId in interface MessageQuery
  
  Parameters:
  
  senderId - the id of the sender
- senderIdIn
  
  public MessageQuery senderIdIn(java.util.Collection<java.lang.String> senderIds)
  
  Specified by:
  
  senderIdIn in interface MessageQuery
- senderIdNotIn
  
  public MessageQuery senderIdNotIn(java.util.Collection<java.lang.String> notSenderIds)
  
  Specified by:
  
  senderIdNotIn in interface MessageQuery
- includePrivate
  
  public MessageQuery includePrivate()
  
  Description copied from interface: MessageQuery
  
  Query all messages (even private ones). If MessageQuery.accessibleByUser(String) is used than this has no effect.
  
  Specified by:
  
  includePrivate in interface MessageQuery
- includeSticky
  
  public MessageQuery includeSticky()
  
  Description copied from interface: MessageQuery
  
  Query on sticky messages.
  
  Specified by:
  
  includeSticky in interface MessageQuery
- includeOnlyStickyMessages
  
  public MessageQuery includeOnlyStickyMessages()
  
  Description copied from interface: MessageQuery
  
  Query on sticky messages only.
  
  Specified by:
  
  includeOnlyStickyMessages in interface MessageQuery
- includeMessageAudits
  
  public MessageQuery includeMessageAudits()
  
  Description copied from interface: MessageQuery
  
  Include the message audits for the queried messages
  
  Specified by:
  
  includeMessageAudits in interface MessageQuery
- executeCount
  
  public long executeCount(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
  
  Specified by:
  
  executeCount in class org.flowable.common.engine.impl.query.AbstractQuery<MessageQuery,Message>
- executeList
  
  public java.util.List<Message> executeList(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
  
  Specified by:
  
  executeList in class org.flowable.common.engine.impl.query.AbstractQuery<MessageQuery,Message>
- computeAccessibleRanges
  
  protected void computeAccessibleRanges(org.flowable.common.engine.impl.interceptor.CommandContext commandContext)
- getId
  
  public java.lang.String getId()
  
  Specified by:
  
  getId in interface org.flowable.common.engine.api.query.CacheAwareQuery<MessageEntity>
- getExternalId
  
  public java.lang.String getExternalId()
- getCategory
  
  public Category getCategory()
- getConversationId
  
  public java.lang.String getConversationId()
- getActionInstanceId
  
  public java.lang.String getActionInstanceId()
- getCreatedAfter
  
  public java.util.Date getCreatedAfter()
- getCreatedAfterOrEqual
  
  public java.util.Date getCreatedAfterOrEqual()
- getCreatedBefore
  
  public java.util.Date getCreatedBefore()
- getCreatedBeforeOrEqual
  
  public java.util.Date getCreatedBeforeOrEqual()
- getAccessibleByUser
  
  public java.lang.String getAccessibleByUser()
- getSubType
  
  public java.lang.String getSubType()
- getReferenceId
  
  public java.lang.String getReferenceId()
- getReferenceType
  
  public java.lang.String getReferenceType()
- getSenderId
  
  public java.lang.String getSenderId()
- getSenderIds
  
  public java.util.Collection<java.lang.String> getSenderIds()
- getNotSenderIds
  
  public java.util.Collection<java.lang.String> getNotSenderIds()
- isIncludePrivate
  
  public boolean isIncludePrivate()
- isIncludeSticky
  
  public boolean isIncludeSticky()
- isIncludeMessageAudits
  
  public boolean isIncludeMessageAudits()
- isBothAccessibleByUserAndGroups
  
  public boolean isBothAccessibleByUserAndGroups()
- 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()
- getRanges
  
  public java.util.List<MessageQueryImpl.Range> getRanges()
- getOrderByColumns
  
  public java.lang.String getOrderByColumns()
  
  Overrides:
  
  getOrderByColumns in class org.flowable.common.engine.impl.db.ListQueryParameterObject
- orderByCreationTime
  
  public MessageQuery orderByCreationTime()
  
  Specified by:
  
  orderByCreationTime in interface MessageQuery
- orderByConversationId
  
  public MessageQuery orderByConversationId()
  
  Specified by:
  
  orderByConversationId in interface MessageQuery

Class MessageQueryImpl

Nested Class Summary

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

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