Package com.flowable.platform.service.bot

Class AbstractStartWorkInstanceBot

java.lang.Object

com.flowable.platform.service.bot.AbstractStartWorkInstanceBot

All Implemented Interfaces:

BotService, ContextAwareBotService

Direct Known Subclasses:

BpmnStartProcessInstanceBot, CmmnStartCaseInstanceBot

public abstract class AbstractStartWorkInstanceBot
extends Object
implements ContextAwareBotService

An abstract bot implementation to start a process or case instance and supporting some functions around it.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_CONFIG_MODEL_CONFIG_INCLUDE_VARIABLES_IN_RESPONSE
static final String	ACTION_DEFINITION_ID_VAR_NAME
static final String	ACTION_INSTANCE_ID_VAR_NAME
static final String	ACTION_SCOPE_ID_VAR_NAME
static final String	ACTION_SCOPE_TYPE_VAR_NAME
protected final PlatformContentItemService	contentItemService
protected final CoreContentService	contentService
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected final PlatformRestVariableTransformer	variableTransformer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractStartWorkInstanceBot(com.fasterxml.jackson.databind.ObjectMapper objectMapper, ObjectProvider<PlatformContentItemService> contentItemServiceProvider, PlatformRestVariableTransformer variableTransformer, ObjectProvider<CoreContentService> contentServiceProvider)

Method Summary

Modifier and Type	Method	Description
protected BotActionResult	createActionResult(String newInstanceId)
protected BotActionResult	createActionResult(String newInstanceId, Intent intent)
protected Map<String,Object>	createTransientVariables(HistoricActionInstance actionInstance, ActionDefinition actionDefinition)
protected String	getAndRemoveOutcomeFromPayload(Map<String,Object> payload)
protected String	getWorkDefinitionKey(ActionDefinition actionDefinition)
protected void	transformVariables(Map<String,Object> variables)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.flowable.action.api.bot.BotService

getDescription, getKey, getName

Methods inherited from interface com.flowable.action.api.bot.ContextAwareBotService

invokeBot, invokeBot

Field Details

ACTION_CONFIG_MODEL_CONFIG_INCLUDE_VARIABLES_IN_RESPONSE

public static final String ACTION_CONFIG_MODEL_CONFIG_INCLUDE_VARIABLES_IN_RESPONSE

See Also:

• Constant Field Values

ACTION_INSTANCE_ID_VAR_NAME

public static final String ACTION_INSTANCE_ID_VAR_NAME

See Also:

• Constant Field Values

ACTION_DEFINITION_ID_VAR_NAME

public static final String ACTION_DEFINITION_ID_VAR_NAME

See Also:

• Constant Field Values

ACTION_SCOPE_ID_VAR_NAME

public static final String ACTION_SCOPE_ID_VAR_NAME

See Also:

• Constant Field Values

ACTION_SCOPE_TYPE_VAR_NAME

public static final String ACTION_SCOPE_TYPE_VAR_NAME

See Also:

• Constant Field Values

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

contentItemService

protected final PlatformContentItemService contentItemService

variableTransformer

protected final PlatformRestVariableTransformer variableTransformer

contentService

protected final CoreContentService contentService

Constructor Details

AbstractStartWorkInstanceBot

protected AbstractStartWorkInstanceBot(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 ObjectProvider<PlatformContentItemService> contentItemServiceProvider,
 PlatformRestVariableTransformer variableTransformer,
 ObjectProvider<CoreContentService> contentServiceProvider)

Method Details

getWorkDefinitionKey

protected String getWorkDefinitionKey(ActionDefinition actionDefinition)

getAndRemoveOutcomeFromPayload

protected String getAndRemoveOutcomeFromPayload(Map<String,Object> payload)

createTransientVariables

protected Map<String,Object> createTransientVariables(HistoricActionInstance actionInstance,
 ActionDefinition actionDefinition)

createActionResult

protected BotActionResult createActionResult(String newInstanceId)

createActionResult

protected BotActionResult createActionResult(String newInstanceId,
 Intent intent)

transformVariables

protected void transformVariables(Map<String,Object> variables)