ConversationEntityImpl (Flowable Engage 3.5.0)

java.lang.Object
- org.flowable.common.engine.impl.persistence.entity.AbstractEntity
- - com.flowable.engage.engine.impl.persistence.entity.AbstractEngageEngineEntity
  - - com.flowable.engage.engine.impl.persistence.entity.ConversationEntityImpl

All Implemented Interfaces:

Permissions, Taggable, Conversation, ConversationEntity, org.flowable.common.engine.impl.db.HasRevision, org.flowable.common.engine.impl.persistence.entity.Entity
```
public class ConversationEntityImpl
extends AbstractEngageEngineEntity
implements ConversationEntity
```
Author:

Filip Hrisafov

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`avatarId`
`protected String`	`conversationDefinitionId`
`protected Date`	`creationTime`
`protected String`	`creatorId`
`protected String`	`description`
`protected String`	`externalId`
`protected String`	`fallbackName`
`protected List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>`	`identityLinks` The identity links for the conversation.
`protected boolean`	`identityLinksInitialized`
`protected String`	`joiningType`
`protected Date`	`lastMessageTime`
`protected Map<String,Object>`	`metaData`
`protected String`	`name`
`protected String`	`parentId`
`protected String`	`permissionType`
`protected Integer`	`priority`
`protected List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity>`	`queryVariables`
`protected String`	`referenceDefinitionId`
`protected String`	`referenceId`
`protected String`	`referenceType`
`protected Date`	`resubmissionTime`
`protected String`	`state`
`protected String`	`subType`
`protected List<String>`	`tags`
`protected String`	`tenantId`
`protected String`	`type`
`protected String`	`updaterId`
`protected Date`	`updateTime`
`protected String`	`userAccountId`
`protected boolean`	`variablesInitialized`

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
id, isDeleted, isInserted, isUpdated, originalPersistentState, revision

Constructor Summary

Constructors
Constructor and Description

ConversationEntityImpl()

Constructors
Constructor and Description
`ConversationEntityImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAssignedGroupId()` Returns the id of the assigned group of this object.
`String`	`getAssigneeId()` Returns the id of the assignee of this conversation.
`String`	`getAvatarId()` Returns the optional avatar info, if this conversation has an avatar attached.
`Set<String>`	`getCandidateGroupIds()` Returns a set view of the optional list of candidate group ids of this conversation.
`Set<String>`	`getCandidateUserIds()` Returns a set view of the optional list of candidate user ids of this conversation.
`String`	`getConversationDefinitionId()` The definition id of the conversation definition type
`Map<String,Object>`	`getConversationVariables()` Returns the conversation variables when used within a conversation query with the include variables method invoked.
`Date`	`getCreationTime()` Returns the creation timestamp of this conversation.
`String`	`getCreatorId()` Returns the id of the user creating this conversation.
`String`	`getDescription()` Returns the optional description for this conversation, containing the means of its discussed topics, any global notes or whatever is necessary as a global overview of the conversation.
`String`	`getExternalId()` If the conversation was created from an external system, this optional external id might be used to map to that external conversation id, if necessary.
`String`	`getFallbackName()` The fallback that needs to be used in case `Conversation.getName()` is not set.
`List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>`	`getIdentityLinks()` Returns the identity links.
`String`	`getJoiningType()` Returns the joining type of this conversation which defines on how new participants might join the running conversation.
`Date`	`getLastMessageTime()` The time when the last message of the conversation has ben sent.
`Map<String,Object>`	`getMetaData()` A conversation can have additional meta information, most likely describing the conversation behavior in more detail.
`String`	`getName()` Returns the optional name of this conversation, most likely representing the main topic of the conversation.
`String`	`getOwnerId()` Returns the id of the owner of this conversation, most likely representing the user actually creating it or being created as part of an operation that user executed.
`String`	`getParentId()` Returns the optional parent id of this conversation, if any, which represents another work item, the parent for this conversation (might be another conversation object or any other work item this conversation is attached to).
`String`	`getPermissionType()` Returns the permission type for this conversation which is used to drive the permissions for messages and events sent to this conversation.
`Object`	`getPersistentState()`
`Integer`	`getPriority()` Returns the optional priority of this conversation which can be used for sorting or other means.
`List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity>`	`getQueryIdentityLinks()` Getter used by MyBatis when querying conversation with identity links.
`List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity>`	`getQueryVariables()` Getter used by MyBatis when querying conversation with variables.
`String`	`getReferenceDefinitionId()` The definition id of the scoped entity (for example Task Definition id, Case Definition Id, etc)
`String`	`getReferenceId()` An id of the scoped linked entity (for example Task, Case, etc)
`String`	`getReferenceType()` The type of the scoped linked entity
`Date`	`getResubmissionTime()` Returns the optional resubmission time for this conversation.
`String`	`getState()` Returns the state of this conversation.
`String`	`getSubType()` Returns the sub type of this conversation.
`List<String>`	`getTags()` Returns the optional list of tags for this object.
`String`	`getTenantId()` Returns the id of the tenant this conversation belongs to.
`String`	`getType()` Returns the type of this conversation.
`String`	`getUpdaterId()` Returns the id of the user updating this conversation.
`Date`	`getUpdateTime()` Returns the timestamp of the last update of this conversation, which is the case if anything has changed in the conversation itself or if there was a message posted to this conversation.
`String`	`getUserAccountId()` The id of the user account that is linked with this conversation.
`boolean`	`isIdentityLinksInitialized()`
`Boolean`	`isPinned()` Returns true, if this conversation is pinned by the current user.
`Boolean`	`isStarred()` Returns true, if this conversation is starred by the current user.
`boolean`	`isVariablesInitialized()`
`void`	`setAvatarId(String avatarId)`
`void`	`setConversationDefinitionId(String conversationDefinitionId)`
`void`	`setCreationTime(Date creationTime)`
`void`	`setCreatorId(String creatorId)`
`void`	`setDescription(String description)`
`void`	`setExternalId(String externalId)`
`void`	`setFallbackName(String fallbackName)`
`void`	`setIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)`
`void`	`setJoiningType(String joiningType)`
`void`	`setLastMessageTime(Date lastMessageTime)`
`void`	`setMetaData(Map<String,Object> metaData)`
`void`	`setName(String name)`
`void`	`setParentId(String parentId)`
`void`	`setPermissionType(String permissionType)`
`void`	`setPriority(Integer priority)`
`void`	`setQueryIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)` Setter used by MyBatis when querying conversation with identity links.
`void`	`setQueryVariables(List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> queryVariables)` Setter used by MyBatis when querying conversation with variables.
`void`	`setReferenceDefinitionId(String referenceDefinitionId)`
`void`	`setReferenceId(String referenceId)`
`void`	`setReferenceType(String referenceType)`
`void`	`setResubmissionTime(Date resubmissionTime)`
`void`	`setState(String state)`
`void`	`setSubType(String subType)`
`void`	`setTags(List<String> tags)`
`void`	`setTenantId(String tenantId)`
`void`	`setType(String type)`
`void`	`setUpdaterId(String updaterId)`
`void`	`setUpdateTime(Date updateTime)`
`void`	`setUserAccountId(String userAccountId)`

Methods inherited from class com.flowable.engage.engine.impl.persistence.entity.AbstractEngageEngineEntity
getIdPrefix

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

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.Conversation
getId

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity
getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision
getRevision, getRevisionNext, setRevision

- Field Detail
  - externalId
```
protected String externalId
```
  - tenantId
```
protected String tenantId
```
  - parentId
```
protected String parentId
```
  - referenceId
```
protected String referenceId
```
  - referenceType
```
protected String referenceType
```
  - referenceDefinitionId
```
protected String referenceDefinitionId
```
  - conversationDefinitionId
```
protected String conversationDefinitionId
```
  - state
```
protected String state
```
  - type
```
protected String type
```
  - subType
```
protected String subType
```
  - permissionType
```
protected String permissionType
```
  - joiningType
```
protected String joiningType
```
  - priority
```
protected Integer priority
```
  - name
```
protected String name
```
  - fallbackName
```
protected String fallbackName
```
  - description
```
protected String description
```
  - avatarId
```
protected String avatarId
```
  - creationTime
```
protected Date creationTime
```
  - creatorId
```
protected String creatorId
```
  - updateTime
```
protected Date updateTime
```
  - updaterId
```
protected String updaterId
```
  - resubmissionTime
```
protected Date resubmissionTime
```
  - lastMessageTime
```
protected Date lastMessageTime
```
  - userAccountId
```
protected String userAccountId
```
  - metaData
```
protected Map<String,Object> metaData
```
  - identityLinksInitialized
```
protected boolean identityLinksInitialized
```
  - identityLinks
```
protected List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks
```
    The identity links for the conversation. Make sure that it is not set otherwise MyBatis won't invoke the setter.
  - variablesInitialized
```
protected boolean variablesInitialized
```
  - queryVariables
```
protected List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> queryVariables
```
  - tags
```
protected List<String> tags
```
- Constructor Detail
  - ConversationEntityImpl
```
public ConversationEntityImpl()
```
- Method Detail
  - getExternalId
```
public String getExternalId()
```
    Description copied from interface: Conversation
    
    If the conversation was created from an external system, this optional external id might be used to map to that external conversation id, if necessary.
    
    Specified by:
    
    getExternalId in interface Conversation
    
    Returns:
    
    the optional external id of this conversation
  - setExternalId
```
public void setExternalId(String externalId)
```
    Specified by:
    
    setExternalId in interface ConversationEntity
  - getTenantId
```
public String getTenantId()
```
    Description copied from interface: Conversation
    
    Returns the id of the tenant this conversation belongs to.
    
    Specified by:
    
    getTenantId in interface Conversation
    
    Returns:
    
    the tenant id
  - setTenantId
```
public void setTenantId(String tenantId)
```
    Specified by:
    
    setTenantId in interface ConversationEntity
  - getParentId
```
public String getParentId()
```
    Description copied from interface: Conversation
    
    Returns the optional parent id of this conversation, if any, which represents another work item, the parent for this conversation (might be another conversation object or any other work item this conversation is attached to).
    
    Specified by:
    
    getParentId in interface Conversation
    
    Returns:
    
    the optional parent work item id
  - setParentId
```
public void setParentId(String parentId)
```
    Specified by:
    
    setParentId in interface ConversationEntity
  - getReferenceId
```
public String getReferenceId()
```
    Description copied from interface: Conversation
    
    An id of the scoped linked entity (for example Task, Case, etc)
    
    Specified by:
    
    getReferenceId in interface Conversation
    
    Returns:
    
    the id of the scoped entity
  - setReferenceId
```
public void setReferenceId(String referenceId)
```
    Specified by:
    
    setReferenceId in interface ConversationEntity
  - getReferenceType
```
public String getReferenceType()
```
    Description copied from interface: Conversation
    
    The type of the scoped linked entity
    
    Specified by:
    
    getReferenceType in interface Conversation
    
    Returns:
    
    the type of the scoped linked entity
  - setReferenceType
```
public void setReferenceType(String referenceType)
```
    Specified by:
    
    setReferenceType in interface ConversationEntity
  - getReferenceDefinitionId
```
public String getReferenceDefinitionId()
```
    Description copied from interface: Conversation
    
    The definition id of the scoped entity (for example Task Definition id, Case Definition Id, etc)
    
    Specified by:
    
    getReferenceDefinitionId in interface Conversation
    
    Returns:
    
    the definition id of the scoped entity
  - setReferenceDefinitionId
```
public void setReferenceDefinitionId(String referenceDefinitionId)
```
    Specified by:
    
    setReferenceDefinitionId in interface ConversationEntity
  - getConversationDefinitionId
```
public String getConversationDefinitionId()
```
    Description copied from interface: Conversation
    
    The definition id of the conversation definition type
    
    Specified by:
    
    getConversationDefinitionId in interface Conversation
    
    Returns:
    
    the definition id of the conversation definition
  - setConversationDefinitionId
```
public void setConversationDefinitionId(String conversationDefinitionId)
```
    Specified by:
    
    setConversationDefinitionId in interface ConversationEntity
  - getState
```
public String getState()
```
    Description copied from interface: Conversation
    
    Returns the state of this conversation.
    
    Specified by:
    
    getState in interface Conversation
    
    Returns:
    
    the state of this conversation
  - setState
```
public void setState(String state)
```
    Specified by:
    
    setState in interface ConversationEntity
  - getType
```
public String getType()
```
    Description copied from interface: Conversation
    
    Returns the type of this conversation. See ConversationTypes.
    
    Specified by:
    
    getType in interface Conversation
    
    Returns:
    
    the type of this conversation
  - setType
```
public void setType(String type)
```
    Specified by:
    
    setType in interface ConversationEntity
  - getSubType
```
public String getSubType()
```
    Description copied from interface: Conversation
    
    Returns the sub type of this conversation. The sub type might be used for filtering or even driving some of the behavior of the conversation, its participants and messages.
    
    Specified by:
    
    getSubType in interface Conversation
    
    Returns:
    
    the sub type of this conversation
  - setSubType
```
public void setSubType(String subType)
```
    Specified by:
    
    setSubType in interface ConversationEntity
  - getPermissionType
```
public String getPermissionType()
```
    Description copied from interface: Conversation
    
    Returns the permission type for this conversation which is used to drive the permissions for messages and events sent to this conversation.
    
    Specified by:
    
    getPermissionType in interface Conversation
    
    Returns:
    
    the permission type for this conversation
  - setPermissionType
```
public void setPermissionType(String permissionType)
```
    Specified by:
    
    setPermissionType in interface ConversationEntity
  - getJoiningType
```
public String getJoiningType()
```
    Description copied from interface: Conversation
    
    Returns the joining type of this conversation which defines on how new participants might join the running conversation.
    
    Specified by:
    
    getJoiningType in interface Conversation
    
    Returns:
    
    the joining type of this conversation
  - setJoiningType
```
public void setJoiningType(String joiningType)
```
    Specified by:
    
    setJoiningType in interface ConversationEntity
  - getPriority
```
public Integer getPriority()
```
    Description copied from interface: Conversation
    
    Returns the optional priority of this conversation which can be used for sorting or other means.
    
    Specified by:
    
    getPriority in interface Conversation
    
    Returns:
    
    the priority of this conversation
  - setPriority
```
public void setPriority(Integer priority)
```
    Specified by:
    
    setPriority in interface ConversationEntity
  - isPinned
```
public Boolean isPinned()
```
    Description copied from interface: Conversation
    
    Returns true, if this conversation is pinned by the current user. If there is no current user id available or the list of pinned user ids is not available, this method might return null.
    
    Specified by:
    
    isPinned in interface Conversation
    
    Returns:
    
    true if this conversation is pinned by the current user, false if it is not pinned by the current user, null if pinning for the current user cannot be determined
  - isStarred
```
public Boolean isStarred()
```
    Description copied from interface: Conversation
    
    Returns true, if this conversation is starred by the current user. If there is no current user id available or the list of starred user ids is not available, this method might return null.
    
    Specified by:
    
    isStarred in interface Conversation
    
    Returns:
    
    true if this conversation is starred by the current user, false if it is not starred by the current user, null if starring for the current user cannot be determined
  - getName
```
public String getName()
```
    Description copied from interface: Conversation
    
    Returns the optional name of this conversation, most likely representing the main topic of the conversation.
    
    Specified by:
    
    getName in interface Conversation
    
    Returns:
    
    the name of this conversation, might be null
  - setName
```
public void setName(String name)
```
    Specified by:
    
    setName in interface ConversationEntity
  - getFallbackName
```
public String getFallbackName()
```
    Description copied from interface: Conversation
    
    The fallback that needs to be used in case Conversation.getName() is not set.
    
    Specified by:
    
    getFallbackName in interface Conversation
    
    Returns:
    
    the fallback name that needs to be used
  - setFallbackName
```
public void setFallbackName(String fallbackName)
```
    Specified by:
    
    setFallbackName in interface ConversationEntity
  - getDescription
```
public String getDescription()
```
    Description copied from interface: Conversation
    
    Returns the optional description for this conversation, containing the means of its discussed topics, any global notes or whatever is necessary as a global overview of the conversation.
    
    Specified by:
    
    getDescription in interface Conversation
    
    Returns:
    
    the optional description for this conversation
  - setDescription
```
public void setDescription(String description)
```
    Specified by:
    
    setDescription in interface ConversationEntity
  - getAvatarId
```
public String getAvatarId()
```
    Description copied from interface: Conversation
    
    Returns the optional avatar info, if this conversation has an avatar attached.
    
    Specified by:
    
    getAvatarId in interface Conversation
    
    Returns:
    
    the optional avatar info
  - setAvatarId
```
public void setAvatarId(String avatarId)
```
    Specified by:
    
    setAvatarId in interface ConversationEntity
  - getCreationTime
```
public Date getCreationTime()
```
    Description copied from interface: Conversation
    
    Returns the creation timestamp of this conversation.
    
    Specified by:
    
    getCreationTime in interface Conversation
    
    Returns:
    
    the creation timestamp
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    Specified by:
    
    setCreationTime in interface ConversationEntity
  - getCreatorId
```
public String getCreatorId()
```
    Description copied from interface: Conversation
    
    Returns the id of the user creating this conversation.
    
    Specified by:
    
    getCreatorId in interface Conversation
    
    Returns:
    
    the id of the creation user
  - setCreatorId
```
public void setCreatorId(String creatorId)
```
    Specified by:
    
    setCreatorId in interface ConversationEntity
  - getUpdateTime
```
public Date getUpdateTime()
```
    Description copied from interface: Conversation
    
    Returns the timestamp of the last update of this conversation, which is the case if anything has changed in the conversation itself or if there was a message posted to this conversation.
    
    Specified by:
    
    getUpdateTime in interface Conversation
    
    Returns:
    
    the timestamp of the last update / modification conversation or one of its messages
  - setUpdateTime
```
public void setUpdateTime(Date updateTime)
```
    Specified by:
    
    setUpdateTime in interface ConversationEntity
  - getUpdaterId
```
public String getUpdaterId()
```
    Description copied from interface: Conversation
    
    Returns the id of the user updating this conversation.
    
    Specified by:
    
    getUpdaterId in interface Conversation
    
    Returns:
    
    the id of the updater user
  - setUpdaterId
```
public void setUpdaterId(String updaterId)
```
    Specified by:
    
    setUpdaterId in interface ConversationEntity
  - getResubmissionTime
```
public Date getResubmissionTime()
```
    Description copied from interface: Conversation
    
    Returns the optional resubmission time for this conversation. Resubmit a conversation means to actually hide it until a given resubmission time where it will appear again as a regular conversation.
    
    Specified by:
    
    getResubmissionTime in interface Conversation
    
    Returns:
    
    the optional resubmission time of this conversation, might be null
  - setResubmissionTime
```
public void setResubmissionTime(Date resubmissionTime)
```
    Specified by:
    
    setResubmissionTime in interface ConversationEntity
  - getLastMessageTime
```
public Date getLastMessageTime()
```
    Description copied from interface: Conversation
    
    The time when the last message of the conversation has ben sent.
    
    Specified by:
    
    getLastMessageTime in interface Conversation
    
    Returns:
    
    the last message time of the conversation
  - setLastMessageTime
```
public void setLastMessageTime(Date lastMessageTime)
```
    Specified by:
    
    setLastMessageTime in interface ConversationEntity
  - getUserAccountId
```
public String getUserAccountId()
```
    Description copied from interface: Conversation
    
    The id of the user account that is linked with this conversation. This would usually mean that this conversation is an external conversation for the given user account.
    
    Specified by:
    
    getUserAccountId in interface Conversation
    
    Returns:
    
    the id of the user account that this conversation is linked to
  - setUserAccountId
```
public void setUserAccountId(String userAccountId)
```
    Specified by:
    
    setUserAccountId in interface ConversationEntity
  - getMetaData
```
public Map<String,Object> getMetaData()
```
    Description copied from interface: Conversation
    
    A conversation can have additional meta information, most likely describing the conversation behavior in more detail. The meta data is stored as a JSON string within a single variable.
    
    Specified by:
    
    getMetaData in interface Conversation
    
    Returns:
    
    the optional map of meta information or null if this conversation does not have any meta data
  - setMetaData
```
public void setMetaData(Map<String,Object> metaData)
```
    Specified by:
    
    setMetaData in interface ConversationEntity
  - getIdentityLinks
```
public List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getIdentityLinks()
```
    Description copied from interface: Conversation
    
    Returns the identity links.
    
    Specified by:
    
    getIdentityLinks in interface Conversation
    
    Specified by:
    
    getIdentityLinks in interface ConversationEntity
  - setIdentityLinks
```
public void setIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
```
    Specified by:
    
    setIdentityLinks in interface ConversationEntity
  - getQueryIdentityLinks
```
public List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getQueryIdentityLinks()
```
    Getter used by MyBatis when querying conversation with identity links.
  - setQueryIdentityLinks
```
public void setQueryIdentityLinks(List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
```
    Setter used by MyBatis when querying conversation with identity links.
  - isIdentityLinksInitialized
```
public boolean isIdentityLinksInitialized()
```
    Specified by:
    
    isIdentityLinksInitialized in interface ConversationEntity
  - getOwnerId
```
public String getOwnerId()
```
    Description copied from interface: Conversation
    
    Returns the id of the owner of this conversation, most likely representing the user actually creating it or being created as part of an operation that user executed. Most likely the owner of a conversation is also given the access right to add and remove participants (depending on the permission type of the conversation).
    
    Specified by:
    
    getOwnerId in interface Permissions
    
    Specified by:
    
    getOwnerId in interface Conversation
    
    Returns:
    
    the id of the user being the owner of this conversation
  - getAssigneeId
```
public String getAssigneeId()
```
    Description copied from interface: Conversation
    
    Returns the id of the assignee of this conversation. In most cases, the assignee is not explicitly used and hence optional, but for some specific permission type cases, the assignee of a conversation might be given certain permissions to handle particular aspects of a conversation.
    
    Specified by:
    
    getAssigneeId in interface Permissions
    
    Specified by:
    
    getAssigneeId in interface Conversation
    
    Returns:
    
    the optional id of the user being the assignee of the conversation
  - getAssignedGroupId
```
public String getAssignedGroupId()
```
    Description copied from interface: Permissions
    
    Returns the id of the assigned group of this object. What the assigned group actually represents is up to the objects use cases and implementation.
    
    Specified by:
    
    getAssignedGroupId in interface Permissions
    
    Returns:
    
    the id of the optional assigned group
  - getCandidateUserIds
```
public Set<String> getCandidateUserIds()
```
    Description copied from interface: Conversation
    
    Returns a set view of the optional list of candidate user ids of this conversation. In most cases, this list actually represents the participants of a conversation and messages / events within that conversation are sent to.
    
    Specified by:
    
    getCandidateUserIds in interface Permissions
    
    Specified by:
    
    getCandidateUserIds in interface Conversation
    
    Returns:
    
    the optional list of candidate user ids attached to this conversation
  - getCandidateGroupIds
```
public Set<String> getCandidateGroupIds()
```
    Description copied from interface: Conversation
    
    Returns a set view of the optional list of candidate group ids of this conversation. Like with the list of candidate users, all users being at least a member of one of the candidate groups will also become participants of this conversation.
    
    Specified by:
    
    getCandidateGroupIds in interface Permissions
    
    Specified by:
    
    getCandidateGroupIds in interface Conversation
    
    Returns:
    
    the optional list of candidate group ids attached to this conversation
  - isVariablesInitialized
```
public boolean isVariablesInitialized()
```
    Specified by:
    
    isVariablesInitialized in interface ConversationEntity
  - getConversationVariables
```
public Map<String,Object> getConversationVariables()
```
    Description copied from interface: Conversation
    
    Returns the conversation variables when used within a conversation query with the include variables method invoked. Otherwise an empty map is returned.
    
    Specified by:
    
    getConversationVariables in interface Conversation
    
    Returns:
    
    the variables linked to the conversation
  - getQueryVariables
```
public List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> getQueryVariables()
```
    Getter used by MyBatis when querying conversation with variables.
    
    Specified by:
    
    getQueryVariables in interface ConversationEntity
  - setQueryVariables
```
public void setQueryVariables(List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> queryVariables)
```
    Setter used by MyBatis when querying conversation with variables.
    
    Specified by:
    
    setQueryVariables in interface ConversationEntity
  - getTags
```
public List<String> getTags()
```
    Description copied from interface: Taggable
    
    Returns the optional list of tags for this object. Tags might be used for different reasons, most likely for filtering and to have an impact on how the object might be rendered.
    
    Specified by:
    
    getTags in interface Taggable
    
    Returns:
    
    the optional list of tags, might be null or empty
  - setTags
```
public void setTags(List<String> tags)
```
    Specified by:
    
    setTags in interface ConversationEntity
  - getPersistentState
```
public Object getPersistentState()
```
    Specified by:
    
    getPersistentState in interface org.flowable.common.engine.impl.persistence.entity.Entity

Class ConversationEntityImpl

Field Summary

Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Constructor Summary

Method Summary

Methods inherited from class com.flowable.engage.engine.impl.persistence.entity.AbstractEngageEngineEntity

Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

Methods inherited from class java.lang.Object

Methods inherited from interface com.flowable.engage.conversation.api.Conversation

Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

Field Detail

externalId

tenantId

parentId

referenceId

referenceType

referenceDefinitionId

conversationDefinitionId

state

type

subType

permissionType

joiningType

priority

name

fallbackName

description

avatarId

creationTime

creatorId

updateTime

updaterId

resubmissionTime

lastMessageTime

userAccountId

metaData

identityLinksInitialized

identityLinks

variablesInitialized

queryVariables

tags

Constructor Detail

ConversationEntityImpl

Method Detail

getExternalId

setExternalId

getTenantId

setTenantId

getParentId

setParentId

getReferenceId

setReferenceId

getReferenceType

setReferenceType

getReferenceDefinitionId

setReferenceDefinitionId

getConversationDefinitionId

setConversationDefinitionId

getState

setState

getType

setType

getSubType

setSubType

getPermissionType

setPermissionType

getJoiningType

setJoiningType

getPriority

setPriority

isPinned

isStarred

getName

setName

getFallbackName

setFallbackName

getDescription

setDescription

getAvatarId