Interface FlowLongEngine

  • All Known Implementing Classes:
    FlowLongEngineImpl

    public interface FlowLongEngine
    FlowLong流程引擎接口

    官网尊重知识产权,不允许非法使用,后果自负

    Since:
    1.0
    Author:
    hubin
    • Method Detail

      • configure

        FlowLongEngine configure​(FlowLongContext config)
        根据Configuration对象配置实现类
        Parameters:
        config - 全局配置对象
        Returns:
        FlowLongEngine 流程引擎
      • processService

        default ProcessService processService()
        获取process服务
        Returns:
        ProcessService 流程定义服务
      • queryService

        default QueryService queryService()
        获取查询服务
        Returns:
        QueryService 常用查询服务
      • runtimeService

        default RuntimeService runtimeService()
        获取实例服务
        Returns:
        RuntimeService 流程实例运行业务服务
      • taskService

        default TaskService taskService()
        获取任务服务
        Returns:
        TaskService 任务服务
      • startInstanceById

        java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                          FlowCreator flowCreator,
                                                          java.util.Map<java.lang.String,​java.lang.Object> args,
                                                          boolean saveAsDraft,
                                                          java.util.function.Supplier<FlwInstance> supplier)
        根据流程定义ID,创建人ID,参数列表启动流程实例
        Parameters:
        id - 流程定义ID
        flowCreator - 流程实例任务创建者
        args - 参数列表
        saveAsDraft - 暂存草稿
        supplier - 初始化流程实例提供者
        Returns:
        FlwInstance 流程实例
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator,
                                                                  java.util.Map<java.lang.String,​java.lang.Object> args,
                                                                  boolean saveAsDraft)
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator,
                                                                  java.util.Map<java.lang.String,​java.lang.Object> args)
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator,
                                                                  java.lang.String businessKey,
                                                                  boolean saveAsDraft)
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator,
                                                                  java.lang.String businessKey)
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator,
                                                                  boolean saveAsDraft)
      • startInstanceById

        default java.util.Optional<FlwInstance> startInstanceById​(java.lang.Long id,
                                                                  FlowCreator flowCreator)
      • startInstanceByProcessKey

        java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                  java.lang.Integer version,
                                                                  FlowCreator flowCreator,
                                                                  java.util.Map<java.lang.String,​java.lang.Object> args,
                                                                  boolean saveAsDraft,
                                                                  java.util.function.Supplier<FlwInstance> supplier)
        根据流程名称、版本号、创建人、参数列表启动流程实例
        Parameters:
        processKey - 流程定义key
        version - 版本号
        flowCreator - 流程实例任务创建者
        args - 参数列表
        saveAsDraft - 暂存草稿
        supplier - 初始化流程实例提供者
        Returns:
        FlwInstance 流程实例
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator,
                                                                          java.util.Map<java.lang.String,​java.lang.Object> args,
                                                                          boolean saveAsDraft)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator,
                                                                          java.util.Map<java.lang.String,​java.lang.Object> args)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator,
                                                                          java.lang.String businessKey,
                                                                          boolean saveAsDraft)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator,
                                                                          java.lang.String businessKey)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator,
                                                                          boolean saveAsDraft)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          java.lang.Integer version,
                                                                          FlowCreator flowCreator)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          FlowCreator flowCreator,
                                                                          boolean saveAsDraft)
      • startInstanceByProcessKey

        default java.util.Optional<FlwInstance> startInstanceByProcessKey​(java.lang.String processKey,
                                                                          FlowCreator flowCreator)
      • startProcessInstance

        java.util.Optional<FlwInstance> startProcessInstance​(FlwProcess process,
                                                             FlowCreator flowCreator,
                                                             java.util.Map<java.lang.String,​java.lang.Object> args,
                                                             boolean saveAsDraft,
                                                             java.util.function.Supplier<FlwInstance> supplier)
        根据流程对象启动流程实例
        Parameters:
        process - FlwProcess
        flowCreator - 流程实例任务创建者
        args - 参数列表
        saveAsDraft - 暂存草稿
        supplier - 初始化流程实例提供者
        Returns:
        FlwInstance 流程实例
      • restartProcessInstance

        void restartProcessInstance​(java.lang.Long id,
                                    java.lang.String currentNode,
                                    Execution execution)
        重启流程实例(从当前所在节点currentNode位置开始)
        Parameters:
        id - 流程定义ID
        currentNode - 当前所在节点
        execution - Execution
      • executeTask

        boolean executeTask​(java.lang.Long taskId,
                            FlowCreator flowCreator,
                            java.util.Map<java.lang.String,​java.lang.Object> args)
        根据任务ID,创建人信息,参数列表执行任务
        Parameters:
        taskId - 任务ID
        flowCreator - 任务创建者
        args - 参数列表
        Returns:
        true 成功 false 失败
      • executeTask

        default boolean executeTask​(java.lang.Long taskId,
                                    FlowCreator flowCreator)
      • executeFinishTrigger

        boolean executeFinishTrigger​(java.lang.Long taskId,
                                     FlowCreator flowCreator,
                                     java.util.Map<java.lang.String,​java.lang.Object> args)
        根据 触发器任务ID,创建人信息,参数列表执行完成触发器任务
        Parameters:
        taskId - 任务ID
        flowCreator - 任务创建者
        args - 全局参数列表
        Returns:
        true 成功 false 失败
      • executeFinishTrigger

        default boolean executeFinishTrigger​(java.lang.Long taskId,
                                             FlowCreator flowCreator)
      • autoJumpTask

        boolean autoJumpTask​(java.lang.Long taskId,
                             java.util.Map<java.lang.String,​java.lang.Object> args,
                             FlowCreator flowCreator)
        自动跳转任务
        Parameters:
        taskId - 任务ID
        args - 任务参数
        flowCreator - 任务创建者
        Returns:
        true 成功 false 失败
      • autoJumpTask

        default boolean autoJumpTask​(java.lang.Long taskId,
                                     FlowCreator flowCreator)
      • autoCompleteTask

        boolean autoCompleteTask​(java.lang.Long taskId,
                                 java.util.Map<java.lang.String,​java.lang.Object> args,
                                 FlowCreator flowCreator)
        自动完成任务
        Parameters:
        taskId - 任务ID
        args - 任务参数
        flowCreator - 任务创建者
        Returns:
        true 成功 false 失败
      • autoCompleteTask

        default boolean autoCompleteTask​(java.lang.Long taskId,
                                         FlowCreator flowCreator)
      • autoCompleteTask

        default boolean autoCompleteTask​(java.lang.Long taskId)
      • autoRejectTask

        boolean autoRejectTask​(FlwTask flwTask,
                               java.util.Map<java.lang.String,​java.lang.Object> args,
                               FlowCreator flowCreator)
        自动拒绝任务
        Parameters:
        flwTask - 任务对象
        args - 任务参数
        flowCreator - 任务创建者
        Returns:
        true 成功 false 失败
      • autoRejectTask

        default boolean autoRejectTask​(FlwTask flwTask,
                                       FlowCreator flowCreator)
      • autoRejectTask

        default boolean autoRejectTask​(FlwTask flwTask)
      • executeJumpTask

        default boolean executeJumpTask​(java.lang.Long taskId,
                                        java.lang.String nodeKey,
                                        FlowCreator flowCreator,
                                        java.util.Map<java.lang.String,​java.lang.Object> args)
        根据任务ID,创建人ID,参数列表执行任务,并且根据nodeName跳转到任意节点

        1、nodeName为null时,则跳转至上一步处理 2、nodeName不为null时,则任意跳转,即动态创建转移

        Parameters:
        taskId - 任务ID
        nodeKey - 跳转的节点key
        flowCreator - 任务创建者
        args - 任务参数
        Returns:
        true 成功 false 失败
      • executeJumpTask

        default boolean executeJumpTask​(java.lang.Long taskId,
                                        java.lang.String nodeKey,
                                        FlowCreator flowCreator)
      • executeJumpTask

        java.util.Optional<java.util.List<FlwTask>> executeJumpTask​(java.lang.Long taskId,
                                                                    java.lang.String nodeKey,
                                                                    FlowCreator flowCreator,
                                                                    java.util.Map<java.lang.String,​java.lang.Object> args,
                                                                    TaskType taskTye)
      • executeRejectTask

        java.util.Optional<java.util.List<FlwTask>> executeRejectTask​(FlwTask currentFlwTask,
                                                                      java.lang.String nodeKey,
                                                                      FlowCreator flowCreator,
                                                                      java.util.Map<java.lang.String,​java.lang.Object> args,
                                                                      boolean termination)
        根据当前任务对象驳回至指定 nodeKey 节点,如果 nodeKey 为空默认为上一步处理
        Parameters:
        currentFlwTask - 当前任务对象
        nodeKey - 跳转的节点key
        flowCreator - 任务创建者
        args - 任务参数
        termination - 是否终止流程,该参数为 true 时,其它驳回策略无效
        Returns:
        Task 任务对象
      • executeRejectTask

        default java.util.Optional<java.util.List<FlwTask>> executeRejectTask​(FlwTask currentFlwTask,
                                                                              java.lang.String nodeKey,
                                                                              FlowCreator flowCreator,
                                                                              java.util.Map<java.lang.String,​java.lang.Object> args)
      • executeRejectTask

        default java.util.Optional<java.util.List<FlwTask>> executeRejectTask​(FlwTask currentFlwTask,
                                                                              java.lang.String nodeKey,
                                                                              FlowCreator flowCreator)
      • executeRejectTask

        default java.util.Optional<java.util.List<FlwTask>> executeRejectTask​(FlwTask currentFlwTask,
                                                                              FlowCreator flowCreator,
                                                                              java.util.Map<java.lang.String,​java.lang.Object> args)
      • executeRejectTask

        default java.util.Optional<java.util.List<FlwTask>> executeRejectTask​(FlwTask currentFlwTask,
                                                                              FlowCreator flowCreator)
      • createNewTask

        java.util.List<FlwTask> createNewTask​(java.lang.Long taskId,
                                              TaskType taskType,
                                              PerformType performType,
                                              java.util.List<FlwTaskActor> taskActors,
                                              FlowCreator flowCreator,
                                              java.util.Map<java.lang.String,​java.lang.Object> args)
        根据已有任务、参与者创建新的任务

        适用于动态转派,动态协办等处理且流程图中不体现节点情况

        Parameters:
        taskId - 主办任务ID
        taskActors - 参与者集合
        taskType - 任务类型
        performType - 参与类型
        flowCreator - 任务创建者
        args - 任务参数
        Returns:
        创建任务集合
      • createCcTask

        boolean createCcTask​(NodeModel taskModel,
                             FlwTask flwTask,
                             java.util.List<NodeAssignee> ccUserList,
                             FlowCreator flowCreator)
        创建抄送任务

        默认不校验是否重复抄送

        Parameters:
        taskModel - 任务模型
        flwTask - 当前任务
        ccUserList - 抄送任务分配到任务的人或角色列表
        flowCreator - 任务创建者
      • createCcTask

        default boolean createCcTask​(FlwTask flwTask,
                                     java.util.List<NodeAssignee> ccUserList,
                                     FlowCreator flowCreator)
        创建抄送任务
      • executeAppendNodeModel

        boolean executeAppendNodeModel​(java.lang.Long taskId,
                                       NodeModel nodeModel,
                                       FlowCreator flowCreator,
                                       java.util.Map<java.lang.String,​java.lang.Object> args,
                                       boolean beforeAfter)
        执行追加节点模型
        Parameters:
        taskId - 当前任务ID
        nodeModel - 加签节点模型
        flowCreator - 任务创建者
        args - 任务参数
        beforeAfter - true 前置 false 后置
        Returns:
        true 成功 false 失败
      • executeAppendNodeModel

        default boolean executeAppendNodeModel​(java.lang.Long taskId,
                                               NodeModel nodeModel,
                                               FlowCreator flowCreator,
                                               boolean beforeAfter)
        执行追加节点模型