Package com.flowable.platform.service.bot

Class BpmnStartProcessInstanceBot

  • All Implemented Interfaces:
    BotService
    public class BpmnStartProcessInstanceBot
extends java.lang.Object
implements BotService
    Author:
    Filip Hrisafov

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.fasterxml.jackson.databind.ObjectMapper objectMapper  
      protected org.flowable.engine.RuntimeService runtimeService  

    • Constructor Summary

      Constructors 
      Constructor Description
      BpmnStartProcessInstanceBot​(org.flowable.engine.RuntimeService runtimeService, com.fasterxml.jackson.databind.ObjectMapper objectMapper)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Returns the optional description of this bot, describing its capabilities or prerequisites.
      java.lang.String getKey()
      Returns the key of this bot which is used to link ActionDefinitions to this bot.
      java.lang.String getName()
      Returns the name of this bot, typically used as the label for it.
      BotActionResult invokeBot​(HistoricActionInstance actionInstance, ActionDefinition actionDefinition, java.util.Map<java.lang.String,​java.lang.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

      • runtimeService

        protected org.flowable.engine.RuntimeService runtimeService

      • objectMapper

        protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

    • Constructor Detail

      • BpmnStartProcessInstanceBot

        public BpmnStartProcessInstanceBot​(org.flowable.engine.RuntimeService runtimeService,
                                   com.fasterxml.jackson.databind.ObjectMapper objectMapper)

    • Method Detail

      • getKey

        public java.lang.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 java.lang.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 java.lang.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,
                                 java.util.Map<java.lang.String,​java.lang.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