Package com.flowable.engage.engine.impl.persistence.entity

Class ConversationEntityImpl

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 Description
    protected java.lang.String avatarId  
    protected java.lang.String conversationDefinitionId  
    protected java.util.Date creationTime  
    protected java.lang.String creatorId  
    protected java.lang.String description  
    protected java.lang.String externalId  
    protected java.lang.String fallbackName  
    protected java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks
    The identity links for the conversation.
    protected boolean identityLinksInitialized  
    protected java.lang.String joiningType  
    protected java.util.Date lastMessageTime  
    protected java.util.Map<java.lang.String,​java.lang.Object> metaData  
    protected java.lang.String name  
    protected java.lang.String parentId  
    protected java.lang.String permissionType  
    protected java.lang.Integer priority  
    protected java.util.List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> queryVariables  
    protected java.lang.String referenceDefinitionId  
    protected java.lang.String referenceId  
    protected java.lang.String referenceType  
    protected java.util.Date resubmissionTime  
    protected java.lang.String state  
    protected java.lang.String subType  
    protected java.util.List<java.lang.String> tags  
    protected java.lang.String tenantId  
    protected java.lang.String type  
    protected java.lang.String updaterId  
    protected java.util.Date updateTime  
    protected java.lang.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 Description
    ConversationEntityImpl()  

  • Method Summary

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

    • externalId

      protected java.lang.String externalId

    • tenantId

      protected java.lang.String tenantId

    • parentId

      protected java.lang.String parentId

    • referenceId

      protected java.lang.String referenceId

    • referenceType

      protected java.lang.String referenceType

    • referenceDefinitionId

      protected java.lang.String referenceDefinitionId

    • conversationDefinitionId

      protected java.lang.String conversationDefinitionId

    • state

      protected java.lang.String state

    • type

      protected java.lang.String type

    • subType

      protected java.lang.String subType

    • permissionType

      protected java.lang.String permissionType

    • joiningType

      protected java.lang.String joiningType

    • priority

      protected java.lang.Integer priority

    • name

      protected java.lang.String name

    • fallbackName

      protected java.lang.String fallbackName

    • description

      protected java.lang.String description

    • avatarId

      protected java.lang.String avatarId

    • creationTime

      protected java.util.Date creationTime

    • creatorId

      protected java.lang.String creatorId

    • updateTime

      protected java.util.Date updateTime

    • updaterId

      protected java.lang.String updaterId

    • resubmissionTime

      protected java.util.Date resubmissionTime

    • lastMessageTime

      protected java.util.Date lastMessageTime

    • userAccountId

      protected java.lang.String userAccountId

    • metaData

      protected java.util.Map<java.lang.String,​java.lang.Object> metaData

    • identityLinksInitialized

      protected boolean identityLinksInitialized

    • identityLinks

      protected java.util.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 java.util.List<org.flowable.variable.service.impl.persistence.entity.VariableInstanceEntity> queryVariables

    • tags

      protected java.util.List<java.lang.String> tags

  • Constructor Details

  • Method Details

    • getExternalId

      public java.lang.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​(java.lang.String externalId)
      Specified by:
      setExternalId in interface ConversationEntity

    • getTenantId

      public java.lang.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​(java.lang.String tenantId)
      Specified by:
      setTenantId in interface ConversationEntity

    • getParentId

      public java.lang.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​(java.lang.String parentId)
      Specified by:
      setParentId in interface ConversationEntity

    • getReferenceId

      public java.lang.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​(java.lang.String referenceId)
      Specified by:
      setReferenceId in interface ConversationEntity

    • getReferenceType

      public java.lang.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​(java.lang.String referenceType)
      Specified by:
      setReferenceType in interface ConversationEntity

    • getReferenceDefinitionId

      public java.lang.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​(java.lang.String referenceDefinitionId)
      Specified by:
      setReferenceDefinitionId in interface ConversationEntity

    • getConversationDefinitionId

      public java.lang.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​(java.lang.String conversationDefinitionId)
      Specified by:
      setConversationDefinitionId in interface ConversationEntity

    • getState

      public java.lang.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​(java.lang.String state)
      Specified by:
      setState in interface ConversationEntity

    • getType

      public java.lang.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​(java.lang.String type)
      Specified by:
      setType in interface ConversationEntity

    • getSubType

      public java.lang.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​(java.lang.String subType)
      Specified by:
      setSubType in interface ConversationEntity

    • getPermissionType

      public java.lang.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​(java.lang.String permissionType)
      Specified by:
      setPermissionType in interface ConversationEntity

    • getJoiningType

      public java.lang.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​(java.lang.String joiningType)
      Specified by:
      setJoiningType in interface ConversationEntity

    • getPriority

      public java.lang.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​(java.lang.Integer priority)
      Specified by:
      setPriority in interface ConversationEntity

    • isPinned

      public java.lang.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 java.lang.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 java.lang.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​(java.lang.String name)
      Specified by:
      setName in interface ConversationEntity

    • getFallbackName

      public java.lang.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​(java.lang.String fallbackName)
      Specified by:
      setFallbackName in interface ConversationEntity

    • getDescription

      public java.lang.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​(java.lang.String description)
      Specified by:
      setDescription in interface ConversationEntity

    • getAvatarId

      public java.lang.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​(java.lang.String avatarId)
      Specified by:
      setAvatarId in interface ConversationEntity

    • getCreationTime

      public java.util.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​(java.util.Date creationTime)
      Specified by:
      setCreationTime in interface ConversationEntity

    • getCreatorId

      public java.lang.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​(java.lang.String creatorId)
      Specified by:
      setCreatorId in interface ConversationEntity

    • getUpdateTime

      public java.util.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​(java.util.Date updateTime)
      Specified by:
      setUpdateTime in interface ConversationEntity

    • getUpdaterId

      public java.lang.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​(java.lang.String updaterId)
      Specified by:
      setUpdaterId in interface ConversationEntity

    • getResubmissionTime

      public java.util.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​(java.util.Date resubmissionTime)
      Specified by:
      setResubmissionTime in interface ConversationEntity

    • getLastMessageTime

      public java.util.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​(java.util.Date lastMessageTime)
      Specified by:
      setLastMessageTime in interface ConversationEntity

    • getUserAccountId

      public java.lang.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​(java.lang.String userAccountId)
      Specified by:
      setUserAccountId in interface ConversationEntity

    • getMetaData

      public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> metaData)
      Specified by:
      setMetaData in interface ConversationEntity

    • getIdentityLinks

      public java.util.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​(java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> identityLinks)
      Specified by:
      setIdentityLinks in interface ConversationEntity

    • getQueryIdentityLinks

      public java.util.List<org.flowable.identitylink.service.impl.persistence.entity.IdentityLinkEntity> getQueryIdentityLinks()
      Getter used by MyBatis when querying conversation with identity links.

    • setQueryIdentityLinks

      public void setQueryIdentityLinks​(java.util.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 java.lang.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 Conversation
      Specified by:
      getOwnerId in interface Permissions
      Returns:
      the id of the user being the owner of this conversation

    • getAssigneeId

      public java.lang.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 Conversation
      Specified by:
      getAssigneeId in interface Permissions
      Returns:
      the optional id of the user being the assignee of the conversation

    • getAssignedGroupId

      public java.lang.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 java.util.Set<java.lang.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 Conversation
      Specified by:
      getCandidateUserIds in interface Permissions
      Returns:
      the optional list of candidate user ids attached to this conversation

    • getCandidateGroupIds

      public java.util.Set<java.lang.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 Conversation
      Specified by:
      getCandidateGroupIds in interface Permissions
      Returns:
      the optional list of candidate group ids attached to this conversation

    • isVariablesInitialized

      public boolean isVariablesInitialized()
      Specified by:
      isVariablesInitialized in interface ConversationEntity

    • getConversationVariables

      public java.util.Map<java.lang.String,​java.lang.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 java.util.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​(java.util.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 java.util.List<java.lang.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​(java.util.List<java.lang.String> tags)
      Specified by:
      setTags in interface ConversationEntity

    • getPersistentState

      public java.lang.Object getPersistentState()
      Specified by:
      getPersistentState in interface org.flowable.common.engine.impl.persistence.entity.Entity