程序包 net.risesoft.api

类 RuntimeApiImpl

java.lang.Object

net.risesoft.api.RuntimeApiImpl

所有已实现的接口:

RuntimeApi

@RestController
@RequestMapping(value="/services/rest/runtime",
                produces="application/json")
public class RuntimeApiImpl
extends Object
implements RuntimeApi

正在运行流程实例操作接口

作者:

qinman, zhangchongjie

Date:

2022/12/30

构造器概要

构造器

构造器	说明
RuntimeApiImpl()

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	addMultiInstanceExecution(String tenantId, String activityId, String parentExecutionId, Map<String,Object> map)	加签
net.risesoft.pojo.Y9Result<Object>	complete(String tenantId, String orgUnitId, String processInstanceId, String taskId)	真办结
net.risesoft.pojo.Y9Result<Object>	deleteMultiInstanceExecution(String tenantId, String executionId)	减签
net.risesoft.pojo.Y9Result<List<String>>	getActiveActivityIds(String tenantId, String executionId)	根据执行Id获取当前活跃的节点信息
net.risesoft.pojo.Y9Result<ExecutionModel>	getExecutionById(String tenantId, String executionId)	根据执行实例Id查找执行实例
net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>>	getListBySuperProcessInstanceId(String tenantId, String superProcessInstanceId)	根据父流程实例获取子流程实例
net.risesoft.pojo.Y9Result<ProcessInstanceModel>	getProcessInstance(String tenantId, String processInstanceId)	根据流程实例Id获取流程实例
net.risesoft.pojo.Y9Page<ProcessInstanceModel>	getProcessInstancesByDefId(String tenantId, String processDefinitionId, Integer page, Integer rows)	根据流程定义id获取流程实例列表
net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>>	getProcessInstancesByKey(String tenantId, String processDefinitionKey)	根据流程定义Key获取流程实例列表
net.risesoft.pojo.Y9Result<Object>	recovery4Completed(String tenantId, String orgUnitId, String processInstanceId, String year)	真办结后恢复流程实例为待办状态
net.risesoft.pojo.Y9Result<Object>	recovery4SetUpCompleted(String tenantId, String processInstanceId)	恢复流程实例为待办状态，其实是先激活，再设置流程实例的结束时间为null
net.risesoft.pojo.Y9Page<ProcessInstanceModel>	runningList(String tenantId, String processInstanceId, int page, int rows)	获取正在运行流程实例列表
net.risesoft.pojo.Y9Result<Object>	setUpCompleted(String tenantId, String processInstanceId)	设置流程实例为办结的状态，其实是先暂停，再设置流程结束时间为当前时间
net.risesoft.pojo.Y9Result<Object>	setVariable(String tenantId, String processInstanceId, String key, Map<String,Object> map)	根据流程实例id设置流程变量
net.risesoft.pojo.Y9Result<Object>	setVariables(String tenantId, String executionId, Map<String,Object> map)	根据流程实例id设置流程变量
net.risesoft.pojo.Y9Result<ProcessInstanceModel>	startProcessInstanceByKey(String tenantId, String orgUnitId, String processDefinitionKey, String systemName, Map<String,Object> map)	根据流程定义Key启动流程实例，设置流程变量,并返回流程实例,流程启动人是人员Id
net.risesoft.pojo.Y9Result<Boolean>	suspendedByProcessInstanceId(String tenantId, String processInstanceId)	判断是否是挂起实例
net.risesoft.pojo.Y9Result<Object>	switchSuspendOrActive(String tenantId, String processInstanceId, String state)	挂起或者激活流程实例

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

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

构造器详细资料

RuntimeApiImpl

public RuntimeApiImpl()

方法详细资料

addMultiInstanceExecution

public net.risesoft.pojo.Y9Result<Object> addMultiInstanceExecution(@RequestParam
                                                                    String tenantId,
                                                                    @RequestParam
                                                                    String activityId,
                                                                    @RequestParam
                                                                    String parentExecutionId,
                                                                    @RequestBody
                                                                    Map<String,Object> map)

加签

指定者:

addMultiInstanceExecution 在接口中 RuntimeApi

参数:

tenantId - 租户id

activityId - 活动节点id

parentExecutionId - 父执行实例id

map - 参数

返回:

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

从以下版本开始:

9.6.6

complete

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

真办结

指定者:

complete 在接口中 RuntimeApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位id

processInstanceId - 流程实例id

taskId - 任务id

返回:

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

抛出:

Exception

从以下版本开始:

9.6.6

deleteMultiInstanceExecution

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

减签

指定者:

deleteMultiInstanceExecution 在接口中 RuntimeApi

参数:

tenantId - 租户id

executionId - 执行实例id

返回:

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

从以下版本开始:

9.6.6

getActiveActivityIds

public net.risesoft.pojo.Y9Result<List<String>> getActiveActivityIds(@RequestParam
                                                                     String tenantId,
                                                                     @RequestParam
                                                                     String executionId)

根据执行Id获取当前活跃的节点信息

指定者:

getActiveActivityIds 在接口中 RuntimeApi

参数:

tenantId - 租户id

executionId - 执行实例id

返回:

Y9Result<List<String>> 通用请求返回对象 - data 是当前活跃的节点信息

从以下版本开始:

9.6.6

getExecutionById

public net.risesoft.pojo.Y9Result<ExecutionModel> getExecutionById(@RequestParam
                                                                   String tenantId,
                                                                   @RequestParam
                                                                   String executionId)

根据执行实例Id查找执行实例

指定者:

getExecutionById 在接口中 RuntimeApi

参数:

tenantId - 租户id

executionId - 执行实例id

返回:

Y9Result<ExecutionModel> 通用请求返回对象 - data 是执行实例

从以下版本开始:

9.6.6

getListBySuperProcessInstanceId

public net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>> getListBySuperProcessInstanceId(@RequestParam
                                                                                              String tenantId,
                                                                                              @RequestParam
                                                                                              String superProcessInstanceId)

根据父流程实例获取子流程实例

指定者:

getListBySuperProcessInstanceId 在接口中 RuntimeApi

参数:

tenantId - 租户id

superProcessInstanceId - 父流程实例id

返回:

Y9Result<List<ProcessInstanceModel>> 通用请求返回对象 - data 是子流程实例列表

从以下版本开始:

9.6.6

getProcessInstance

public net.risesoft.pojo.Y9Result<ProcessInstanceModel> getProcessInstance(@RequestParam
                                                                           String tenantId,
                                                                           @RequestParam
                                                                           String processInstanceId)

根据流程实例Id获取流程实例

指定者:

getProcessInstance 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

Y9Result<ProcessInstanceModel> 通用请求返回对象 - data 是流程实例

从以下版本开始:

9.6.6

getProcessInstancesByDefId

public net.risesoft.pojo.Y9Page<ProcessInstanceModel> getProcessInstancesByDefId(@RequestParam
                                                                                 String tenantId,
                                                                                 @RequestParam
                                                                                 String processDefinitionId,
                                                                                 @RequestParam
                                                                                 Integer page,
                                                                                 @RequestParam
                                                                                 Integer rows)

根据流程定义id获取流程实例列表

指定者:

getProcessInstancesByDefId 在接口中 RuntimeApi

参数:

tenantId - 租户id

processDefinitionId - 流程定义id

page - 页码

rows - 行数

返回:

Y9Page<ProcessInstanceModel> 通用分页请求返回对象 - rows 是流程实例

从以下版本开始:

9.6.6

getProcessInstancesByKey

public net.risesoft.pojo.Y9Result<List<ProcessInstanceModel>> getProcessInstancesByKey(@RequestParam
                                                                                       String tenantId,
                                                                                       @RequestParam
                                                                                       String processDefinitionKey)

根据流程定义Key获取流程实例列表

指定者:

getProcessInstancesByKey 在接口中 RuntimeApi

参数:

tenantId - 租户id

processDefinitionKey - 流程定义key

返回:

Y9Result<List<ProcessInstanceModel>> 通用请求返回对象 - data 是流程实例

从以下版本开始:

9.6.6

recovery4Completed

public net.risesoft.pojo.Y9Result<Object> recovery4Completed(@RequestParam
                                                             String tenantId,
                                                             @RequestParam
                                                             String orgUnitId,
                                                             @RequestParam
                                                             String processInstanceId,
                                                             @RequestParam
                                                             String year)
                                                      throws Exception

真办结后恢复流程实例为待办状态

指定者:

recovery4Completed 在接口中 RuntimeApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位id

processInstanceId - 流程实例id

year - 年份

返回:

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

抛出:

Exception

从以下版本开始:

9.6.6

recovery4SetUpCompleted

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

恢复流程实例为待办状态，其实是先激活，再设置流程实例的结束时间为null

指定者:

recovery4SetUpCompleted 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

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

从以下版本开始:

9.6.6

runningList

public net.risesoft.pojo.Y9Page<ProcessInstanceModel> runningList(@RequestParam
                                                                  String tenantId,
                                                                  @RequestParam
                                                                  String processInstanceId,
                                                                  @RequestParam
                                                                  int page,
                                                                  @RequestParam
                                                                  int rows)

获取正在运行流程实例列表

指定者:

runningList 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

page - 页吗

rows - 条数

返回:

Y9Page<Map<String, Object>> 通用分页请求返回对象 - rows 是流程实例

从以下版本开始:

9.6.6

setUpCompleted

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

设置流程实例为办结的状态，其实是先暂停，再设置流程结束时间为当前时间

指定者:

setUpCompleted 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

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

从以下版本开始:

9.6.6

setVariable

public net.risesoft.pojo.Y9Result<Object> setVariable(@RequestParam
                                                      String tenantId,
                                                      @RequestParam
                                                      String processInstanceId,
                                                      @RequestParam
                                                      String key,
                                                      @RequestBody
                                                      Map<String,Object> map)

根据流程实例id设置流程变量

指定者:

setVariable 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

key - 变量key

map - 变量map

返回:

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

从以下版本开始:

9.6.6

setVariables

public net.risesoft.pojo.Y9Result<Object> setVariables(@RequestParam
                                                       String tenantId,
                                                       @RequestParam
                                                       String executionId,
                                                       @RequestBody
                                                       Map<String,Object> map)

根据流程实例id设置流程变量

指定者:

setVariables 在接口中 RuntimeApi

参数:

tenantId - 租户id

executionId - 执行实例id

map - 变量map

返回:

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

从以下版本开始:

9.6.6

startProcessInstanceByKey

public net.risesoft.pojo.Y9Result<ProcessInstanceModel> startProcessInstanceByKey(@RequestParam
                                                                                  String tenantId,
                                                                                  @RequestParam
                                                                                  String orgUnitId,
                                                                                  @RequestParam
                                                                                  String processDefinitionKey,
                                                                                  @RequestParam
                                                                                  String systemName,
                                                                                  @RequestBody
                                                                                  Map<String,Object> map)

根据流程定义Key启动流程实例，设置流程变量,并返回流程实例,流程启动人是人员Id

指定者:

startProcessInstanceByKey 在接口中 RuntimeApi

参数:

tenantId - 租户id

orgUnitId - 人员、岗位id

processDefinitionKey - 流程定义key

systemName - 系统名称

map - 变量map

返回:

Y9Result<ProcessInstanceModel> 通用请求返回对象 - data 是流程实例

从以下版本开始:

9.6.6

suspendedByProcessInstanceId

public net.risesoft.pojo.Y9Result<Boolean> suspendedByProcessInstanceId(@RequestParam
                                                                        String tenantId,
                                                                        @RequestParam
                                                                        String processInstanceId)

判断是否是挂起实例

指定者:

suspendedByProcessInstanceId 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

返回:

Y9Result<Boolean> 通用请求返回对象 - data 属性判断流程是否挂起

从以下版本开始:

9.6.6

switchSuspendOrActive

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

挂起或者激活流程实例

指定者:

switchSuspendOrActive 在接口中 RuntimeApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

state - 状态

返回:

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

从以下版本开始:

9.6.6