net.sohelp.boot.engine.workflow

接口 TaskService

所有已知实现类:

TaskServiceImpl

public interface TaskService

任务业务类接口

从以下版本开始:

2025/02/03 10:26

方法概要

限定符和类型	方法和说明
default boolean	addTaskActor(Long taskId, PerformType performType, FlwTaskActor flwTaskActor, FlowCreator flowCreator)
boolean	addTaskActor(Long taskId, PerformType performType, List<FlwTaskActor> flwTaskActors, FlowCreator flowCreator) 向指定的任务ID添加参与者【加签】
default boolean	agentTask(Long taskId, FlowCreator flowCreator, List<FlowCreator> agentFlowCreators) 根据 任务ID 指定代理人
default boolean	assigneeTask(Long taskId, TaskType taskType, FlowCreator flowCreator, List<FlowCreator> assigneeFlowCreators)
boolean	assigneeTask(Long taskId, TaskType taskType, FlowCreator flowCreator, List<FlowCreator> assigneeFlowCreators, Function<FlwTask,Boolean> check) 根据 任务ID 分配任务给指定办理人、重置任务类型
boolean	cascadeRemoveByInstanceIds(List<Long> instanceIds) 级联删除 flw_his_task, flw_his_task_actor, flw_task, flw_task_actor
FlwTask	claimDepartment(Long taskId, FlowCreator flowCreator) 部门根据 任务ID 认领任务，删除其它任务参与者
FlwTask	claimRole(Long taskId, FlowCreator flowCreator) 角色根据 任务ID 认领任务，删除其它任务参与者
default FlwTask	complete(Long taskId, FlowCreator flowCreator)
default FlwTask	complete(Long taskId, FlowCreator flowCreator, Map<String,Object> args) 根据任务ID，创建人ID完成任务 该方法仅仅结束活动任务，并不能驱动流程继续执行
boolean	completeActiveTasksByInstanceId(Long instanceId, FlowCreator flowCreator) 完成指定实例ID活动任务
List<FlwTask>	createNewTask(Long taskId, TaskType taskType, PerformType performType, List<FlwTaskActor> taskActors, FlowCreator flowCreator, Function<FlwTask,Execution> executionFunction) 根据已有任务、参与者创建新的任务 适用于动态转派，动态协办等处理且流程图中不体现节点情况
default List<FlwTask>	createTask(NodeModel taskModel, Execution execution)
List<FlwTask>	createTask(NodeModel taskModel, Execution execution, Function<FlwTask,FlwTask> taskFunction) 根据任务模型、执行对象创建新的任务
default boolean	delegateTask(Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator) 根据 任务ID 委派任务、代理人办理完任务该任务重新归还给原处理人
void	endCallProcessTask(Long callProcessId, Long callInstanceId) 结束调用外部流程任务
default boolean	executeJumpTask(Long taskId, String nodeKey, FlowCreator flowCreator, Function<FlwTask,Execution> executionFunction)
default boolean	executeJumpTask(Long taskId, String nodeKey, FlowCreator flowCreator, Map<String,Object> args, Function<FlwTask,Execution> executionFunction)
Optional<FlwTask>	executeJumpTask(Long taskId, String nodeKey, FlowCreator flowCreator, Map<String,Object> args, Function<FlwTask,Execution> executionFunction, TaskType taskTye) 执行节点跳转任务
FlwTask	executeTask(Long taskId, FlowCreator flowCreator, Map<String,Object> args, TaskState taskState, TaskEventType eventType) 根据任务ID，创建人ID完成任务
boolean	executeTaskTrigger(Execution execution, FlwTask flwTask) 执行触发器任务
boolean	forceCompleteAllTask(Long instanceId, FlowCreator flowCreator, InstanceState instanceState, TaskEventType eventType) 强制完成所有任务
NodeModel	getTaskModel(Long taskId) 根据任务ID获取任务模型
List<FlwTask>	getTimeoutOrRemindTasks() 获取超时或者提醒的任务
FlwTaskActor	isAllowed(FlwTask flwTask, String userId) 根据 taskId、createBy 判断创建人createBy是否允许执行任务
Optional<FlwTask>	reclaimTask(Long taskId, FlowCreator flowCreator) 拿回任务、在当前办理人尚未处理文件前，允许上一节点提交人员执行拿回
default Optional<FlwTask>	rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator)
Optional<FlwTask>	rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator, Map<String,Object> args) 根据当前任务对象驳回至上一步处理
boolean	removeTaskActor(Long taskId, List<String> actorIds, FlowCreator flowCreator) 对指定的任务ID删除参与者【减签】
default boolean	removeTaskActor(Long taskId, String actorId, FlowCreator flowCreator)
boolean	resolveTask(Long taskId, FlowCreator flowCreator) 根据 任务ID 解决委派任务
FlwTask	resume(Long taskId, FlowCreator flowCreator) 唤醒历史任务 该方法会导致流程状态不可控，请慎用
boolean	transferTask(FlowCreator flowCreator, FlowCreator assigneeFlowCreator) 参与者的所有任务【离职转办】给指定办理人 用于任务参与者离职
default boolean	transferTask(Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator) 根据 任务ID 转办任务
void	updateTaskById(FlwTask flwTask, FlowCreator flowCreator) 更新任务对象
boolean	viewTask(Long taskId, FlwTaskActor taskActor) 查看任务设置为已阅状态
Optional<FlwTask>	withdrawTask(Long taskId, FlowCreator flowCreator) 根据任务ID、创建人撤回任务（该任务后续任务未执行前有效）

方法详细资料

complete

default FlwTask complete(Long taskId,
                         FlowCreator flowCreator,
                         Map<String,Object> args)

根据任务ID，创建人ID完成任务

该方法仅仅结束活动任务，并不能驱动流程继续执行

参数:

taskId - 任务ID

flowCreator - 任务完成者

args - 任务参数

返回:

Task 任务对象

complete

default FlwTask complete(Long taskId,
                         FlowCreator flowCreator)

executeTask

FlwTask executeTask(Long taskId,
                    FlowCreator flowCreator,
                    Map<String,Object> args,
                    TaskState taskState,
                    TaskEventType eventType)

根据任务ID，创建人ID完成任务

参数:

taskId - 任务ID

flowCreator - 任务完成者

args - 任务参数

taskState - 任务状态

eventType - 任务执行事件类型

返回:

Task 任务对象

forceCompleteAllTask

boolean forceCompleteAllTask(Long instanceId,
                             FlowCreator flowCreator,
                             InstanceState instanceState,
                             TaskEventType eventType)

强制完成所有任务

参数:

instanceId - 流程实例ID

flowCreator - 处理人员

instanceState - 流程实例最终状态

eventType - 监听事件类型

返回:

true 成功 false 失败

executeJumpTask

Optional<FlwTask> executeJumpTask(Long taskId,
                                  String nodeKey,
                                  FlowCreator flowCreator,
                                  Map<String,Object> args,
                                  Function<FlwTask,Execution> executionFunction,
                                  TaskType taskTye)

执行节点跳转任务

参数:

taskId - 任务ID

flowCreator - 任务创建者

args - 任务参数

nodeKey - 跳转至目标节点key

executionFunction - 执行函数

taskTye - 任务类型，仅支持 jump rejectJump routeJump

返回:

当前 flowCreator 所在的任务

executeJumpTask

default boolean executeJumpTask(Long taskId,
                                String nodeKey,
                                FlowCreator flowCreator,
                                Map<String,Object> args,
                                Function<FlwTask,Execution> executionFunction)

executeJumpTask

default boolean executeJumpTask(Long taskId,
                                String nodeKey,
                                FlowCreator flowCreator,
                                Function<FlwTask,Execution> executionFunction)

executeTaskTrigger

boolean executeTaskTrigger(Execution execution,
                           FlwTask flwTask)

执行触发器任务

参数:

execution - Execution

flwTask - 触发器任务

返回:

true 成功 false 失败

completeActiveTasksByInstanceId

boolean completeActiveTasksByInstanceId(Long instanceId,
                                        FlowCreator flowCreator)

完成指定实例ID活动任务

参数:

instanceId - 实例ID

flowCreator - 处理人员

返回:

true 成功 false 失败

updateTaskById

void updateTaskById(FlwTask flwTask,
                    FlowCreator flowCreator)

更新任务对象

参数:

flwTask - 任务对象

flowCreator - 处理人员

viewTask

boolean viewTask(Long taskId,
                 FlwTaskActor taskActor)

查看任务设置为已阅状态

参数:

taskId - 任务ID

taskActor - 任务参与者

返回:

true 成功 false 失败

claimRole

FlwTask claimRole(Long taskId,
                  FlowCreator flowCreator)

角色根据 任务ID 认领任务，删除其它任务参与者

参数:

taskId - 任务ID

flowCreator - 任务认领者

返回:

Task 任务对象

claimDepartment

FlwTask claimDepartment(Long taskId,
                        FlowCreator flowCreator)

部门根据 任务ID 认领任务，删除其它任务参与者

参数:

taskId - 任务ID

flowCreator - 任务认领者

返回:

Task 任务对象

agentTask

default boolean agentTask(Long taskId,
                          FlowCreator flowCreator,
                          List<FlowCreator> agentFlowCreators)

根据 任务ID 指定代理人

参数:

taskId - 任务ID

flowCreator - 任务参与者

agentFlowCreators - 指定代理人列表

返回:

true 成功 false 失败

transferTask

default boolean transferTask(Long taskId,
                             FlowCreator flowCreator,
                             FlowCreator assigneeFlowCreator)

根据 任务ID 转办任务

参数:

taskId - 任务ID

flowCreator - 任务参与者

assigneeFlowCreator - 指定办理人

返回:

true 成功 false 失败

transferTask

boolean transferTask(FlowCreator flowCreator,
                     FlowCreator assigneeFlowCreator)

参与者的所有任务【离职转办】给指定办理人

用于任务参与者离职

参数:

flowCreator - 任务参与者

assigneeFlowCreator - 指定办理人

返回:

true 成功 false 失败

delegateTask

default boolean delegateTask(Long taskId,
                             FlowCreator flowCreator,
                             FlowCreator assigneeFlowCreator)

根据 任务ID 委派任务、代理人办理完任务该任务重新归还给原处理人

参数:

taskId - 任务ID

flowCreator - 任务参与者

assigneeFlowCreator - 指定办理人

返回:

true 成功 false 失败

assigneeTask

boolean assigneeTask(Long taskId,
                     TaskType taskType,
                     FlowCreator flowCreator,
                     List<FlowCreator> assigneeFlowCreators,
                     Function<FlwTask,Boolean> check)

根据 任务ID 分配任务给指定办理人、重置任务类型

参数:

taskId - 任务ID

taskType - 任务类型

flowCreator - 任务参与者

assigneeFlowCreators - 指定办理人列表

check - 校验函数，可以根据 dbFlwTask.getAssignorId() 是否存在判断为重发分配

返回:

true 成功 false 失败

assigneeTask

default boolean assigneeTask(Long taskId,
                             TaskType taskType,
                             FlowCreator flowCreator,
                             List<FlowCreator> assigneeFlowCreators)

resolveTask

boolean resolveTask(Long taskId,
                    FlowCreator flowCreator)

根据 任务ID 解决委派任务

参数:

taskId - 任务ID

flowCreator - 任务参与者

返回:

true 成功 false 失败

reclaimTask

Optional<FlwTask> reclaimTask(Long taskId,
                              FlowCreator flowCreator)

拿回任务、在当前办理人尚未处理文件前，允许上一节点提交人员执行拿回

参数:

taskId - 任务ID（当前节点的父任务ID属于历史任务）

flowCreator - 任务创建者

返回:

拿回任务

resume

FlwTask resume(Long taskId,
               FlowCreator flowCreator)

唤醒历史任务

该方法会导致流程状态不可控，请慎用

参数:

taskId - 历史任务ID

flowCreator - 任务唤醒者

返回:

FlwTask 唤醒后的任务对象

withdrawTask

Optional<FlwTask> withdrawTask(Long taskId,
                               FlowCreator flowCreator)

根据任务ID、创建人撤回任务（该任务后续任务未执行前有效）

参数:

taskId - 待撤回历史任务ID

flowCreator - 任务创建者

返回:

Task 任务对象

rejectTask

Optional<FlwTask> rejectTask(FlwTask currentFlwTask,
                             FlowCreator flowCreator,
                             Map<String,Object> args)

根据当前任务对象驳回至上一步处理

参数:

currentFlwTask - 当前任务对象

flowCreator - 任务创建者

args - 任务参数

返回:

Task 任务对象

rejectTask

default Optional<FlwTask> rejectTask(FlwTask currentFlwTask,
                                     FlowCreator flowCreator)

isAllowed

FlwTaskActor isAllowed(FlwTask flwTask,
                       String userId)

根据 taskId、createBy 判断创建人createBy是否允许执行任务

参数:

flwTask - 任务对象

userId - 用户ID

返回:

被允许参与者 FlwTaskActor

createTask

List<FlwTask> createTask(NodeModel taskModel,
                         Execution execution,
                         Function<FlwTask,FlwTask> taskFunction)

根据任务模型、执行对象创建新的任务

参数:

taskModel - 任务模型

execution - 执行对象

taskFunction - 任务处理函数，如果自定义 CreateTaskHandler 可用于控制任务创建属性设置

返回:

创建任务集合

createTask

default List<FlwTask> createTask(NodeModel taskModel,
                                 Execution execution)

createNewTask

List<FlwTask> createNewTask(Long taskId,
                            TaskType taskType,
                            PerformType performType,
                            List<FlwTaskActor> taskActors,
                            FlowCreator flowCreator,
                            Function<FlwTask,Execution> executionFunction)

根据已有任务、参与者创建新的任务

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

参数:

taskId - 主办任务ID

taskActors - 参与者集合

taskType - 任务类型

performType - 参与类型

flowCreator - 任务创建者

executionFunction - 执行函数

返回:

创建任务集合

getTimeoutOrRemindTasks

List<FlwTask> getTimeoutOrRemindTasks()

获取超时或者提醒的任务

返回:

任务列表

getTaskModel

NodeModel getTaskModel(Long taskId)

根据任务ID获取任务模型

参数:

taskId - 任务ID

返回:

流程模型

addTaskActor

boolean addTaskActor(Long taskId,
                     PerformType performType,
                     List<FlwTaskActor> flwTaskActors,
                     FlowCreator flowCreator)

向指定的任务ID添加参与者【加签】

参数:

taskId - 任务ID

performType - 参与类型 PerformType

flwTaskActors - 参与者列表

flowCreator - 执行操作人员

返回:

true 成功 false 失败

addTaskActor

default boolean addTaskActor(Long taskId,
                             PerformType performType,
                             FlwTaskActor flwTaskActor,
                             FlowCreator flowCreator)

removeTaskActor

boolean removeTaskActor(Long taskId,
                        List<String> actorIds,
                        FlowCreator flowCreator)

对指定的任务ID删除参与者【减签】

参数:

taskId - 任务ID

actorIds - 参与者ID列表

flowCreator - 执行操作人员

返回:

true 成功 false 失败

removeTaskActor

default boolean removeTaskActor(Long taskId,
                                String actorId,
                                FlowCreator flowCreator)

endCallProcessTask

void endCallProcessTask(Long callProcessId,
                        Long callInstanceId)

结束调用外部流程任务

参数:

callProcessId - 调用外部流程定义ID

callInstanceId - 调用外部流程实例ID

cascadeRemoveByInstanceIds

boolean cascadeRemoveByInstanceIds(List<Long> instanceIds)

级联删除 flw_his_task, flw_his_task_actor, flw_task, flw_task_actor

参数:

instanceIds - 流程实例ID列表