public class CmmnUserEventListenerBot extends Object implements BotService
CmmnRuntimeService.completeUserEventListenerInstance(String)
thus continuing the case instance.Modifier and Type | Field and Description |
---|---|
protected org.flowable.cmmn.engine.CmmnEngineConfiguration |
cmmnEngineConfiguration |
protected com.flowable.form.engine.FormEngineConfiguration |
formEngineConfiguration |
Constructor and Description |
---|
CmmnUserEventListenerBot(org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration,
com.flowable.form.engine.FormEngineConfiguration formEngineConfiguration) |
Modifier and Type | Method and Description |
---|---|
String |
getDescription()
Returns the optional description of this bot, describing its capabilities or prerequisites.
|
String |
getKey()
Returns the key of this bot which is used to link
ActionDefinition s to this bot. |
String |
getName()
Returns the name of this bot, typically used as the label for it.
|
BotActionResult |
invokeBot(HistoricActionInstance actionInstance,
ActionDefinition actionDefinition,
Map<String,Object> payload)
Whenever an action definition is triggered, an action instance is created and this method is invoked in order to execute the action.
|
protected Map<String,Object> |
validateAndParseFormVariables(org.flowable.cmmn.api.CmmnRuntimeService cmmnRuntimeService,
String planItemInstanceId,
Map<String,Object> payload) |
protected org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration
protected com.flowable.form.engine.FormEngineConfiguration formEngineConfiguration
public CmmnUserEventListenerBot(org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration, com.flowable.form.engine.FormEngineConfiguration formEngineConfiguration)
public String getKey()
BotService
ActionDefinition
s to this bot.getKey
in interface BotService
public String getName()
BotService
getName
in interface BotService
public String getDescription()
BotService
getDescription
in interface BotService
public BotActionResult invokeBot(HistoricActionInstance actionInstance, ActionDefinition actionDefinition, Map<String,Object> payload)
BotService
invokeBot
in interface BotService
actionInstance
- the action instance to runactionDefinition
- the action definition where the action instance is based onpayload
- the optional payload containing the necessary information to run the actionCopyright © 2019. All rights reserved.