Package com.aizuda.bpm.engine
Interface TaskService
-
- All Known Implementing Classes:
TaskServiceImpl
public interface TaskService任务业务类接口官网尊重知识产权,不允许非法使用,后果自负
- Since:
- 1.0
- Author:
- hubin
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default booleanaddTaskActor(java.lang.Long taskId, PerformType performType, FlwTaskActor taskActor, FlowCreator flowCreator)booleanaddTaskActor(java.lang.Long taskId, PerformType performType, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator)向指定的任务ID添加参与者【加签】default booleanaddTaskActor(java.lang.Long taskId, FlwTaskActor taskActor, FlowCreator flowCreator)default booleanaddTaskActor(java.lang.Long taskId, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator)default booleanagentTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.List<FlowCreator> agentFlowCreators)default booleanagentTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.List<FlowCreator> agentFlowCreators, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 指定代理人default booleanassigneeTask(java.lang.Long taskId, TaskType taskType, FlowCreator flowCreator, java.util.List<FlowCreator> assigneeFlowCreators)booleanassigneeTask(java.lang.Long taskId, TaskType taskType, FlowCreator flowCreator, java.util.List<FlowCreator> assigneeFlowCreators, java.util.Map<java.lang.String,java.lang.Object> args, java.util.function.Function<FlwTask,java.lang.Boolean> check)根据 任务ID 分配任务给指定办理人、重置任务类型booleancascadeRemoveByInstanceIds(java.util.List<java.lang.Long> instanceIds)级联删除 flw_his_task, flw_his_task_actor, flw_task, flw_task_actorbooleanchangeTaskActor(java.lang.Long taskId, FlwTaskActor taskActor)修改 taskId 任务办理人为指定 taskActor 参与者FlwTaskclaimDepartment(java.lang.Long taskId, FlowCreator flowCreator)部门根据 任务ID 认领任务,删除其它任务参与者FlwTaskclaimRole(java.lang.Long taskId, FlowCreator flowCreator)角色根据 任务ID 认领任务,删除其它任务参与者default FlwTaskcomplete(java.lang.Long taskId, FlowCreator flowCreator)default FlwTaskcomplete(java.lang.Long taskId, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据任务ID,创建人ID完成任务booleancompleteActiveTasksByInstanceId(java.lang.Long instanceId, FlowCreator flowCreator)完成指定实例ID活动任务booleancreateCcTask(NodeModel taskModel, FlwTask flwTask, java.util.List<NodeAssignee> ccUserList, FlowCreator flowCreator)创建抄送任务java.util.List<FlwTask>createNewTask(java.lang.Long taskId, TaskType taskType, PerformType performType, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator, java.util.function.Function<FlwTask,Execution> executionFunction)根据已有任务、参与者创建新的任务default java.util.List<FlwTask>createTask(NodeModel taskModel, Execution execution)java.util.List<FlwTask>createTask(NodeModel taskModel, Execution execution, java.util.function.Function<FlwTask,FlwTask> taskFunction)根据任务模型、执行对象创建新的任务default booleandelegateTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator)default booleandelegateTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 委派任务、代理人办理完任务该任务重新归还给原处理人voidendCallProcessTask(java.lang.Long callProcessId, java.lang.Long callInstanceId)结束调用外部流程任务booleanexecuteFinishTrigger(NodeModel nodeModel, Execution execution, FlowCreator flowCreator)执行完成触发器操作流程继续往下执行default booleanexecuteJumpTask(java.lang.Long taskId, java.lang.String nodeKey, FlowCreator flowCreator, java.util.function.Function<FlwTask,Execution> executionFunction)default booleanexecuteJumpTask(java.lang.Long taskId, java.lang.String nodeKey, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args, java.util.function.Function<FlwTask,Execution> executionFunction)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, java.util.function.Function<FlwTask,Execution> executionFunction, TaskType taskTye)执行节点跳转任务FlwTaskexecuteTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args, TaskState taskState, TaskEventType eventType)根据任务ID,创建人ID完成任务booleanexecuteTaskTrigger(Execution execution, FlwTask flwTask)执行触发器任务booleanforceCompleteAllTask(java.lang.Long instanceId, FlwTask currentFlwTask, FlowCreator flowCreator, InstanceState instanceState, TaskEventType eventType)强制完成所有任务booleanforceCompleteTask(FlwTask flwTask, FlowCreator flowCreator, TaskState taskState, TaskEventType eventType)强制完成某个任务NodeModelgetTaskModel(java.lang.Long taskId)根据任务ID获取任务模型java.util.List<FlwTask>getTimeoutOrRemindTasks()获取超时或者提醒的任务FlwTaskActorisAllowed(FlwTask flwTask, java.lang.String userId)根据 taskId、createBy 判断创建人createBy是否允许执行任务java.util.Optional<java.util.List<FlwTask>>reclaimTask(java.lang.Long taskId, FlowCreator flowCreator)拿回任务、在当前办理人尚未处理文件前,允许上一节点提交人员执行拿回default java.util.Optional<java.util.List<FlwTask>>rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator)java.util.Optional<java.util.List<FlwTask>>rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据当前任务对象驳回至上一步处理default booleanremoveTaskActor(java.lang.Long taskId, java.lang.String actorId, FlowCreator flowCreator)booleanremoveTaskActor(java.lang.Long taskId, java.util.List<java.lang.String> actorIds, FlowCreator flowCreator)对指定的任务ID删除参与者【减签】booleanresolveTask(java.lang.Long taskId, FlowCreator flowCreator)根据 任务ID 解决委派任务default booleanresume(java.lang.Long instanceId, FlowCreator flowCreator)唤醒撤回或拒绝终止历史任务(只有实例发起人可操作)booleanresume(java.lang.Long instanceId, java.lang.String nodeKey, FlowCreator flowCreator)唤醒撤回或拒绝终止历史任务(只有实例发起人可操作)booleantransferTask(FlowCreator flowCreator, FlowCreator assigneeFlowCreator)参与者的所有任务【离职转办】给指定办理人default booleantransferTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator)default booleantransferTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 转办任务voidupdateTaskById(FlwTask flwTask, FlowCreator flowCreator)更新任务对象booleanviewTask(java.lang.Long taskId, FlowCreator flowCreator)查看任务设置为已阅状态java.util.Optional<java.util.List<FlwTask>>withdrawTask(java.lang.Long taskId, FlowCreator flowCreator)根据任务ID、创建人撤回任务(该任务后续任务未执行前有效)
-
-
-
Method Detail
-
complete
default FlwTask complete(java.lang.Long taskId, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args)
根据任务ID,创建人ID完成任务该方法仅仅结束活动任务,并不能驱动流程继续执行
- Parameters:
taskId- 任务IDflowCreator- 任务完成者args- 任务参数- Returns:
- Task 任务对象
-
complete
default FlwTask complete(java.lang.Long taskId, FlowCreator flowCreator)
-
executeTask
FlwTask executeTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args, TaskState taskState, TaskEventType eventType)
根据任务ID,创建人ID完成任务- Parameters:
taskId- 任务IDflowCreator- 任务完成者args- 任务参数taskState- 任务状态eventType- 任务执行事件类型- Returns:
- Task 任务对象
-
forceCompleteAllTask
boolean forceCompleteAllTask(java.lang.Long instanceId, FlwTask currentFlwTask, FlowCreator flowCreator, InstanceState instanceState, TaskEventType eventType)强制完成所有任务- Parameters:
instanceId- 流程实例IDcurrentFlwTask- 当前任务flowCreator- 处理人员instanceState- 流程实例最终状态eventType- 监听事件类型- Returns:
- true 成功 false 失败
-
forceCompleteTask
boolean forceCompleteTask(FlwTask flwTask, FlowCreator flowCreator, TaskState taskState, TaskEventType eventType)
强制完成某个任务- Parameters:
flwTask- 审批任务flowCreator- 处理人员taskState- 流任务状态eventType- 监听事件类型- Returns:
- true 成功 false 失败
-
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, java.util.function.Function<FlwTask,Execution> executionFunction, TaskType taskTye)
执行节点跳转任务- Parameters:
taskId- 任务IDflowCreator- 任务创建者args- 任务参数nodeKey- 跳转至目标节点keyexecutionFunction- 执行函数taskTye- 任务类型,仅支持 jump rejectJump routeJump- Returns:
- 当前 flowCreator 所在的任务
-
executeJumpTask
default boolean executeJumpTask(java.lang.Long taskId, java.lang.String nodeKey, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args, java.util.function.Function<FlwTask,Execution> executionFunction)
-
executeJumpTask
default boolean executeJumpTask(java.lang.Long taskId, java.lang.String nodeKey, FlowCreator flowCreator, java.util.function.Function<FlwTask,Execution> executionFunction)
-
executeTaskTrigger
boolean executeTaskTrigger(Execution execution, FlwTask flwTask)
执行触发器任务- Parameters:
execution-ExecutionflwTask- 触发器任务- Returns:
- true 成功 false 失败
-
completeActiveTasksByInstanceId
boolean completeActiveTasksByInstanceId(java.lang.Long instanceId, FlowCreator flowCreator)完成指定实例ID活动任务- Parameters:
instanceId- 实例IDflowCreator- 处理人员- Returns:
- true 成功 false 失败
-
updateTaskById
void updateTaskById(FlwTask flwTask, FlowCreator flowCreator)
更新任务对象- Parameters:
flwTask- 任务对象flowCreator- 处理人员
-
viewTask
boolean viewTask(java.lang.Long taskId, FlowCreator flowCreator)查看任务设置为已阅状态- Parameters:
taskId- 任务IDflowCreator- 处理人员- Returns:
- true 成功 false 失败
-
claimRole
FlwTask claimRole(java.lang.Long taskId, FlowCreator flowCreator)
角色根据 任务ID 认领任务,删除其它任务参与者- Parameters:
taskId- 任务IDflowCreator- 任务认领者- Returns:
- Task 任务对象
-
claimDepartment
FlwTask claimDepartment(java.lang.Long taskId, FlowCreator flowCreator)
部门根据 任务ID 认领任务,删除其它任务参与者- Parameters:
taskId- 任务IDflowCreator- 任务认领者- Returns:
- Task 任务对象
-
agentTask
default boolean agentTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.List<FlowCreator> agentFlowCreators, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 指定代理人- Parameters:
taskId- 任务IDflowCreator- 任务参与者agentFlowCreators- 指定代理人列表args- 任务参数- Returns:
- true 成功 false 失败
-
agentTask
default boolean agentTask(java.lang.Long taskId, FlowCreator flowCreator, java.util.List<FlowCreator> agentFlowCreators)
-
transferTask
default boolean transferTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 转办任务- Parameters:
taskId- 任务IDflowCreator- 任务参与者assigneeFlowCreator- 指定办理人args- 任务参数- Returns:
- true 成功 false 失败
-
transferTask
default boolean transferTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator)
-
transferTask
boolean transferTask(FlowCreator flowCreator, FlowCreator assigneeFlowCreator)
参与者的所有任务【离职转办】给指定办理人用于任务参与者离职
- Parameters:
flowCreator- 任务参与者assigneeFlowCreator- 指定办理人- Returns:
- true 成功 false 失败
-
delegateTask
default boolean delegateTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator, java.util.Map<java.lang.String,java.lang.Object> args)根据 任务ID 委派任务、代理人办理完任务该任务重新归还给原处理人- Parameters:
taskId- 任务IDflowCreator- 任务参与者assigneeFlowCreator- 指定办理人args- 任务参数- Returns:
- true 成功 false 失败
-
delegateTask
default boolean delegateTask(java.lang.Long taskId, FlowCreator flowCreator, FlowCreator assigneeFlowCreator)
-
assigneeTask
boolean assigneeTask(java.lang.Long taskId, TaskType taskType, FlowCreator flowCreator, java.util.List<FlowCreator> assigneeFlowCreators, java.util.Map<java.lang.String,java.lang.Object> args, java.util.function.Function<FlwTask,java.lang.Boolean> check)根据 任务ID 分配任务给指定办理人、重置任务类型- Parameters:
taskId- 任务IDtaskType- 任务类型flowCreator- 任务参与者assigneeFlowCreators- 指定办理人列表args- 任务参数check- 校验函数,可以根据 dbFlwTask.getAssignorId() 是否存在判断为重发分配- Returns:
- true 成功 false 失败
-
assigneeTask
default boolean assigneeTask(java.lang.Long taskId, TaskType taskType, FlowCreator flowCreator, java.util.List<FlowCreator> assigneeFlowCreators)
-
resolveTask
boolean resolveTask(java.lang.Long taskId, FlowCreator flowCreator)根据 任务ID 解决委派任务- Parameters:
taskId- 任务IDflowCreator- 任务参与者- Returns:
- true 成功 false 失败
-
reclaimTask
java.util.Optional<java.util.List<FlwTask>> reclaimTask(java.lang.Long taskId, FlowCreator flowCreator)
拿回任务、在当前办理人尚未处理文件前,允许上一节点提交人员执行拿回- Parameters:
taskId- 任务ID(当前节点的父任务ID属于历史任务)flowCreator- 任务创建者- Returns:
- 拿回任务
-
resume
default boolean resume(java.lang.Long instanceId, FlowCreator flowCreator)唤醒撤回或拒绝终止历史任务(只有实例发起人可操作)- Parameters:
instanceId- 历史实例IDflowCreator- 任务唤醒者- Returns:
- true 成功 false 失败
-
resume
boolean resume(java.lang.Long instanceId, java.lang.String nodeKey, FlowCreator flowCreator)唤醒撤回或拒绝终止历史任务(只有实例发起人可操作)- Parameters:
instanceId- 历史实例IDnodeKey- 节点key历史任务flowCreator- 任务唤醒者- Returns:
- true 成功 false 失败
-
withdrawTask
java.util.Optional<java.util.List<FlwTask>> withdrawTask(java.lang.Long taskId, FlowCreator flowCreator)
根据任务ID、创建人撤回任务(该任务后续任务未执行前有效)- Parameters:
taskId- 待撤回历史任务IDflowCreator- 任务创建者- Returns:
- Task 任务对象
-
rejectTask
java.util.Optional<java.util.List<FlwTask>> rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator, java.util.Map<java.lang.String,java.lang.Object> args)
根据当前任务对象驳回至上一步处理- Parameters:
currentFlwTask- 当前任务对象flowCreator- 任务创建者args- 任务参数- Returns:
- Task 任务对象
-
rejectTask
default java.util.Optional<java.util.List<FlwTask>> rejectTask(FlwTask currentFlwTask, FlowCreator flowCreator)
-
executeFinishTrigger
boolean executeFinishTrigger(NodeModel nodeModel, Execution execution, FlowCreator flowCreator)
执行完成触发器操作流程继续往下执行
-
isAllowed
FlwTaskActor isAllowed(FlwTask flwTask, java.lang.String userId)
根据 taskId、createBy 判断创建人createBy是否允许执行任务- Parameters:
flwTask- 任务对象userId- 用户ID- Returns:
- 被允许参与者
FlwTaskActor
-
createTask
java.util.List<FlwTask> createTask(NodeModel taskModel, Execution execution, java.util.function.Function<FlwTask,FlwTask> taskFunction)
根据任务模型、执行对象创建新的任务- Parameters:
taskModel- 任务模型execution- 执行对象taskFunction- 任务处理函数,如果自定义 CreateTaskHandler 可用于控制任务创建属性设置- Returns:
- 创建任务集合
-
createNewTask
java.util.List<FlwTask> createNewTask(java.lang.Long taskId, TaskType taskType, PerformType performType, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator, java.util.function.Function<FlwTask,Execution> executionFunction)
根据已有任务、参与者创建新的任务适用于动态转派,动态协办等处理且流程图中不体现节点情况
- Parameters:
taskId- 主办任务IDtaskActors- 参与者集合taskType- 任务类型performType- 参与类型flowCreator- 任务创建者executionFunction- 执行函数- Returns:
- 创建任务集合
-
createCcTask
boolean createCcTask(NodeModel taskModel, FlwTask flwTask, java.util.List<NodeAssignee> ccUserList, FlowCreator flowCreator)
创建抄送任务默认不校验是否重复抄送
- Parameters:
taskModel- 任务模型flwTask- 当前任务ccUserList- 抄送任务分配到任务的人或角色列表flowCreator- 任务创建者
-
getTimeoutOrRemindTasks
java.util.List<FlwTask> getTimeoutOrRemindTasks()
获取超时或者提醒的任务- Returns:
- 任务列表
-
getTaskModel
NodeModel getTaskModel(java.lang.Long taskId)
根据任务ID获取任务模型- Parameters:
taskId- 任务ID- Returns:
- 流程模型
-
addTaskActor
boolean addTaskActor(java.lang.Long taskId, PerformType performType, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator)向指定的任务ID添加参与者【加签】- Parameters:
taskId- 任务IDperformType- 参与类型PerformTypetaskActors- 参与者列表flowCreator- 执行操作人员- Returns:
- true 成功 false 失败
-
addTaskActor
default boolean addTaskActor(java.lang.Long taskId, PerformType performType, FlwTaskActor taskActor, FlowCreator flowCreator)
-
addTaskActor
default boolean addTaskActor(java.lang.Long taskId, java.util.List<FlwTaskActor> taskActors, FlowCreator flowCreator)
-
addTaskActor
default boolean addTaskActor(java.lang.Long taskId, FlwTaskActor taskActor, FlowCreator flowCreator)
-
removeTaskActor
boolean removeTaskActor(java.lang.Long taskId, java.util.List<java.lang.String> actorIds, FlowCreator flowCreator)对指定的任务ID删除参与者【减签】- Parameters:
taskId- 任务IDactorIds- 参与者ID列表flowCreator- 执行操作人员- Returns:
- true 成功 false 失败
-
removeTaskActor
default boolean removeTaskActor(java.lang.Long taskId, java.lang.String actorId, FlowCreator flowCreator)
-
changeTaskActor
boolean changeTaskActor(java.lang.Long taskId, FlwTaskActor taskActor)修改 taskId 任务办理人为指定 taskActor 参与者- Parameters:
taskId- 任务IDtaskActor- 参与者- Returns:
- true 成功 false 失败
-
endCallProcessTask
void endCallProcessTask(java.lang.Long callProcessId, java.lang.Long callInstanceId)结束调用外部流程任务- Parameters:
callProcessId- 调用外部流程定义IDcallInstanceId- 调用外部流程实例ID
-
cascadeRemoveByInstanceIds
boolean cascadeRemoveByInstanceIds(java.util.List<java.lang.Long> instanceIds)
级联删除 flw_his_task, flw_his_task_actor, flw_task, flw_task_actor- Parameters:
instanceIds- 流程实例ID列表
-
-