com.flowable.platform.service.bot

Class CmmnStartPlanItemInstanceBot

java.lang.Object

com.flowable.platform.service.bot.CmmnStartPlanItemInstanceBot

All Implemented Interfaces:

BotService

public class CmmnStartPlanItemInstanceBot
extends Object
implements BotService

A bot that handles actions originating from CMMN manual activates plan item instances. When the action instance is invoked, the bot will call CmmnRuntimeService.startPlanItemInstance(String).

Field Summary

Fields

Modifier and Type	Field and Description
protected org.flowable.cmmn.engine.CmmnEngineConfiguration	cmmnEngineConfiguration
protected org.flowable.cmmn.api.CmmnRepositoryService	cmmnRepositoryService
protected org.flowable.cmmn.api.CmmnRuntimeService	cmmnRuntimeService
protected org.flowable.form.api.FormRepositoryService	formRepositoryService
protected org.flowable.form.api.FormService	formService

Constructor Summary

Constructors

Constructor and Description
CmmnStartPlanItemInstanceBot(org.flowable.cmmn.api.CmmnRuntimeService cmmnRuntimeService, org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService, org.flowable.form.api.FormRepositoryService formRepositoryService, org.flowable.form.api.FormService formService, org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration)

Method Summary

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 ActionDefinitions 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.

Methods inherited from class java.lang.Object

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

Field Detail

cmmnRuntimeService

protected org.flowable.cmmn.api.CmmnRuntimeService cmmnRuntimeService

cmmnRepositoryService

protected org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService

formRepositoryService

protected org.flowable.form.api.FormRepositoryService formRepositoryService

formService

protected org.flowable.form.api.FormService formService

cmmnEngineConfiguration

protected org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration

Constructor Detail

CmmnStartPlanItemInstanceBot

public CmmnStartPlanItemInstanceBot(org.flowable.cmmn.api.CmmnRuntimeService cmmnRuntimeService,
                                    org.flowable.cmmn.api.CmmnRepositoryService cmmnRepositoryService,
                                    org.flowable.form.api.FormRepositoryService formRepositoryService,
                                    org.flowable.form.api.FormService formService,
                                    org.flowable.cmmn.engine.CmmnEngineConfiguration cmmnEngineConfiguration)

Method Detail

getKey

public String getKey()

Description copied from interface: BotService

Returns the key of this bot which is used to link ActionDefinitions to this bot.

Specified by:

getKey in interface BotService

Returns:

the key of this bot, which needs to be unique amongst other bots

getName

public String getName()

Description copied from interface: BotService

Returns the name of this bot, typically used as the label for it.

Specified by:

getName in interface BotService

Returns:

the name of this bot

getDescription

public String getDescription()

Description copied from interface: BotService

Returns the optional description of this bot, describing its capabilities or prerequisites.

Specified by:

getDescription in interface BotService

Returns:

the optional description of this bot

invokeBot

public BotActionResult invokeBot(HistoricActionInstance actionInstance,
                                 ActionDefinition actionDefinition,
                                 Map<String,Object> payload)

Description copied from interface: BotService

Whenever an action definition is triggered, an action instance is created and this method is invoked in order to execute the action. You need to provide an action result according the execution and follow up needed.

Specified by:

invokeBot in interface BotService

Parameters:

actionInstance - the action instance to run

actionDefinition - the action definition where the action instance is based on

payload - the optional payload containing the necessary information to run the action

Returns:

the result of invoking the action