程序包 net.risesoft.api

类 TaskApiImpl

java.lang.Object

net.risesoft.api.TaskApiImpl

所有已实现的接口:

TaskApi

@RestController
@RequestMapping(value="/services/rest/task",
                produces="application/json")
public class TaskApiImpl
extends Object
implements TaskApi

正在运行任务相关接口

作者:

qinman, zhangchongjie

Date:

2022/12/30

构造器概要

构造器

构造器	说明
TaskApiImpl()

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	claim(String tenantId, String userId, String taskId)	签收任务
net.risesoft.pojo.Y9Result<Object>	complete(String tenantId, String taskId)	完成任务（不设置流程变量）
net.risesoft.pojo.Y9Result<Object>	completeTask(String tenantId, String taskId)	完成按钮的任务完结
net.risesoft.pojo.Y9Result<Object>	completeTaskWithoutAssignee(String tenantId, String orgUnitId, String processInstanceId)	完成按钮的任务完结（相关参与人员的人任务办结）
net.risesoft.pojo.Y9Result<Object>	completeWithVariables(String tenantId, String taskId, String orgUnitId, Map<String,Object> vars)	完成任务（设置流程变量）
net.risesoft.pojo.Y9Result<Object>	createWithVariables(String tenantId, String orgUnitId, String routeToTaskId, Map<String,Object> vars, List<String> orgUnitIdList)	创建变量
net.risesoft.pojo.Y9Result<Object>	delegateTask(String tenantId, String taskId, String assignee)	设置任务代理
net.risesoft.pojo.Y9Result<Object>	deleteCandidateUser(String tenantId, String taskId, String assignee)	删除任务的候选人
net.risesoft.pojo.Y9Result<List<TaskModel>>	findAll(String tenantId)	查找所有的任务实例
net.risesoft.pojo.Y9Result<TaskModel>	findById(String tenantId, String taskId)	根据任务id查找任务
net.risesoft.pojo.Y9Result<List<TaskModel>>	findByProcessInstanceId(String tenantId, String processInstanceId)	根据流程实例Id查找任务
net.risesoft.pojo.Y9Result<List<TaskModel>>	findByProcessInstanceId(String tenantId, String processInstanceId, boolean active)	根据流程实例Id和是否激活状态查找任务
net.risesoft.pojo.Y9Page<TaskModel>	findListByProcessInstanceId(String tenantId, String processInstanceId, Integer page, Integer rows)	根据流程实例id获取用户的待办任务(分页)
net.risesoft.pojo.Y9Result<Object>	saveTask(String tenantId, TaskModel taskModel)	保存任务
net.risesoft.pojo.Y9Result<Object>	setAssignee(String tenantId, String taskId, String assignee)	设置任务委托人
net.risesoft.pojo.Y9Result<Object>	setDueDate(String tenantId, String taskId, Date date)	设置任务的过期时间
net.risesoft.pojo.Y9Result<Object>	setPriority(String tenantId, String taskId, Integer priority)	设置任务的优先级
net.risesoft.pojo.Y9Result<Object>	unClaim(String tenantId, String taskId)	撤销签收任务

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TaskApiImpl

public TaskApiImpl()

方法详细资料

claim

public net.risesoft.pojo.Y9Result<Object> claim(@RequestParam
                                                String tenantId,
                                                @RequestParam
                                                String userId,
                                                @RequestParam
                                                String taskId)

签收任务

指定者:

claim 在接口中 TaskApi

参数:

tenantId - 租户id

userId - 人员、岗位id

taskId - 任务id

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

complete

public net.risesoft.pojo.Y9Result<Object> complete(@RequestParam
                                                   String tenantId,
                                                   @RequestParam
                                                   String taskId)

完成任务（不设置流程变量）

指定者:

complete 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

completeTask

public net.risesoft.pojo.Y9Result<Object> completeTask(@RequestParam
                                                       String tenantId,
                                                       @RequestParam
                                                       String taskId)

完成按钮的任务完结

指定者:

completeTask 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

completeTaskWithoutAssignee

public net.risesoft.pojo.Y9Result<Object> completeTaskWithoutAssignee(@RequestParam
                                                                      String tenantId,
                                                                      @RequestParam
                                                                      String orgUnitId,
                                                                      @RequestParam
                                                                      String processInstanceId)

完成按钮的任务完结（相关参与人员的人任务办结）

指定者:

completeTaskWithoutAssignee 在接口中 TaskApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位Id

processInstanceId - 流程实例id

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

completeWithVariables

public net.risesoft.pojo.Y9Result<Object> completeWithVariables(@RequestParam
                                                                String tenantId,
                                                                @RequestParam
                                                                String taskId,
                                                                @RequestParam
                                                                String orgUnitId,
                                                                @RequestBody
                                                                Map<String,Object> vars)

完成任务（设置流程变量）

指定者:

completeWithVariables 在接口中 TaskApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位Id

taskId - 任务id

vars - 变量map

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

createWithVariables

public net.risesoft.pojo.Y9Result<Object> createWithVariables(@RequestParam
                                                              String tenantId,
                                                              @RequestParam
                                                              String orgUnitId,
                                                              @RequestParam
                                                              String routeToTaskId,
                                                              Map<String,Object> vars,
                                                              @RequestBody
                                                              List<String> orgUnitIdList)

创建变量

指定者:

createWithVariables 在接口中 TaskApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位Id

routeToTaskId - 任务id

vars - 变量map

orgUnitIdList - 人员、岗位ids

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

delegateTask

public net.risesoft.pojo.Y9Result<Object> delegateTask(@RequestParam
                                                       String tenantId,
                                                       @RequestParam
                                                       String taskId,
                                                       @RequestParam
                                                       String assignee)

设置任务代理

指定者:

delegateTask 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

assignee - 受让人

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

deleteCandidateUser

public net.risesoft.pojo.Y9Result<Object> deleteCandidateUser(@RequestParam
                                                              String tenantId,
                                                              @RequestParam
                                                              String taskId,
                                                              @RequestParam
                                                              String assignee)

删除任务的候选人

指定者:

deleteCandidateUser 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

assignee - 受让人

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

findAll

public net.risesoft.pojo.Y9Result<List<TaskModel>> findAll(@RequestParam
                                                           String tenantId)

查找所有的任务实例

指定者:

findAll 在接口中 TaskApi

参数:

tenantId - 租户id

返回:

Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表

从以下版本开始:

9.6.6

findById

public net.risesoft.pojo.Y9Result<TaskModel> findById(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String taskId)

根据任务id查找任务

指定者:

findById 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<TaskModel> 通用请求返回对象 - data 任务信息

从以下版本开始:

9.6.6

findByProcessInstanceId

public net.risesoft.pojo.Y9Result<List<TaskModel>> findByProcessInstanceId(@RequestParam
                                                                           String tenantId,
                                                                           @RequestParam
                                                                           String processInstanceId)

根据流程实例Id查找任务

指定者:

findByProcessInstanceId 在接口中 TaskApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表

从以下版本开始:

9.6.6

findByProcessInstanceId

public net.risesoft.pojo.Y9Result<List<TaskModel>> findByProcessInstanceId(@RequestParam
                                                                           String tenantId,
                                                                           @RequestParam
                                                                           String processInstanceId,
                                                                           @RequestParam
                                                                           boolean active)

根据流程实例Id和是否激活状态查找任务

指定者:

findByProcessInstanceId 在接口中 TaskApi

参数:

tenantId - 租户id

processInstanceId - 流程实例Id

active - 是否存活

返回:

Y9Result<List<TaskModel>> 通用请求返回对象 - data 任务列表

从以下版本开始:

9.6.6

findListByProcessInstanceId

public net.risesoft.pojo.Y9Page<TaskModel> findListByProcessInstanceId(@RequestParam
                                                                       String tenantId,
                                                                       @RequestParam
                                                                       String processInstanceId,
                                                                       @RequestParam
                                                                       Integer page,
                                                                       @RequestParam
                                                                       Integer rows)

根据流程实例id获取用户的待办任务(分页)

指定者:

findListByProcessInstanceId 在接口中 TaskApi

参数:

tenantId - 租户Id

processInstanceId - 流程实例Id

page - 页码

rows - 行数

返回:

Y9Page<TaskModel> 通用分页请求返回对象 - rows 是待办任务

从以下版本开始:

9.6.6

saveTask

public net.risesoft.pojo.Y9Result<Object> saveTask(@RequestParam
                                                   String tenantId,
                                                   @RequestBody
                                                   TaskModel taskModel)

保存任务

指定者:

saveTask 在接口中 TaskApi

参数:

tenantId - 租户id

taskModel - 任务实体

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setAssignee

public net.risesoft.pojo.Y9Result<Object> setAssignee(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String taskId,
                                                      @RequestParam
                                                      String assignee)

设置任务委托人

指定者:

setAssignee 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

assignee - 受让人

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setDueDate

public net.risesoft.pojo.Y9Result<Object> setDueDate(@RequestParam
                                                     String tenantId,
                                                     @RequestParam
                                                     String taskId,
                                                     @RequestParam
                                                     Date date)

设置任务的过期时间

指定者:

setDueDate 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

date - 日期

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

setPriority

public net.risesoft.pojo.Y9Result<Object> setPriority(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String taskId,
                                                      @RequestParam
                                                      Integer priority)

设置任务的优先级

指定者:

setPriority 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

priority - 优先级

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6

unClaim

public net.risesoft.pojo.Y9Result<Object> unClaim(@RequestParam
                                                  String tenantId,
                                                  @RequestParam
                                                  String taskId)

撤销签收任务

指定者:

unClaim 在接口中 TaskApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Object> 通用请求返回对象 - success 属性判断操作是否成功

从以下版本开始:

9.6.6