All Superinterfaces:

Taggable

All Known Implementing Classes:

ConversationBuilderImpl
```
public interface ConversationBuilder
extends Taggable
```
A builder interface building Conversation objects. An instance might be received through ConversationService.createConversationBuilder().

Author:

Micha Kiener, Filip Hrisafov

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`ConversationBuilder`	`addCandidateGroup(String candidateGroup)`
`ConversationBuilder`	`addParticipant(String participant)`
`ConversationBuilder`	`addTag(String tag)`
`ConversationBuilder`	`assignedGroupId(String assignedGroupId)`
`ConversationBuilder`	`assigneeId(String assigneeId)`
`ConversationBuilder`	`avatarId(String avatarId)`	Optionally set the avatar information for this conversation.
`ConversationBuilder`	`candidateGroups(Set<String> candidateGroups)`
`ConversationBuilder`	`conversationDefinitionId(String conversationDefinitionId)`	Set the id of the conversation definition.
`ConversationBuilder`	`conversationDefinitionKey(String conversationDefinitionKey)`	Set the key of the conversation definition.
`ConversationBuilder`	`description(String description)`	Set the optional description describing the reason or goal of the conversation in more details than the name.
`ConversationBuilder`	`externalId(String externalId)`	Set the external id of the conversation.
`ConversationBuilder`	`fallbackName(String fallbackName)`	Set the optional fallback name to be used, if there is no explicit name being set (e.g.
`String`	`getAssignedGroupId()`
`String`	`getAssigneeId()`
`String`	`getAvatarId()`
`Set<String>`	`getCandidateGroups()`
`String`	`getConversationDefinitionId()`
`String`	`getConversationDefinitionKey()`	Returns the key that will be used to do the conversation definition lookup when creating the conversation.
`String`	`getDescription()`
`String`	`getExternalId()`
`String`	`getFallbackName()`	Optional name to display when there's no title.
`String`	`getJoiningType()`
`String`	`getName()`
`String`	`getOwnerId()`
`String`	`getParentId()`
`Set<String>`	`getParticipants()`
`String`	`getPermissionType()`
`String`	`getReferenceDefinitionId()`
`String`	`getReferenceId()`
`String`	`getReferenceType()`
`String`	`getSubType()`
`String`	`getTenantId()`
`String`	`getType()`
`ConversationBuilder`	`joiningType(String joiningType)`	Set the joining type used for this conversation.
`ConversationBuilder`	`name(String name)`	Set the optional name for this conversation.
`ConversationBuilder`	`ownerId(String ownerId)`
`ConversationBuilder`	`parentId(String parentId)`	Set the id of the parent conversation, if this is a child conversation (e.g.
`ConversationBuilder`	`participants(Set<String> participants)`
`ConversationBuilder`	`permissionType(String permissionType)`	Set the permission type to be used for this conversation.
`ConversationBuilder`	`referenceDefinitionId(String referenceDefinitionId)`	Set the reference definition id of the conversation pointing to for example a case or process definition id.
`ConversationBuilder`	`referenceId(String referenceId)`	Set the reference id of the conversation pointing to for example a case or process instance id.
`ConversationBuilder`	`referenceType(String referenceType)`	Set the reference type of the conversation pointing to for example a case or process instance type.
`Conversation`	`start()`	Returns the newly created conversation object.
`Conversation`	`startWithPermissionCheck(String userId)`	Deprecated. use `startWithPermissionCheck(String, Collection, String)` instead
`Conversation`	`startWithPermissionCheck(String userId, Collection<String> userGroupKeys, String userTenantId)`	Same as `start()` with an additional permission check that the user with `userId` is allowed to create the conversation.
`ConversationHolder`	`startWithReuse()`	Tries to find a similar conversation, if found it would return that one.
`ConversationHolder`	`startWithReuseAndPermissionCheck(String userId)`	Deprecated. use `startWithPermissionCheck(String, Collection, String)` instead
`ConversationHolder`	`startWithReuseAndPermissionCheck(String userId, Collection<String> userGroupKeys, String userTenantId)`	Same as `startWithReuse()` with an additional permission check that the user with `userId` is allowed to create the conversation.
`ConversationBuilder`	`subType(String type)`	Set the sub type of this conversation.
`ConversationBuilder`	`tags(Collection<String> tags)`
`ConversationBuilder`	`tenantId(String tenantId)`	Optionally sets the tenantId for this conversation.
`ConversationBuilder`	`type(String type)`	Set the type for this conversation which has an impact on how participants might be joined, on permissions or other behaviors of the conversation.

Methods inherited from interface com.flowable.engage.commons.api.Taggable
getTags

- Method Detail
  - getExternalId
```
String getExternalId()
```
    See Also:
    
    Conversation.getExternalId()
  - externalId
```
ConversationBuilder externalId(String externalId)
```
    Set the external id of the conversation.
    
    Parameters:
    
    externalId - the external id for the conversation
  - getParentId
```
String getParentId()
```
    See Also:
    
    Conversation.getParentId()
  - parentId
```
ConversationBuilder parentId(String parentId)
```
    Set the id of the parent conversation, if this is a child conversation (e.g. a topic, ticket or something similar).
    
    Parameters:
    
    parentId - the id of the parent conversation
    
    Returns:
    
    conversation builder for method chaining
  - getConversationDefinitionId
```
String getConversationDefinitionId()
```
    See Also:
    
    Conversation.getConversationDefinitionId()
  - conversationDefinitionId
```
ConversationBuilder conversationDefinitionId(String conversationDefinitionId)
```
    Set the id of the conversation definition.
    
    Parameters:
    
    conversationDefinitionId - the id of the conversation definition
    
    Returns:
    
    conversation builder for method chaining
  - conversationDefinitionKey
```
ConversationBuilder conversationDefinitionKey(String conversationDefinitionKey)
```
    Set the key of the conversation definition.
    
    Parameters:
    
    conversationDefinitionKey - The key that will be used to find the latest version of the conversation definition.
    
    Returns:
    
    conversation builder for method chaining
  - getConversationDefinitionKey
```
String getConversationDefinitionKey()
```
    Returns the key that will be used to do the conversation definition lookup when creating the conversation.
  - subType
```
ConversationBuilder subType(String type)
```
    Set the sub type of this conversation.
    
    Parameters:
    
    type - the sub type of the conversation
    
    Returns:
    
    conversation builder for method chaining
  - getSubType
```
String getSubType()
```
    See Also:
    
    Conversation.getSubType()
  - type
```
ConversationBuilder type(String type)
```
    Set the type for this conversation which has an impact on how participants might be joined, on permissions or other behaviors of the conversation. Setting the type of the builder will lead to evaluate the joiningType(String) and permissionType(String) of it as well. The type is a mandatory field and must be set explicitly using this method. As the joining and permission types are evaluated according the type within this method, make sure to explicitly set them (if necessary) AFTER setting the sub type, otherwise they will be overwritten with defaults.
    
    Parameters:
    
    type - the sub type to set for this conversation
    
    Returns:
    
    conversation builder for method chaining
    
    See Also:
    
    Conversation.getType(), ConversationTypes
  - getType
```
String getType()
```
    See Also:
    
    Conversation.getType()
  - getPermissionType
```
String getPermissionType()
```
    See Also:
    
    Conversation.getPermissionType()
  - permissionType
```
ConversationBuilder permissionType(String permissionType)
```
    Set the permission type to be used for this conversation. If not set, it will be evaluated according type and sub type automatically. As the permission type is initialized automatically when setting the type(String), make sure to set it explicitly using this method AFTER the type is set!
    
    Parameters:
    
    permissionType - the permission type to be set for the conversation
    
    Returns:
    
    conversation builder for method chaining
    
    See Also:
    
    Conversation.getPermissionType(), PermissionTypes
  - getJoiningType
```
String getJoiningType()
```
    See Also:
    
    Conversation.getJoiningType()
  - joiningType
```
ConversationBuilder joiningType(String joiningType)
```
    Set the joining type used for this conversation. If not set, it will be evaluated according type and sub type automatically. As the joining type is initialized automatically when setting the type(String), make sure to set it explicitly using this method AFTER the type is set!
    
    Parameters:
    
    joiningType - the joining type to be set for this conversation
    
    Returns:
    
    conversation builder for method chaining
    
    See Also:
    
    Conversation.getJoiningType(), JoiningTypes
  - getName
```
String getName()
```
    See Also:
    
    Conversation.getName()
  - name
```
ConversationBuilder name(String name)
```
    Set the optional name for this conversation. Some sub types need the name (e.g. a desk or channel, etc), in this case the name is mandatory.
    
    Parameters:
    
    name - the name for the created conversation
    
    Returns:
    
    conversation builder for method chaining
  - getFallbackName
```
String getFallbackName()
```
    Optional name to display when there's no title. By default, this will be the participant names separated by comas.
    
    Returns:
    
    Optional conversation title
  - fallbackName
```
ConversationBuilder fallbackName(String fallbackName)
```
    Set the optional fallback name to be used, if there is no explicit name being set (e.g. the name of the participants).
    
    Parameters:
    
    fallbackName - the optional fallback name for the conversation
    
    Returns:
    
    conversation builder for method chaining
    
    See Also:
    
    Conversation.getFallbackName()
  - getDescription
```
String getDescription()
```
    See Also:
    
    Conversation.getDescription()
  - description
```
ConversationBuilder description(String description)
```
    Set the optional description describing the reason or goal of the conversation in more details than the name.
    
    Parameters:
    
    description - the description for the conversation
    
    Returns:
    
    conversation builder for method chaining
  - referenceId
```
ConversationBuilder referenceId(String referenceId)
```
    Set the reference id of the conversation pointing to for example a case or process instance id.
    
    Parameters:
    
    referenceId - The reference id pointing to for example a case or process instance id.
    
    Returns:
    
    conversation builder for method chaining
  - getReferenceId
```
String getReferenceId()
```
  - referenceType
```
ConversationBuilder referenceType(String referenceType)
```
    Set the reference type of the conversation pointing to for example a case or process instance type.
    
    Parameters:
    
    referenceType - The reference id pointing to for example a case or process instance type.
    
    Returns:
    
    conversation builder for method chaining
  - getReferenceType
```
String getReferenceType()
```
  - referenceDefinitionId
```
ConversationBuilder referenceDefinitionId(String referenceDefinitionId)
```
    Set the reference definition id of the conversation pointing to for example a case or process definition id.
    
    Parameters:
    
    referenceDefinitionId - The reference definition id pointing to for example a case or process definition id.
    
    Returns:
    
    conversation builder for method chaining
  - getReferenceDefinitionId
```
String getReferenceDefinitionId()
```
  - getAvatarId
```
String getAvatarId()
```
    See Also:
    
    Conversation.getAvatarId()
  - avatarId
```
ConversationBuilder avatarId(String avatarId)
```
    Optionally set the avatar information for this conversation.
    
    Parameters:
    
    avatarId - the optional information for the avatar of this conversation
    
    Returns:
    
    conversation builder for method chaining
  - getOwnerId
```
String getOwnerId()
```
  - ownerId
```
ConversationBuilder ownerId(String ownerId)
```
  - getAssigneeId
```
String getAssigneeId()
```
  - assigneeId
```
ConversationBuilder assigneeId(String assigneeId)
```
  - getAssignedGroupId
```
String getAssignedGroupId()
```
  - assignedGroupId
```
ConversationBuilder assignedGroupId(String assignedGroupId)
```
  - getParticipants
```
Set<String> getParticipants()
```
  - participants
```
ConversationBuilder participants(Set<String> participants)
```
  - addParticipant
```
ConversationBuilder addParticipant(String participant)
```
  - getCandidateGroups
```
Set<String> getCandidateGroups()
```
  - candidateGroups
```
ConversationBuilder candidateGroups(Set<String> candidateGroups)
```
  - addCandidateGroup
```
ConversationBuilder addCandidateGroup(String candidateGroup)
```
  - tags
```
ConversationBuilder tags(Collection<String> tags)
```
  - addTag
```
ConversationBuilder addTag(String tag)
```
  - tenantId
```
ConversationBuilder tenantId(String tenantId)
```
    Optionally sets the tenantId for this conversation. If missing, it will take the tenantId of the current user.
    
    Returns:
    
    conversation builder for method chaining
  - getTenantId
```
String getTenantId()
```
    Returns:
    
    The tenantId, if set before on this builder.
  - start
```
Conversation start()
```
    Returns the newly created conversation object. This actually performs the persistence of the conversation.
    
    Returns:
    
    the newly built conversation object
  - startWithPermissionCheck
```
@Deprecated
Conversation startWithPermissionCheck(String userId)
```
    Deprecated.
    use startWithPermissionCheck(String, Collection, String) instead
    
    Same as start() with an additional permission check that the user with userId is allowed to create the conversation.
    
    Parameters:
    
    userId - the id of the user that is creating the conversation
    
    Returns:
    
    the newly created conversation
    
    Throws:
    
    FlowableForbiddenException - if the user with userId does not have rights to create the conversation
    
    See Also:
    
    start()
  - startWithPermissionCheck
```
Conversation startWithPermissionCheck(String userId,
                                      Collection<String> userGroupKeys,
                                      String userTenantId)
```
    Same as start() with an additional permission check that the user with userId is allowed to create the conversation.
    
    Parameters:
    
    userId - the id of the user that is creating the conversation
    
    userGroupKeys - the group keys of the user that is creating the conversation
    
    userTenantId - the tenant id of the user that is creating the conversation
    
    Returns:
    
    the newly created conversation
    
    Throws:
    
    FlowableForbiddenException - if the user with userId does not have rights to create the conversation
    
    See Also:
    
    start()
  - startWithReuse
```
ConversationHolder startWithReuse()
```
    Tries to find a similar conversation, if found it would return that one. Otherwise it will create a new conversation and persist it.
    
    Returns:
    
    the already existing similar conversation, or the newly built conversation
  - startWithReuseAndPermissionCheck
```
@Deprecated
ConversationHolder startWithReuseAndPermissionCheck(String userId)
```
    Deprecated.
    use startWithPermissionCheck(String, Collection, String) instead
    
    Same as startWithReuse() with an additional permission check that the user with userId is allowed to create the conversation.
    
    Parameters:
    
    userId - the id of the user that is creating the conversation
    
    Returns:
    
    the already existing similar conversation, or the newly build conversation
    
    Throws:
    
    FlowableForbiddenException - if the user with userId does not have rights to create the conversation
  - startWithReuseAndPermissionCheck
```
ConversationHolder startWithReuseAndPermissionCheck(String userId,
                                                    Collection<String> userGroupKeys,
                                                    String userTenantId)
```
    Same as startWithReuse() with an additional permission check that the user with userId is allowed to create the conversation.
    
    Parameters:
    
    userId - the id of the user that is creating the conversation
    
    userGroupKeys - the group keys of the user that is creating the conversation
    
    userTenantId - the tenant id of the user that is creating the conversation
    
    Returns:
    
    the already existing similar conversation, or the newly build conversation
    
    Throws:
    
    FlowableForbiddenException - if the user with userId does not have rights to create the conversation

Interface ConversationBuilder

Method Summary

Methods inherited from interface com.flowable.engage.commons.api.Taggable

Method Detail

getExternalId

externalId

getParentId

parentId

getConversationDefinitionId

conversationDefinitionId

conversationDefinitionKey

getConversationDefinitionKey

subType

getSubType

type

getType

getPermissionType

permissionType

getJoiningType

joiningType

getName

name

getFallbackName

fallbackName

getDescription

description

referenceId

getReferenceId

referenceType

getReferenceType

referenceDefinitionId

getReferenceDefinitionId

getAvatarId

avatarId

getOwnerId

ownerId

getAssigneeId

assigneeId

getAssignedGroupId

assignedGroupId

getParticipants

participants

addParticipant

getCandidateGroups

candidateGroups

addCandidateGroup

tags

addTag

tenantId

getTenantId

start

startWithPermissionCheck

startWithPermissionCheck

startWithReuse

startWithReuseAndPermissionCheck

startWithReuseAndPermissionCheck