Interface RuntimeService

  • All Known Implementing Classes:
    RuntimeServiceImpl

    public interface RuntimeService
    流程实例运行业务类

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

    Since:
    1.0
    Author:
    hubin
    • Method Detail

      • createInstance

        FlwInstance createInstance​(FlwProcess flwProcess,
                                   FlowCreator flowCreator,
                                   java.util.Map<java.lang.String,​java.lang.Object> args,
                                   NodeModel nodeModel,
                                   boolean saveAsDraft,
                                   java.util.function.Supplier<FlwInstance> supplier)
        根据流程、创建人员、父流程实例ID创建流程实例
        Parameters:
        flwProcess - 流程定义对象
        flowCreator - 流程实例任务创建者
        args - 参数列表
        nodeModel - 当前所在节点
        saveAsDraft - 暂存草稿
        supplier - 初始化流程实例提供者
        Returns:
        活动流程实例对象
      • getProcessModelByInstanceId

        ProcessModel getProcessModelByInstanceId​(java.lang.Long instanceId)
        根据流程实例ID获取流程实例模型
        Parameters:
        instanceId - 流程实例ID
        Returns:
        ProcessModel
      • getNodeModel

        default NodeModel getNodeModel​(java.lang.Long instanceId,
                                       java.lang.String nodeKey)
        通过流程实例ID节点KEY获取节点模型
        Parameters:
        instanceId - 流程实例ID
        nodeKey - 节点KEY
      • addVariable

        boolean addVariable​(java.lang.Long instanceId,
                            java.util.Map<java.lang.String,​java.lang.Object> args,
                            java.util.function.Function<FlwInstance,​FlwInstance> function)
        根据 流程实例ID 更新流程实例全局变量
        Parameters:
        instanceId - 流程实例ID
        args - 流程实例参数
        function - 待更新实例回调处理函数
      • addVariable

        default boolean addVariable​(java.lang.Long instanceId,
                                    java.util.Map<java.lang.String,​java.lang.Object> args)
        根据 流程实例ID 更新流程实例全局变量
        Parameters:
        instanceId - 流程实例ID
        args - 流程实例参数
      • endInstance

        boolean endInstance​(Execution execution,
                            java.lang.Long instanceId,
                            NodeModel endNode,
                            InstanceState instanceState)
        结束流程实例(审批通过)
        Parameters:
        execution - Execution
        instanceId - 流程实例ID
        endNode - 结束节点
        instanceState - 实例状态
        Returns:
        true 成功 false 失败
      • saveInstance

        void saveInstance​(FlwInstance flwInstance,
                          FlwProcess flwProcess,
                          boolean saveAsDraft,
                          FlowCreator flowCreator)
        保存流程实例
        Parameters:
        flwInstance - 流程实例对象
        flwProcess - 流程定义对象
        saveAsDraft - 暂存草稿
        flowCreator - 处理人员
      • suspendInstanceById

        boolean suspendInstanceById​(java.lang.Long instanceId,
                                    FlowCreator flowCreator)
        暂停流程实例 InstanceState.suspend
        Parameters:
        instanceId - 流程实例ID
        flowCreator - 处理人员
        Returns:
        true 成功 false 失败
      • activeInstanceById

        boolean activeInstanceById​(java.lang.Long instanceId,
                                   FlowCreator flowCreator)
        激活流程实例 InstanceState.active
        Parameters:
        instanceId - 流程实例ID
        flowCreator - 处理人员
        Returns:
        true 成功 false 失败
      • reject

        boolean reject​(java.lang.Long instanceId,
                       FlwTask currentFlwTask,
                       FlowCreator flowCreator)
        流程实例拒绝审批强制终止(用于后续审核人员认为该审批不再需要继续,拒绝审批强行终止)
        Parameters:
        instanceId - 流程实例ID
        currentFlwTask - 当前任务
        flowCreator - 处理人员
      • reject

        default boolean reject​(java.lang.Long instanceId,
                               FlowCreator flowCreator)
      • revoke

        boolean revoke​(java.lang.Long instanceId,
                       FlwTask currentFlwTask,
                       FlowCreator flowCreator)
        流程实例撤销(用于错误发起审批申请,发起人主动撤销)
        Parameters:
        instanceId - 流程实例ID
        currentFlwTask - 当前任务
        flowCreator - 处理人员
      • revoke

        default boolean revoke​(java.lang.Long instanceId,
                               FlowCreator flowCreator)
      • timeout

        boolean timeout​(java.lang.Long instanceId,
                        FlwTask currentFlwTask,
                        FlowCreator flowCreator)
        流程实例超时(设定审批时间超时,自动结束)
        Parameters:
        instanceId - 流程实例ID
        currentFlwTask - 当前任务
        flowCreator - 处理人员
      • timeout

        default boolean timeout​(java.lang.Long instanceId,
                                FlowCreator flowCreator)
      • timeout

        default boolean timeout​(java.lang.Long instanceId)
        流程实例超时(忽略操作权限)
        Parameters:
        instanceId - 流程实例ID
      • terminate

        boolean terminate​(java.lang.Long instanceId,
                          FlwTask currentFlwTask,
                          FlowCreator flowCreator)
        流程实例强制终止
        Parameters:
        instanceId - 流程实例ID
        currentFlwTask - 当前任务
        flowCreator - 处理人员
      • terminate

        default boolean terminate​(java.lang.Long instanceId,
                                  FlowCreator flowCreator)
      • updateInstance

        void updateInstance​(FlwInstance flwInstance)
        更新流程实例
        Parameters:
        flwInstance - 流程实例对象
      • updateInstanceModelById

        boolean updateInstanceModelById​(java.lang.Long instanceId,
                                        ProcessModel processModel)
        根据 流程实例ID 更新流程实例模型内容
        Parameters:
        instanceId - 流程实例ID
        processModel - 流程模型
        Returns:
        true 成功 false 失败
      • cascadeRemoveByProcessId

        void cascadeRemoveByProcessId​(java.lang.Long processId)
        级联删除指定流程实例的所有数据
        Parameters:
        processId - 流程ID
      • cascadeRemoveByInstanceId

        void cascadeRemoveByInstanceId​(java.lang.Long instanceId)
        级联删除表 flw_his_task_actor, flw_his_task, flw_task_actor, flw_task, flw_instance, flw_his_instance
        Parameters:
        instanceId - 流程实例ID
      • destroyByInstanceId

        boolean destroyByInstanceId​(java.lang.Long instanceId,
                                    java.util.Map<java.lang.String,​java.lang.Object> args)
        根据 流程实例ID 作废流程
        Parameters:
        instanceId - 流程实例ID
        args - 流程实例参数
        Returns:
        true 成功 false 失败