程序包 net.risesoft.api

类 VariableApiImpl

java.lang.Object

net.risesoft.api.VariableApiImpl

所有已实现的接口:

VariableApi

@RestController
@RequestMapping("/services/rest/variable")
public class VariableApiImpl
extends Object
implements VariableApi

正在运行变量相关接口

作者:

qinman, zhangchongjie

Date:

2022/12/30

构造器概要

构造器

构造器	说明
VariableApiImpl()

方法概要

修饰符和类型	方法	说明
net.risesoft.pojo.Y9Result<Object>	deleteVariable(String tenantId, String taskId, String key)	删除流程变量
net.risesoft.pojo.Y9Result<Object>	deleteVariableLocal(String tenantId, String taskId, String key)	删除任务变量
net.risesoft.pojo.Y9Result<String>	getVariable(String tenantId, String taskId, String key)	获取流程变量
net.risesoft.pojo.Y9Result<String>	getVariableByProcessInstanceId(String tenantId, String processInstanceId, String key)	获取流程变量
net.risesoft.pojo.Y9Result<String>	getVariableLocal(String tenantId, String taskId, String key)	获取任务变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariables(String tenantId, String taskId)	获取多个流程变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariablesByProcessInstanceId(String tenantId, String processInstanceId, Collection<String> keys)	获取指定的流程变量
net.risesoft.pojo.Y9Result<Map<String,Object>>	getVariablesLocal(String tenantId, String taskId)	获取所有任务变量
net.risesoft.pojo.Y9Result<Object>	setVariable(String tenantId, String taskId, String key, Map<String,Object> map)	设置流程变量
net.risesoft.pojo.Y9Result<Object>	setVariableByProcessInstanceId(String tenantId, String processInstanceId, String key, Map<String,Object> map)	设置流程变量
net.risesoft.pojo.Y9Result<Object>	setVariableLocal(String tenantId, String taskId, String key, Map<String,Object> map)	设置任务变量
net.risesoft.pojo.Y9Result<Object>	setVariables(String tenantId, String taskId, Map<String,Object> map)	设置多个流程变量
net.risesoft.pojo.Y9Result<Object>	setVariablesLocal(String tenantId, String taskId, Map<String,Object> map)	设置多个任务变量

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

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

构造器详细资料

VariableApiImpl

public VariableApiImpl()

方法详细资料

deleteVariable

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

删除流程变量

指定者:

deleteVariable 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

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

从以下版本开始:

9.6.6

deleteVariableLocal

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

删除任务变量

指定者:

deleteVariableLocal 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

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

从以下版本开始:

9.6.6

getVariable

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

获取流程变量

指定者:

getVariable 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

Y9Result<String> 通用请求返回对象 - data 是流程变量

从以下版本开始:

9.6.6

getVariableByProcessInstanceId

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

获取流程变量

指定者:

getVariableByProcessInstanceId 在接口中 VariableApi

参数:

tenantId - 租户id

processInstanceId - 流程id

key - 变量key

返回:

Y9Result<String> 通用请求返回对象 - data 是流程变量

从以下版本开始:

9.6.6

getVariableLocal

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

获取任务变量

指定者:

getVariableLocal 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

返回:

Y9Result<String> 通用请求返回对象 - data 是任务变量

从以下版本开始:

9.6.6

getVariables

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

获取多个流程变量

指定者:

getVariables 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Map<String, Object>> 通用请求返回对象 - data 是流程变量

从以下版本开始:

9.6.6

getVariablesByProcessInstanceId

public net.risesoft.pojo.Y9Result<Map<String,Object>> getVariablesByProcessInstanceId(@RequestParam
                                                                                            String tenantId,
                                                                                            @RequestParam
                                                                                            String processInstanceId,
                                                                                            @RequestBody
                                                                                            Collection<String> keys)

获取指定的流程变量

指定者:

getVariablesByProcessInstanceId 在接口中 VariableApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

keys - 变量keys

返回:

Y9Result<Map<String, Object>> 通用请求返回对象 - data 是指定的流程变量

从以下版本开始:

9.6.6

getVariablesLocal

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

获取所有任务变量

指定者:

getVariablesLocal 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

返回:

Y9Result<Map<String, Object>> 通用请求返回对象 - data 是任务变量

从以下版本开始:

9.6.6

setVariable

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

设置流程变量

指定者:

setVariable 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

map - 变量值

返回:

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

从以下版本开始:

9.6.6

setVariableByProcessInstanceId

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

设置流程变量

指定者:

setVariableByProcessInstanceId 在接口中 VariableApi

参数:

tenantId - 租户id

processInstanceId - 流程实例id

key - 变量key

map - 变量值

返回:

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

从以下版本开始:

9.6.6

setVariableLocal

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

设置任务变量

指定者:

setVariableLocal 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

key - 变量key

map - 变量值

返回:

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

从以下版本开始:

9.6.6

setVariables

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

设置多个流程变量

指定者:

setVariables 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

map - 变量map

返回:

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

从以下版本开始:

9.6.6

setVariablesLocal

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

设置多个任务变量

指定者:

setVariablesLocal 在接口中 VariableApi

参数:

tenantId - 租户id

taskId - 任务id

map - 变量map

返回:

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

从以下版本开始:

9.6.6