参数开放接口
参数相关接口都在kd.bos.servicehelper.parameter.SystemParamServiceHelper类里
1.接口列表
接口名 | 说明 |
saveAppParameter | 保存与更新应用参数 |
getCloudParameter | 获取云参数 |
getAppParameter | 获取应用参数 |
getSystemParameter | 获取系统参数 |
getParameters | 获取整单系统参数 |
getParameter | 获取某个系统参数 |
getPublicParameter | 获取公共参数 |
getBillTypeParameter | 获取单据类型参数 |
getBillParameter | 获取单据参数 |
getGroupControlFields | 获取参数表单中的集团控制字段 |
loadAppParameterFromCache | 从缓存中获取某个应用参数 |
loadBatchAppParameterByOrg | 从数据库中获取批量应用参数 |
loadBatchAppParameterByOrgFromCache | 从缓存中获取批量应用参数 |
loadBillParameterFromCache | 获取单据参数（缓存），返回BillParam |
loadBillParameterObjectFromCache | 获取单据参数（缓存），返回Map<String, Object> |
loadPublicParameterFromCache | 从缓存中获取某个公共参数 |
loadPublicParametersFromCache | 从缓存中获取所有公共参数 |
getShowContentParameter | 获取公共参数--显示内容 |
2.接口详情
2.1 saveAppParameter
接口描述
保存与更新应用组织下的应用参数
方法
public static ParamOperationResult saveAppParameter(String viewType, Long orgId, Long actBookId, String appId,Map<String, Object> params)
参数说明
参数 | 类型 | 说明 |
viewType | String | 职能类型，默认为15业务单元 |
orgId | Long | 组织id |
actBookId | Long | 账簿id，默认为0 |
appId | String | 应用id |
params | Map<String, Object> | 参数值，key为参数字段的key， Object为参数的值 |
返回值
返回一个ParamOperationResult对象。
具体ParamOperationResult对象描述参考文档最下方的【返回对象描述】。
示例代码
保存或更新应用id为1，职能类型为15，组织id为10000，账套id为0的系统参数params，返回保存或更新的结果。
ParamOperationResult result = SystemParamServiceHelper. saveAppParameter(“15”, 10000, 0, 1, params);
2.2 getCloudParameter
接口描述
获取云应用参数中的某一参数
方法
public static Object getCloudParameter(String cloudId, String key)
参数说明
参数 | 类型 | 说明 |
cloudId | String | 云id |
key | String | 参数key,也就是参数的标识 |
返回值
返回云应用参数中的某一参数
示例代码
从数据库中获取云id为1，参数标识为ap_001的云应用参数。
Object cloudParamObj = SystemParamServiceHelper. getCloudParameter(1, “ap_001”);
2.3 loadAppParameterFromCache
接口描述
从缓存中获取应用参数
方法
public static Object loadAppParameterFromCache(AppParam appParam, String key)
public static Map<String, Object> loadAppParameterFromCache(AppParam appParam)
参数说明
参数 | 类型 | 说明 |
appParam | AppParam 包含： { appId: String, viewType: String, orgId: Long, actBookId: Long } | 应用参数对象 其中， appId为应用id， viewType为职能类型， orgId为组织id， actBookId为账簿id |
key | String | 参数key |
返回值
返回应用参数
示例代码
从缓存中获取key值为ap_001的系统参数
Object appParamObj = SystemParamServiceHelper.loadAppParameterFromCache (appParam, “ap_001”);
从缓存中批量获取系统参数
Map<String, Object> appParamObj = SystemParamServiceHelper.loadAppParameterFromCache (appParam);
2.4 loadBatchAppParameterByOrg
接口描述
从数据库中根据组织id列表，获取应用参数
方法
public static Map<String, Map<String, Object>> loadBatchAppParameterByOrg(AppParam appParam, List<Long> orgIds)
参数说明
参数 | 类型 | 说明 |
appParam | AppParam 包含： { appId: String, viewType: String, orgId: Long, actBookId: Long } | 应用参数对象 其中， appId为应用id， viewType为职能类型， orgId为组织id， actBookId为账簿id |
orgIds | List<Long> | 组织id列表 |
返回值
返回应用参数包
示例代码
从数据库中根据组织id列表，获取批量应用参数。返回对象中，以组织id为Map的key，对应的Value就是该组织下的系统参数
Map<String, Map<String, Object>> appParam = SystemParamServiceHelper. loadBatchAppParameterByOrg (appParam, orgIds);
2.5 loadBatchAppParameterByOrgFromCache
接口描述
从缓存中批量获取应用参数
方法
public static Map<String, Map<String, Object>> loadBatchAppParameterByOrgFromCache(AppParam appParam, List<Long> orgIds)
参数说明
参数 | 类型 | 说明 |
appParam | AppParam 包含： { appId: String, viewType: String, orgId: Long, actBookId: Long } | 应用参数对象 其中， appId为应用id， viewType为职能类型， orgId为组织id， actBookId为账簿id |
orgIds | List<Long> | 组织id列表 |
返回值
返回应用参数包
示例代码
从缓存中根据组织id列表，获取批量应用参数。返回对象中，以组织id为Map的key，对应的Value就是该组织下的系统参数
Map<String, Map<String, Object>> appParam = SystemParamServiceHelper. loadBatchAppParameterByOrgFromCache (appParam, orgIds);
2.6 getAppParameter
接口描述
获取应用参数
方法
public static Object getAppParameter(String appId, Long orgId, String key)
public static Object getAppParameter(String appId, String viewType, Long orgId, String key)
public static Object getAppParameter(String appId, String viewType, Long orgId, Long actBookId, String key)
参数说明
参数 | 类型 | 说明 |
appId | String | 应用id |
viewType | String | 职能类型，默认15为业务单元 |
orgId | Long | 组织id |
actBookId | Long | 账簿id，默认0 |
key | String | 系统参数key |
返回值
返回应用参数
示例代码
从数据库中查询应用id为1，职能类型为15，组织id为10000，账簿id为0，参数标识为ap_001的系统参数值
Object appParamObj = SystemParamServiceHelper. getAppParameter (“1”, “15”, 10000, 0L “ap_001”);
2.7 getSystemParameter
接口描述
获取系统参数
方法
public static Object getSystemParameter(String cloudId, String appId, Long orgId, String key)
public static Object getSystemParameter(String cloudId, String appId, String viewType, Long orgId, String key)
public static Object getSystemParameter(String cloudId, String appId, String viewType, Long orgId, Long actBookId, String key)
参数说明
参数 | 类型 | 说明 |
cloudId | String | 云id |
appId | String | 应用id |
viewType | String | 职能类型，默认15为业务单元 |
orgId | Long | 组织id |
actBookId | Long | 账簿id，默认0 |
key | String | 系统参数key |
返回值
返回系统参数
示例代码
从数据库中查询云id为空，应用id为1，职能类型为15，组织id为10000，账簿id为0，参数标识为ap_001的系统参数值
Object sysParamObj = SystemParamServiceHelper. getSystemParameter (“”, “1”, “15”, 10000, 0L “ap_001”);
2.8 getParameters
接口描述
获取整单系统参数
方法
public static DynamicObject getParameters(Long orgId, Long acctBookId, String subSystem)
public static DynamicObject getParameters(String viewType, Long orgId, Long acctBookId, String subSystem)
参数说明
参数 | 类型 | 说明 |
viewType | String | 职能类型 |
orgId | Long | 组织id |
actBookId | Long | 账簿id |
subSystem | String | 子系统 |
返回值
返回整单的系统参数
示例代码
从数据库中获取子系统为“application/fi/cas”，组织id为10000，职能类型为15，账簿id为0的系统参数。
Object sysParamObj = SystemParamServiceHelper. getParameters( “15”, 1000
参数开放接口
声明：除非特别标注，否则均为本站原创文章，转载时请以链接形式注明文章出处。如若本站内容侵犯了原著者的合法权益，可联系本站删除。
