EOS Low-Code Platform 8
学习指南
更新说明
初见EOS
专业代码开发手册
公共服务框架
常见问题

# BPSClient API接口

# 一、WFActivityInstManager

# 1. activateActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.activateActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.activateActivityInst(long)
方法说明 用于激活一个待激活、未启动状态的活动
接口类型 Service API
适用场景 激活活动实例
# 方法定义
/**
 * 用于激活一个待激活、未启动状态的活动
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void activateActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 2. changeActivityInstState 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.changeActivityInstState
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.changeActivityInstState(long, int)
方法说明 改变活动实例的当前状态到指定的目标状态
接口类型 Service API
适用场景 修改活动实例状态
# 方法定义
/**
 * 改变活动实例的当前状态到指定的目标状态
 * @param activityInstID 活动实例ID
 * @param destState 目标状态
 * @throws WFApiException
 */
public void changeActivityInstState(long activityInstID, int destState) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
destState int 是 目标状态（值范围：1—未启动
2—运行
3—挂起
7—完成
8—终止
9—取消
10—待激活）
# 返回值

返回类型： void

# 3. createAndStartActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.createAndStartActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.createAndStartActivityInst(long, String)
方法说明 根据流程实例ID和活动定义ID创建并启动一个未运行到的活动
接口类型 Service API
适用场景 创建并启动活动实例
# 方法定义
/**
 * 根据流程实例ID和活动定义ID创建并启动一个未运行到的活动
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @return 活动实例ID
 * @throws WFApiException
 */
public long createAndStartActivityInst(long processInstID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： long

# 4. createAndStartActivityInstWithId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.createAndStartActivityInstWithId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.createAndStartActivityInstWithId(long, String, long)
方法说明 根据流程实例ID、活动定义ID和活动实例ID创建并启动一个未运行到的活动
接口类型 Service API
适用场景 创建并启动活动实例
# 方法定义
/**
 * 根据流程实例ID、活动定义ID和活动实例ID创建并启动一个未运行到的活动
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void createAndStartActivityInstWithId(long processInstID, String activityDefID, long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 5. executeRollbackAction 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.executeRollbackAction
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.executeRollbackAction(long)
方法说明 执行活动实例ID对应的回退动作
接口类型 Service API
适用场景 回退活动实例
# 方法定义
/**
 * 执行活动实例ID对应的回退动作
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void executeRollbackAction(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 6. findActivityInstByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.findActivityInstByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.findActivityInstByActivityInstId(long)
方法说明 根据活动实例ID查询活动实例
接口类型 Service API
适用场景 查询活动实例
# 方法定义
/**
 * 根据活动实例ID查询活动实例
 * @param actInstID 活动实例ID
 * @return 活动实例对象
 * @throws WFApiException
 */
public WFActivityInst findActivityInstByActivityInstId(long actInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
# 返回值

返回类型： WFActivityInst

# 7. findLastActivityInstByActivityId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.findLastActivityInstByActivityId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.findLastActivityInstByActivityId(long, String)
方法说明 根据活动定义ID以及流程实例ID，查询最近被实例化的活动实例
接口类型 Service API
适用场景 查询最新活动实例
# 方法定义
/**
 * 根据活动定义ID以及流程实例ID，查询最近被实例化的活动实例
 * @param procInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @return 活动实例对象
 * @throws WFApiException
 */
public WFActivityInst findLastActivityInstByActivityId(long procInstID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： WFActivityInst

# 8. finishActivityInstAlone 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.finishActivityInstAlone
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.finishActivityInstAlone(long)
方法说明 完成活动实例但不终止正在运行的工作项
接口类型 Service API
适用场景 完成活动实例
# 方法定义
/**
 * 完成活动实例但不终止正在运行的工作项
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void finishActivityInstAlone(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 9. finishActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.finishActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.finishActivityInst(long)
方法说明 完成活动实例
接口类型 Service API
适用场景 完成活动实例
# 方法定义
/**
 * 完成活动实例
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void finishActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 10. finishActivityInstWithTXSpan 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.finishActivityInstWithTXSpan
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.finishActivityInstWithTXSpan(long, Map<String, Object>, boolean)
方法说明 完成活动实例，并设置相关数据和事务分割开关
接口类型 Service API
适用场景 完成活动实例并设置事务
# 方法定义
/**
 * 完成活动实例，并设置相关数据和事务分割开关
 * @param activityInstID 活动实例ID
 * @param map 相关数据
 * @param transactionSpan 是否设置事务分割
 * @throws WFApiException
 */
public void finishActivityInstWithTXSpan(long activityInstID, Map<String, Object> map, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
map Map<String, Object> 是 相关数据
transactionSpan boolean 是 是否设置事务分割
# 返回值

返回类型： void

# 11. finishActivityInstByActivityId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.finishActivityInstByActivityId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.finishActivityInstByActivityId(long, String)
方法说明 完成某个流程实例下的某个活动定义对应的活动实例
接口类型 Service API
适用场景 完成特定活动实例
# 方法定义
/**
 * 完成某个流程实例下的某个活动定义对应的活动实例
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @throws WFApiException
 */
public void finishActivityInstByActivityId(long processInstID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： void

# 12. finishActivityInstWithRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.finishActivityInstWithRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.finishActivityInstWithRelativeData(long, Map<String, Object>, boolean, boolean)
方法说明 完成活动实例，并设置相关数据
接口类型 Service API
适用场景 完成活动实例并设置相关数据
# 方法定义
/**
 * 完成活动实例，并设置相关数据
 * @param activityInstID 活动实例ID
 * @param map 相关数据
 * @param isTerminateWI 是否终止工作项
 * @param isSplitTrans 是否设置事务分割
 * @throws WFApiException
 */
public void finishActivityInstWithRelativeData(long activityInstID, Map<String, Object> map, boolean isTerminateWI, boolean isSplitTrans) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
map Map<String, Object> 是 相关数据
isTerminateWI boolean 是 是否终止工作项
isSplitTrans boolean 是 是否设置事务分割
# 返回值

返回类型： void

# 13. generateActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.generateActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.generateActivityInstId()
方法说明 生成活动实例ID
接口类型 Service API
适用场景 生成新的活动实例ID
# 方法定义
/**
 * 生成活动实例ID
 * @return 活动实例ID
 * @throws WFApiException
 */
public long generateActivityInstId() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： long

# 14. getActivityInstElapsedTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.getActivityInstElapsedTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.getActivityInstElapsedTime(long, long)
方法说明 返回该活动实例的总体有效执行时间
接口类型 Service API
适用场景 计算活动实例的执行时间
# 方法定义
/**
 * 返回该活动实例的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的活动执行时间
 * @param processInstID 流程实例ID
 * @param activityInstID 活动实例ID
 * @return 活动实例的执行时间
 * @throws WFApiException
 */
public long getActivityInstElapsedTime(long processInstID, long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityInstID long 是 活动实例ID
# 返回值

返回类型： long

# 15. getActivityInstNextStateList 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.getActivityInstNextStateList
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.getActivityInstNextStateList(long)
方法说明 查询活动实例的后继状态列表
接口类型 Service API
适用场景 查询活动实例的后继状态
# 方法定义
/**
 * 查询活动实例的后继状态列表
 * @param activityInstID 活动实例ID
 * @return 后继状态列表
 * @throws WFApiException
 */
public List<Integer> getActivityInstNextStateList(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： List<Integer>

# 16. getActivityInstState 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.getActivityInstState
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.getActivityInstState(long)
方法说明 查询活动实例的状态
接口类型 Service API
适用场景 查询活动实例的状态
# 方法定义
/**
 * 查询活动实例的状态
 * @param activityInstID 活动实例ID
 * @return 活动实例的状态
 * @throws WFApiException
 */
public int getActivityInstState(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： int

# 17. queryActivityInstsByActivityId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.queryActivityInstsByActivityId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.queryActivityInstsByActivityId(long, String, PageCond)
方法说明 查询一个流程下的某个活动定义对应的所有活动实例
接口类型 Service API
适用场景 查询特定活动定义的活动实例
# 方法定义
/**
 * 查询一个流程下的某个活动定义对应的所有活动实例
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @param pageCond 分页信息
 * @return 活动实例列表
 * @throws WFApiException
 */
public List<WFActivityInst> queryActivityInstsByActivityId(long processInstID, String activityDefID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFActivityInst>

# 18. queryActivityInstsByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.queryActivityInstsByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.queryActivityInstsByProcessInstId(long, PageCond)
方法说明 查询某个流程下的所有活动实例
接口类型 Service API
适用场景 查询流程下的所有活动实例
# 方法定义
/**
 * 查询某个流程下的所有活动实例
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 活动实例列表
 * @throws WFApiException
 */
public List<WFActivityInst> queryActivityInstsByProcessInstId(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFActivityInst>

# 19. queryNextActInsts 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.queryNextActInsts
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.queryNextActInsts(long)
方法说明 根据活动实例ID，查询后继活动实例
接口类型 Service API
适用场景 查询后继活动实例
# 方法定义
/**
 * 根据活动实例ID，查询后继活动实例
 * @param activityInstID 活动实例ID
 * @return 后继活动实例列表
 * @throws WFApiException
 */
public List<WFActivityInst> queryNextActInsts(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： List<WFActivityInst>

# 20. queryPreviousActivityInsts 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.queryPreviousActivityInsts
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.queryPreviousActivityInsts(long)
方法说明 查询某个活动实例的所有前驱实例
接口类型 Service API
适用场景 查询前驱活动实例
# 方法定义
/**
 * 查询某个活动实例的所有前驱实例
 * @param activityInstID 活动实例ID
 * @return 前驱活动实例列表
 * @throws WFApiException
 */
public List<WFActivityInst> queryPreviousActivityInsts(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： List<WFActivityInst>

# 21. removeActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.removeActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.removeActivityInst(long)
方法说明 根据活动实例ID删除活动实例
接口类型 Service API
适用场景 删除活动实例
# 方法定义
/**
 * 根据活动实例ID删除活动实例
 * @param actInstID 活动实例ID
 * @return 删除结果
 * @throws WFApiException
 */
public int removeActivityInst(long actInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
# 返回值

返回类型： int

# 22. restartActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.restartActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.restartActivityInst(long)
方法说明 重新启动某个活动实例
接口类型 Service API
适用场景 重新启动活动实例
# 方法定义
/**
 * 重新启动某个活动实例
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void restartActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 23. restartActivityInstAndSetRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.restartActivityInstAndSetRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.restartActivityInstAndSetRelativeData(long, Map<String, Object>, boolean)
方法说明 重新启动某个活动实例，并设置相关数据和分割事务开关
接口类型 Service API
适用场景 重新启动活动实例并设置相关数据
# 方法定义
/**
 * 重新启动某个活动实例，并设置相关数据和分割事务开关
 * @param activityInstID 活动实例ID
 * @param map 相关数据
 * @param transactionSpan 是否设置事务分割
 * @throws WFApiException
 */
public void restartActivityInstAndSetRelativeData(long activityInstID, Map<String, Object> map, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
map Map<String, Object> 是 相关数据
transactionSpan boolean 是 是否设置事务分割
# 返回值

返回类型： void

# 24. resumeActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.resumeActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.resumeActivityInst(long)
方法说明 恢复某个活动实例的状态为运行状态
接口类型 Service API
适用场景 恢复活动实例状态
# 方法定义
/**
 * 恢复某个活动实例的状态为运行状态
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void resumeActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 25. setActivityInstAttributeBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.setActivityInstAttributeBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.setActivityInstAttributeBatch(long, Map<String, Object>)
方法说明 批量修改活动实例的基本属性
接口类型 Service API
适用场景 批量修改活动实例属性
# 方法定义
/**
 * 批量修改活动实例的基本属性
 * @param actInstID 活动实例ID
 * @param attrubuteMap 属性映射
 * @throws WFApiException
 */
public void setActivityInstAttributeBatch(long actInstID, Map<String, Object> attrubuteMap) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
attrubuteMap Map<String, Object> 是 属性映射
# 返回值

返回类型： void

# 26. suspendActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.suspendActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.suspendActivityInst(long)
方法说明 挂起某个活动实例
接口类型 Service API
适用场景 挂起活动实例
# 方法定义
/**
 * 挂起某个活动实例
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void suspendActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 27. terminateActivityInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFActivityInstManager.terminateActivityInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFActivityInstManager.terminateActivityInst(long)
方法说明 终止活动实例
接口类型 Service API
适用场景 终止活动实例
# 方法定义
/**
 * 终止活动实例
 * @param activityInstID 活动实例ID
 * @throws WFApiException
 */
public void terminateActivityInst(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： void

# 二、WFCommonManager

# 1. handover 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.handover
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.handover(String, String)
方法说明 将移交人的工作任务移交给接管人
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 将移交人的工作任务移交给接管人
 * @param fromID 移交人id
 * @param toID 接管人id
 * @return WFHandoverResult 移交结果
 * @throws WFApiException API调用异常
 */
public WFHandoverResult handover(String fromID, String toID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromID String 是 移交人id
toID String 是 接管人id
# 返回值

返回类型： WFHandoverResult对象

# 2. handoverWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.handoverWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.handoverWorkItem(String, String, long)
方法说明 将移交人指定的工作交接给接管人
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 将移交人指定的工作交接给接管人
 * @param fromID 移交人id
 * @param toID 接管人id
 * @param defID 流程定义id
 * @throws WFApiException API调用异常
 */
public void handoverWorkItem(String fromID, String toID, long defID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromID String 是 移交人id
toID String 是 接管人id
defID long 是 流程定义id
# 返回值

返回类型： void

# 3. handoverWorkItemBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.handoverWorkItemBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.handoverWorkItemBatch(String, Map<Long, String>)
方法说明 将移交人指定的工作交接给接管人（多组）
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 将移交人指定的工作交接给接管人（多组）
 * @param fromID 移交人id
 * @param toWorkItemMap 接管人工作项Map<接管人ID, 工作项ID>
 * @throws WFApiException API调用异常
 */
public void handoverWorkItemBatch(String fromID, Map<Long, String> toWorkItemMap) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromID String 是 移交人id
toWorkItemMap Map<Long, String> 是 接管人工作项Map<接管人ID, 工作项ID>
# 返回值

返回类型： void

# 4. handoverProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.handoverProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.handoverProcess(String, Map<String, Long>)
方法说明 将移交人的流程定义交接给接管人（多组）
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 将移交人的流程定义交接给接管人（多组）
 * @param fromID 移交人id
 * @param toDefMap 接管人流程定义Map<接管人ID, 流程定义ID>
 * @throws WFApiException API调用异常
 */
public void handoverProcess(String fromID, Map<String, Long> toDefMap) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromID String 是 移交人id
toDefMap Map<String, Long> 是 接管人流程定义Map<接管人ID, 流程定义ID>
# 返回值

返回类型： void

# 5. handoverProcess1 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.handoverProcess1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.handoverProcess1(String, String, long)
方法说明 将移交人的流程定义交接给接管人
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 将移交人的流程定义交接给接管人
 * @param fromID 移交人id
 * @param toID 接管人id
 * @param defID 流程定义id
 * @throws WFApiException API调用异常
 */
public void handoverProcess1(String fromID, String toID, long defID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromID String 是 移交人id
toID String 是 接管人id
defID long 是 流程定义id
# 返回值

返回类型： void

# 6. queryHandoverableProcesses 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.queryHandoverableProcesses
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.queryHandoverableProcesses(String)
方法说明 获得移交人需要移交的流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 获得移交人需要移交的流程定义
 * @param from 移交人id
 * @return List<WFProcessDefine> 流程定义列表
 * @throws WFApiException API调用异常
 */
public List<WFProcessDefine> queryHandoverableProcesses(String from) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
from String 是 移交人id
# 返回值

返回类型： List<WFProcessDefine>对象列表

# 7. startTranHistory 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.startTranHistory
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.startTranHistory()
方法说明 执行历史数据迁移
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 执行历史数据迁移
 * @return int 迁移结果
 * @throws WFApiException API调用异常
 */
public int startTranHistory() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： int整形

# 8. updateBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.updateBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.updateBizInfo(long, Map<String, Object>)
方法说明 更新业务冗余数据
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 更新业务冗余数据
 * @param processInstID 流程实例ID
 * @param bizInfo 冗余数据
 * @throws WFApiException API调用异常
 */
public void updateBizInfo(long processInstID, Map<String, Object> bizInfo) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
bizInfo Map<String, Object> 是 冗余数据
# 返回值

返回类型： void

# 9. deleteBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.deleteBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.deleteBizInfo(long)
方法说明 删除业务冗余数据
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 删除业务冗余数据
 * @param processInstID 流程实例ID
 * @throws WFApiException API调用异常
 */
public void deleteBizInfo(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： void

# 10. batchExecuteApis 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonManager.batchExecuteApis
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonManager.batchExecuteApis(List<BPSApiInvokeInfo>)
方法说明 批量执行BPS流程引擎API调用。在一个事务中执行,要么全部成功执行,要么全部失败
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 批量执行BPS流程引擎API调用。在一个事务中执行,要么全部成功执行,要么全部失败
 * @param invokeInfos 调用信息列表
 * @throws WFApiException API调用异常
 */
public void batchExecuteApis(List<BPSApiInvokeInfo> invokeInfos) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
invokeInfos List 是 调用信息列表
# 返回值

返回类型： void

# 三、WFBizFormManager

# 1. queryBizFormByActInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByActInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByActInstId(long)
方法说明 根据活动实例ID获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据活动实例ID获取业务表单配置信息
 * @param actInstID 活动实例id
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByActInstId(long actInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例id
# 返回值

返回类型： List<WFBizForm>对象列表

# 2. queryBizFormByActInstIdAndType 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByActInstIdAndType
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByActInstIdAndType(long, WFBizFormManagerType)
方法说明 根据活动实例ID，表单类型获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据活动实例ID，表单类型获取业务表单配置信息
 * @param actInstID 活动实例id
 * @param type 表单类型
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByActInstIdAndType(long actInstID, WFBizFormManagerType type) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例id
type WFBizFormManagerType 是 表单类型（值范围：TAB—tab页
BUTTON—按钮）
# 返回值

返回类型： List<WFBizForm>对象列表

# 3. queryBizFormByProcInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByProcInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByProcInstId(long, String)
方法说明 根据流程实例ID，活动定义ID获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据流程实例ID，活动定义ID获取业务表单配置信息
 * @param procInstID 流程实例id
 * @param actDefID 活动定义id
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByProcInstId(long procInstID, String actDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procInstID long 是 流程实例id
actDefID String 是 活动定义id
# 返回值

返回类型： List<WFBizForm>对象列表

# 4. queryBizFormByProcInstIdAndType 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByProcInstIdAndType
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByProcInstIdAndType(long, String, WFBizFormManagerType)
方法说明 根据流程实例ID，活动定义ID，表单类型获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据流程实例ID，活动定义ID，表单类型获取业务表单配置信息
 * @param procInstID 流程实例id
 * @param actDefID 活动定义id
 * @param type 表单类型
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByProcInstIdAndType(long procInstID, String actDefID, WFBizFormManagerType type) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procInstID long 是 流程实例id
actDefID String 是 活动定义id
type WFBizFormManagerType 是 表单类型（值范围：TAB—tab页
BUTTON—按钮）
# 返回值

返回类型： List<WFBizForm>对象列表

# 5. queryBizFormByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByWorkItemId(long)
方法说明 根据工作项ID获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据工作项ID获取业务表单配置信息
 * @param workItemID 工作项id
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByWorkItemId(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
# 返回值

返回类型： List<WFBizForm>对象列表

# 6. queryBizFormByWorkItemIdAndType 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizFormManager.queryBizFormByWorkItemIdAndType
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizFormManager.queryBizFormByWorkItemIdAndType(long, WFBizFormManagerType)
方法说明 根据工作项ID，表单类型获取业务表单配置信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据工作项ID，表单类型获取业务表单配置信息
 * @param workItemID 工作项id
 * @param type 表单类型
 * @return List<WFBizForm> 业务表单配置信息列表
 * @throws WFApiException API调用异常
 */
public List<WFBizForm> queryBizFormByWorkItemIdAndType(long workItemID, WFBizFormManagerType type) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
type WFBizFormManagerType 是 表单类型（值范围：TAB—tab页
BUTTON—按钮）
# 返回值

返回类型： List<WFBizForm>对象列表

# 四、WFBizProcessManager

# 1. queryActivitiesOfBizProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizProcessManager.queryActivitiesOfBizProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizProcessManager.queryActivitiesOfBizProcess(long)
方法说明 根据流程ID查询活动
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据流程ID查询活动
 * @param processDefID 流程定义id
 * @return WFBizResponse 活动信息
 * @throws WFApiException API调用异常
 */
public WFBizResponse queryActivitiesOfBizProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义id
# 返回值

返回类型： WFBizResponse对象

# 2. queryBizProcessByName 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizProcessManager.queryBizProcessByName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizProcessManager.queryBizProcessByName(String)
方法说明 通过业务流程名称和状态查询对应该名称的所有业务流程,支持分页查询
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 通过业务流程名称和状态查询对应该名称的所有业务流程,支持分页查询
 * @param processDefName 流程定义名称
 * @return WFBizResponse 业务流程信息
 * @throws WFApiException API调用异常
 */
public WFBizResponse queryBizProcessByName(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： WFBizResponse对象

# 3. validateBizProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizProcessManager.validateBizProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizProcessManager.validateBizProcess(Long, String)
方法说明 验证流程
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 验证流程
 * @param id 流程定义id
 * @param processXml 流程定义xml
 * @return WFBizResponse 验证结果
 * @throws WFApiException API调用异常
 */
public WFBizResponse validateBizProcess(Long id, String processXml) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
id Long 是 流程定义id
processXml String 是 流程定义xml
# 返回值

返回类型： WFBizResponse对象

# 五、WFAppointActivityManager

# 1. appointActivityParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.appointActivityParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.appointActivityParticipant(long, String, WFParticipant[])
方法说明 指派后继活动的参与者
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 指派后继活动的参与者
 * @param workItemID 工作项id
 * @param activityDefID 活动定义id
 * @param participants 参与者
 * @throws WFApiException API调用异常
 */
public void appointActivityParticipant(long workItemID, String activityDefID, WFParticipant[] participants) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
activityDefID String 是 活动定义id
participants WFParticipant[] 是 参与者
# 返回值

返回类型： void

# 2. appointActivityParticipantByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.appointActivityParticipantByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.appointActivityParticipantByProcessInstId(long, String, WFParticipant[])
方法说明 指派后继活动的参与者（通过流程实例ID）
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 指派后继活动的参与者（通过流程实例ID）
 * @param processInstID 流程实例id
 * @param activityDefID 活动定义id
 * @param participants 参与者
 * @throws WFApiException API调用异常
 */
public void appointActivityParticipantByProcessInstId(long processInstID, String activityDefID, WFParticipant[] participants) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例id
activityDefID String 是 活动定义id
participants WFParticipant[] 是 参与者
# 返回值

返回类型： void

# 3. clearAppointedActivityParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.clearAppointedActivityParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.clearAppointedActivityParticipants(long, String)
方法说明 根据工作项ID和后继活动ID删除某个后继活动已被指定的参与者
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据工作项ID和后继活动ID删除某个后继活动已被指定的参与者
 * @param workItemID 工作项id
 * @param activityDefID 活动定义id
 * @throws WFApiException API调用异常
 */
public void clearAppointedActivityParticipants(long workItemID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
activityDefID String 是 活动定义id
# 返回值

返回类型： void

# 4. clearAppointedParticipantByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.clearAppointedParticipantByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.clearAppointedParticipantByProcessInstId(long, String)
方法说明 根据流程实例ID和后继活动ID删除某个后继活动已被指定的参与者
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据流程实例ID和后继活动ID删除某个后继活动已被指定的参与者
 * @param processInstID 流程实例id
 * @param activityDefID 活动定义id
 * @throws WFApiException API调用异常
 */
public void clearAppointedParticipantByProcessInstId(long processInstID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例id
activityDefID String 是 活动定义id
# 返回值

返回类型： void

# 5. isNeedAppointNextActivityParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.isNeedAppointNextActivityParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.isNeedAppointNextActivityParticipant(long)
方法说明 判断当前工作项操作是否需要为后继活动指派参与者
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 判断当前工作项操作是否需要为后继活动指派参与者
 * @param workItemID 工作项id
 * @return boolean 是否需要指派参与者
 * @throws WFApiException API调用异常
 */
public boolean isNeedAppointNextActivityParticipant(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
# 返回值

返回类型： boolean类型

# 6. queryAppointedActivityParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.queryAppointedActivityParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.queryAppointedActivityParticipants(long, String)
方法说明 查询某工作项后继活动已被指定的参与者
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 查询某工作项后继活动已被指定的参与者
 * @param workItemID 工作项id
 * @param activityDefID 活动定义id
 * @return List<WFParticipant> 参与者列表
 * @throws WFApiException API调用异常
 */
public List<WFParticipant> queryAppointedActivityParticipants(long workItemID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
activityDefID String 是 活动定义id
# 返回值

返回类型： List<WFParticipant>对象列表

# 7. queryNextActivitesNeedAppointParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFAppointActivityManager.queryNextActivitesNeedAppointParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAppointActivityManager.queryNextActivitesNeedAppointParticipant(long)
方法说明 返回指定工作项ID对应活动的所有需要指派参与者的后继活动列表
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 返回指定工作项ID对应活动的所有需要指派参与者的后继活动列表
 * @param workItemID 工作项id
 * @return List<WFActivityDefine> 后继活动列表
 * @throws WFApiException API调用异常
 */
public List<WFActivityDefine> queryNextActivitesNeedAppointParticipant(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项id
# 返回值

返回类型： List<WFActivityDefine>对象列表

# 六、WFCalendarManager

# 1. getElapsedTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFCalendarManager.getElapsedTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCalendarManager.getElapsedTime(String, long, long)
方法说明 根据日历ID,计算使用该日历情况下，某时间段内的工作时间数
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据日历ID,计算使用该日历情况下，某时间段内的工作时间数
 * @param calendarUuid 工作日历id编号
 * @param startTime 开始时间
 * @param finalTime 结束时间
 * @return long 工作时间数
 * @throws WFApiException API调用异常
 */
public long getElapsedTime(String calendarUuid, long startTime, long finalTime) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
calendarUuid String 是 工作日历id编号
startTime long 是 开始时间
finalTime long 是 结束时间
# 返回值

返回类型： long整形

# 2. getFinalTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFCalendarManager.getFinalTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCalendarManager.getFinalTime(String, long, long)
方法说明 获取超时时间
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 获取超时时间
 * @param calendarUuid 工作日历id编号
 * @param startTime 开始时间
 * @param timeInterval 时间限制值
 * @return long 超时时间
 * @throws WFApiException API调用异常
 */
public long getFinalTime(String calendarUuid, long startTime, long timeInterval) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
calendarUuid String 是 工作日历id编号
startTime long 是 开始时间
timeInterval long 是 时间限制值
# 返回值

返回类型： long整形

# 3. getNextDay 方法接口文档

# 基本信息
项目 说明
接口名称 WFCalendarManager.getNextDay
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCalendarManager.getNextDay(Date, int, String)
方法说明 计算距离某个日期后N个工作日的日期，计算不包括当天
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 计算距离某个日期后N个工作日的日期，计算不包括当天
 * @param currentDay 当前时间
 * @param nextDays 距离的天数不包括当天
 * @param caleUuid 工作日历id编号
 * @return Date 日期
 * @throws WFApiException API调用异常
 */
public Date getNextDay(Date currentDay, int nextDays, String caleUuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentDay Date 是 当前时间
nextDays int 是 距离的天数不包括当天
caleUuid String 是 工作日历id编号
# 返回值

返回类型： Date对象

# 4. getPreviousDay 方法接口文档

# 基本信息
项目 说明
接口名称 WFCalendarManager.getPreviousDay
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCalendarManager.getPreviousDay(Date, int, String)
方法说明 计算距离某个日期前N个工作日的日期，计算不包括当天
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 计算距离某个日期前N个工作日的日期，计算不包括当天
 * @param currentDay 当前时间
 * @param previousDays 距离的天数不包括当天
 * @param caleUuid 工作日历id编号
 * @return Date 日期
 * @throws WFApiException API调用异常
 */
public Date getPreviousDay(Date currentDay, int previousDays, String caleUuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentDay Date 是 当前时间
previousDays int 是 距离的天数不包括当天
caleUuid String 是 工作日历id编号
# 返回值

返回类型： Date对象

# 5. getPreviousTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFCalendarManager.getPreviousTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCalendarManager.getPreviousTime(String, long, long)
方法说明 获取开始时间之前的时间点
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 获取开始时间之前的时间点
 * @param calendarUuid 工作日历id编号
 * @param startTime 开始时间
 * @param timeInterval 时间限制值
 * @return long 时间点
 * @throws WFApiException API调用异常
 */
public long getPreviousTime(String calendarUuid, long startTime, long timeInterval) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
calendarUuid String 是 工作日历id编号
startTime long 是 开始时间
timeInterval long 是 时间限制值
# 返回值

返回类型： long整形

# 七、WFBusinessCatalogManager

# 1. deleteCatalogInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFBusinessCatalogManager.deleteCatalogInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBusinessCatalogManager.deleteCatalogInfo(String)
方法说明 删除指定业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 删除指定业务目录
 * @param uuid UUID
 * @return int 删除结果
 * @throws WFApiException API调用异常
 */
public int deleteCatalogInfo(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 UUID
# 返回值

返回类型： int整形

# 2. findCatalogInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFBusinessCatalogManager.findCatalogInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBusinessCatalogManager.findCatalogInfo(String)
方法说明 根据ID查询业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据ID查询业务目录
 * @param uuid UUID
 * @return WFBizCatalog 业务目录信息
 * @throws WFApiException API调用异常
 */
public WFBizCatalog findCatalogInfo(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 UUID
# 返回值

返回类型： WFBizCatalog对象

# 3. queryCatalogInfos 方法接口文档

# 基本信息
项目 说明
接口名称 WFBusinessCatalogManager.queryCatalogInfos
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBusinessCatalogManager.queryCatalogInfos(WFBizCatalog)
方法说明 查询符合条件的业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 查询符合条件的业务目录
 * @param bizCatalog 业务目录
 * @return List<WFBizCatalog> 业务目录列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalog> queryCatalogInfos(WFBizCatalog bizCatalog) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizCatalog WFBizCatalog 是 业务目录
# 返回值

返回类型： List<WFBizCatalog>对象列表

# 4. querySubCatalogs 方法接口文档

# 基本信息
项目 说明
接口名称 WFBusinessCatalogManager.querySubCatalogs
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBusinessCatalogManager.querySubCatalogs(String, String, String, boolean)
方法说明 通过业务目录ID(CatalogID)查询下级业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 通过业务目录ID(CatalogID)查询下级业务目录
 * @param personID 人员ID
 * @param authType 权限类型
 * @param parentCatalogID 父业务目录
 * @param multilevel 是否嵌套查询
 * @return List<WFBusinessCatalog> 下级业务目录列表
 * @throws WFApiException API调用异常
 */
public List<WFBusinessCatalog> querySubCatalogs(String personID, String authType, String parentCatalogID, boolean multilevel) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
authType String 是 权限类型
parentCatalogID String 是 父业务目录
multilevel boolean 是 是否嵌套查询
# 返回值

返回类型： List<WFBusinessCatalog>对象列表

# 5. saveCatalogInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFBusinessCatalogManager.saveCatalogInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBusinessCatalogManager.saveCatalogInfo(WFBizCatalog)
方法说明 保存业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 保存业务目录
 * @param bizCatalog 业务目录
 * @return String 保存结果
 * @throws WFApiException API调用异常
 */
public String saveCatalogInfo(WFBizCatalog bizCatalog) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizCatalog WFBizCatalog 是 业务目录
# 返回值

返回类型： String对象

# 八、WFAgentManager

# 1. addCandidate 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.addCandidate
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.addCandidate(String, WFParticipant[])
方法说明 增加委托人的候选人范围
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 增加委托人的候选人范围
 * @param personID 委托人id
 * @param agentToList 代理人列表
 * @return int 增加结果
 * @throws WFApiException API调用异常
 */
public int addCandidate(String personID, WFParticipant[] agentToList) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 委托人id
agentToList WFParticipant[] 是 代理人列表
# 返回值

返回类型： int整形

# 2. clearAgentItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.clearAgentItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.clearAgentItem(long)
方法说明 清理某个代理关系的代理项信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 清理某个代理关系的代理项信息
 * @param agentID 代理关系id
 * @throws WFApiException API调用异常
 */
public void clearAgentItem(long agentID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long 是 代理关系id
# 返回值

返回类型： void

# 3. createAgent 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.createAgent
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.createAgent(String, WFParticipant[], String, Date, Date, WFAgentItem[], String)
方法说明 创建代理关系
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 创建代理关系
 * @param agentFrom 委托人ID
 * @param agentTo 代理人
 * @param agentType 代理方式
 * @param startTime 开始时间
 * @param endTime 结束时间
 * @param agentItemList 代理项列表
 * @param agentReason 代理原因
 * @return List<Long> 代理关系ID列表
 * @throws WFApiException API调用异常
 */
public List<Long> createAgent(String agentFrom, WFParticipant[] agentTo, String agentType, Date startTime, Date endTime, WFAgentItem[] agentItemList, String agentReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentFrom String 是 委托人ID
agentTo WFParticipant[] 是 代理人
agentType String 是 代理方式
startTime Date 是 开始时间
endTime Date 是 结束时间
agentItemList WFAgentItem[] 是 代理项列表
agentReason String 是 代理原因
# 返回值

返回类型： List<Long>对象列表

# 4. deleteAgentBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.deleteAgentBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.deleteAgentBatch(long[])
方法说明 批量删除多个代理关系
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 批量删除多个代理关系
 * @param agentID 代理关系id数组
 * @return int 删除结果
 * @throws WFApiException API调用异常
 */
public int deleteAgentBatch(long[] agentID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long[] 是 代理关系id数组
# 返回值

返回类型： int整形

# 5. deleteCandidate 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.deleteCandidate
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.deleteCandidate(String, WFParticipant[])
方法说明 删除委托人的代理候选人范围
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 删除委托人的代理候选人范围
 * @param personID 委托人ID
 * @param agentToList 代理人列表
 * @return int 删除结果
 * @throws WFApiException API调用异常
 */
public int deleteCandidate(String personID, WFParticipant[] agentToList) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 委托人ID
agentToList WFParticipant[] 是 代理人列表
# 返回值

返回类型： int整形

# 6. modifyAgent 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.modifyAgent
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.modifyAgent(long, String, WFParticipant, Date, Date, String)
方法说明 修改指定的代理关系
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 修改指定的代理关系
 * @param agentID 代理关系id
 * @param agentFromID 委托人id
 * @param agentTo 代理人
 * @param startTime 开始时间
 * @param endTime 结束时间
 * @param agentReason 代理原因
 * @return int 修改结果
 * @throws WFApiException API调用异常
 */
public int modifyAgent(long agentID, String agentFromID, WFParticipant agentTo, Date startTime, Date endTime, String agentReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long 是 代理关系id
agentFromID String 是 委托人id
agentTo WFParticipant 是 代理人
startTime Date 是 开始时间
endTime Date 是 结束时间
agentReason String 是 代理原因
# 返回值

返回类型： int整形

# 7. modifyAgentItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.modifyAgentItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.modifyAgentItem(long, String, WFAgentItem[])
方法说明 修改指定代理关系的代理项
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 修改指定代理关系的代理项
 * @param agentID 代理关系id
 * @param type 操作类型
 * @param agentItemList 代理项列表
 * @return int 修改结果
 * @throws WFApiException API调用异常
 */
public int modifyAgentItem(long agentID, String type, WFAgentItem[] agentItemList) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long 是 代理关系id
type String 是 操作类型
agentItemList WFAgentItem[] 是 代理项列表
# 返回值

返回类型： int整形

# 8. queryAgentsByAgentFrom 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.queryAgentsByAgentFrom
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.queryAgentsByAgentFrom(String)
方法说明 根据委托人ID查询所有代理关系
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据委托人ID查询所有代理关系
 * @param agentFrom 委托人id
 * @return List<WFAgent> 代理关系列表
 * @throws WFApiException API调用异常
 */
public List<WFAgent> queryAgentsByAgentFrom(String agentFrom) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentFrom String 是 委托人id
# 返回值

返回类型： List<WFAgent>对象列表

# 9. queryAgentsByAgentTo 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.queryAgentsByAgentTo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.queryAgentsByAgentTo(String, boolean)
方法说明 根据代理人ID查询所有代理关系
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据代理人ID查询所有代理关系
 * @param agentTo 代理人ID
 * @param whole 是否全部
 * @return List<WFAgent> 代理关系列表
 * @throws WFApiException API调用异常
 */
public List<WFAgent> queryAgentsByAgentTo(String agentTo, boolean whole) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentTo String 是 代理人ID
whole boolean 是 是否全部
# 返回值

返回类型： List<WFAgent>对象列表

# 10. queryAgentCandidates 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.queryAgentCandidates
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.queryAgentCandidates(String, boolean)
方法说明 根据委托人ID查询代理候选人范围
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据委托人ID查询代理候选人范围
 * @param agentFrom 委托人id
 * @param flatToLeaf 是否查询到叶子节点
 * @return List<WFParticipant> 代理候选人列表
 * @throws WFApiException API调用异常
 */
public List<WFParticipant> queryAgentCandidates(String agentFrom, boolean flatToLeaf) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentFrom String 是 委托人id
flatToLeaf boolean 是 是否查询到叶子节点
# 返回值

返回类型： List<WFParticipant>对象列表

# 11. queryAgentDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.queryAgentDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.queryAgentDetail(long)
方法说明 根据代理关系ID查询代理关系的详细信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据代理关系ID查询代理关系的详细信息
 * @param agentID 代理关系id
 * @return WFAgent 代理关系详细信息
 * @throws WFApiException API调用异常
 */
public WFAgent queryAgentDetail(long agentID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long 是 代理关系id
# 返回值

返回类型： WFAgent对象

# 12. queryAgentItemsByAgentId 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.queryAgentItemsByAgentId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.queryAgentItemsByAgentId(long)
方法说明 根据代理关系ID查询代理的流程，活动（部分代理）或者例外的流程（完全代理）
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据代理关系ID查询代理的流程，活动（部分代理）或者例外的流程（完全代理）
 * @param agentID 代理关系id
 * @return List<WFAgentItem> 代理项列表
 * @throws WFApiException API调用异常
 */
public List<WFAgentItem> queryAgentItemsByAgentId(long agentID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
agentID long 是 代理关系id
# 返回值

返回类型： List<WFAgentItem>对象列表

# 13. resetCandidate 方法接口文档

# 基本信息
项目 说明
接口名称 WFAgentManager.resetCandidate
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFAgentManager.resetCandidate(String)
方法说明 重置候选人范围
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 重置候选人范围
 * @param personID 候选人
 * @return int 重置结果
 * @throws WFApiException API调用异常
 */
public int resetCandidate(String personID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 候选人
# 返回值

返回类型： int整形

# 九、WFBackActivityManager

# 1. backActivity2 方法接口文档

# 基本信息
项目 说明
接口名称 WFBackActivityManager.backActivity2
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBackActivityManager.backActivity2(long, long, String)
方法说明 根据某策略回退到某活动
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据某策略回退到某活动
 * @param currentActInstID 当前活动实例id
 * @param destActInstID 要回退到的目标活动实例ID
 * @param rollBackStrategy 回退策略
 * @throws WFApiException API调用异常
 */
public void backActivity2(long currentActInstID, long destActInstID, String rollBackStrategy) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentActInstID long 是 当前活动实例id
destActInstID long 是 要回退到的目标活动实例ID
rollBackStrategy String 是 回退策略（值范围：time—基于两点间的时间回退
path—基于两点间的路径回退
simple—简单回退
recent_manual—回退到最近的人工活动
one_step—单步回退）
# 返回值

返回类型： void

# 2. backActivity3 方法接口文档

# 基本信息
项目 说明
接口名称 WFBackActivityManager.backActivity3
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBackActivityManager.backActivity3(long, String, String)
方法说明 根据某策略回退到某活动
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据某策略回退到某活动
 * @param currentActInstID 当前活动实例id
 * @param destActDefID 要回退到的目标活动定义ID
 * @param rollBackStrategy 回退策略
 * @throws WFApiException API调用异常
 */
public void backActivity3(long currentActInstID, String destActDefID, String rollBackStrategy) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentActInstID long 是 当前活动实例id
destActDefID String 是 要回退到的目标活动定义ID
rollBackStrategy String 是 回退策略（值范围：time—基于两点间的时间回退
path—基于两点间的路径回退
simple—简单回退
recent_manual—回退到最近的人工活动
one_step—单步回退）
# 返回值

返回类型： void

# 3. backActivity1 方法接口文档

# 基本信息
项目 说明
接口名称 WFBackActivityManager.backActivity1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBackActivityManager.backActivity1(long, String, String, String)
方法说明 根据某策略回退到某活动
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据某策略回退到某活动
 * @param currentActInstID 当前活动实例id
 * @param destActDefID 要回退到的
 * @param rollBackStrategy 回退策略
 * @param backReason 回退原因
 * @throws WFApiException API调用异常
 */
public void backActivity1(long currentActInstID, String destActDefID, String rollBackStrategy, String backReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentActInstID long 是 当前活动实例id
destActDefID String 是 要回退到的目标活动定义ID
rollBackStrategy String 是 回退策略（值范围：time—基于两点间的时间回退
path—基于两点间的路径回退
simple—简单回退
recent_manual—回退到最近的人工活动
one_step—单步回退）
backReason String 是 回退原因
# 返回值

返回类型： void

# 4. getPreviousActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFBackActivityManager.getPreviousActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBackActivityManager.getPreviousActivities(long, String)
方法说明 根据某策略回退到某活动，获取当前实例到目标活动定义之间所有运行时经过的活动定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据某策略回退到某活动，获取当前实例到目标活动定义之间所有运行时经过的活动定义
 * @param currentActInstID 当前活动实例id
 * @param destActDefID 要回退到的目标活动定义ID
 * @throws WFApiException API调用异常
 */
public void getPreviousActivities(long currentActInstID, String destActDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
currentActInstID long 是 当前活动实例id
destActDefID String 是 要回退到的目标活动定义ID
# 返回值

返回类型： void

# 十、WFBizCatalog4PermManager

# 1. getCatalogRootByUserId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.getCatalogRootByUserId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.getCatalogRootByUserId(String, String)
方法说明 根据用户ID和权限类型查找根业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据用户ID和权限类型查找根业务目录
 * @param userId 用户id
 * @param permType 权限类型
 * @return List<WFBizCatalog> 根业务目录列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalog> getCatalogRootByUserId(String userId, String permType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userId String 是 用户id
permType String 是 权限类型
# 返回值

返回类型： List<WFBizCatalog>对象列表

# 2. getCatalogSubByUserId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.getCatalogSubByUserId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.getCatalogSubByUserId(String, String, String)
方法说明 根据用户ID、权限类型、父目录ID查找根业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据用户ID、权限类型、父目录ID查找根业务目录
 * @param userId 用户id
 * @param permType 权限类型
 * @param parentId 父目录id
 * @return List<WFBizCatalog> 子业务目录列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalog> getCatalogSubByUserId(String userId, String permType, String parentId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userId String 是 用户id
permType String 是 权限类型
parentId String 是 父目录id
# 返回值

返回类型： List<WFBizCatalog>对象列表

# 3. getAllSubCatalogByUserId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.getAllSubCatalogByUserId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.getAllSubCatalogByUserId(String, String, String)
方法说明 根据用户ID、权限类型、父目录ID查找所有子业务目录
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据用户ID、权限类型、父目录ID查找所有子业务目录
 * @param userId 用户id
 * @param permType 权限类型
 * @param parentId 父目录id
 * @return List<WFBizCatalog> 所有子业务目录列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalog> getAllSubCatalogByUserId(String userId, String permType, String parentId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userId String 是 用户id
permType String 是 权限类型
parentId String 是 父目录id
# 返回值

返回类型： List<WFBizCatalog>对象列表

# 4. expandCatalogInfo4Perm 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.expandCatalogInfo4Perm
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.expandCatalogInfo4Perm(String, String, WFBizCatalog)
方法说明 查找一条业务目录，包含权限信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 查找一条业务目录，包含权限信息
 * @param userId 用户id
 * @param permType 权限类型
 * @param catalog 业务目录
 * @return WFBizCatalog 包含权限信息的业务目录
 * @throws WFApiException API调用异常
 */
public WFBizCatalog expandCatalogInfo4Perm(String userId, String permType, WFBizCatalog catalog) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userId String 是 用户id
permType String 是 权限类型
catalog WFBizCatalog 是 业务目录
# 返回值

返回类型： WFBizCatalog对象

# 5. getAllCatalogPermByParti 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.getAllCatalogPermByParti
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.getAllCatalogPermByParti(String, String)
方法说明 根据参与者ID和类型,权限类型,获取所有业务目录权限
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据参与者ID和类型,权限类型,获取所有业务目录权限
 * @param partiId 参与者id
 * @param partiType 参与者类型
 * @return List<WFBizCatalogPerm> 所有业务目录权限列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalogPerm> getAllCatalogPermByParti(String partiId, String partiType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
partiId String 是 参与者id
partiType String 是 参与者类型
# 返回值

返回类型： List<WFBizCatalogPerm>对象列表

# 6. getAllCatalogPermByUserId 方法接口文档

# 基本信息
项目 说明
接口名称 WFBizCatalog4PermManager.getAllCatalogPermByUserId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFBizCatalog4PermManager.getAllCatalogPermByUserId(String, String)
方法说明 根据用户ID,获取所有业务目录权限
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据用户ID,获取所有业务目录权限
 * @param userId 用户id
 * @param permType 权限类型
 * @return List<WFBizCatalogPerm> 所有业务目录权限列表
 * @throws WFApiException API调用异常
 */
public List<WFBizCatalogPerm> getAllCatalogPermByUserId(String userId, String permType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userId String 是 用户id
permType String 是 权限类型
# 返回值

返回类型： List<WFBizCatalogPerm>对象列表

# 十一、WFCommonRemoteManager

# 1. call 方法接口文档

# 基本信息
项目 说明
接口名称 WFCommonRemoteManager.call
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFCommonRemoteManager.call(String, Object)
方法说明 调用通用远程接口
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 调用通用远程接口
 * @param type 类型
 * @param para 参数
 * @return 返回结果
 * @throws WFApiException
 */
public Object call(String type, Object para) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
type String 是 类型
para Object 是 参数
# 返回值

返回类型： Object（返回结果）

# 十二、WFDefinitionDeployeeManager

# 1. deleteProcessById 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.deleteProcessById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.deleteProcessById(long, boolean)
方法说明 根据流程定义ID删除流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 根据流程定义ID删除流程定义
 * @param processDefID 流程定义ID
 * @param isDelProcessInst 是否删除流程实例
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteProcessById(long processDefID, boolean isDelProcessInst) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
isDelProcessInst boolean 是 是否删除流程实例
# 返回值

返回类型： int（删除结果）

# 2. deleteProcessesByName 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.deleteProcessesByName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.deleteProcessesByName(String, boolean)
方法说明 删除各版本具有相同名称的流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 删除各版本具有相同名称的流程定义
 * @param processDefName 流程定义名称
 * @param isDelProcessInst 是否删除流程实例
 * @return 删除结果
 * @throws WFApiException
 */
public long deleteProcessesByName(String processDefName, boolean isDelProcessInst) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
isDelProcessInst boolean 是 是否删除流程实例
# 返回值

返回类型： long（删除结果）

# 3. deployProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.deployProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.deployProcess(String, String, String, String, WFDeployeeOption)
方法说明 部署流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 部署流程定义
 * @param xmlString XML字符串
 * @param processDefName 流程定义名称
 * @param version 版本号
 * @param catalogUUID 业务目录ID
 * @param option 部署信息
 * @return 部署结果
 * @throws WFApiException
 */
public String deployProcess(String xmlString, String processDefName, String version, String catalogUUID, WFDeployeeOption option) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
xmlString String 是 XML字符串
processDefName String 是 流程定义名称
version String 是 版本号
catalogUUID String 是 业务目录ID
option WFDeployeeOption 是 部署信息
# 返回值

返回类型： String（部署结果）

# 4. deployProcess1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.deployProcess1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.deployProcess1(String, String, String, WFDeployeeOption)
方法说明 部署流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 部署流程定义
 * @param xmlString XML字符串
 * @param processDefName 流程定义名称
 * @param version 版本号
 * @param option 部署信息
 * @return 部署结果
 * @throws WFApiException
 */
public String deployProcess1(String xmlString, String processDefName, String version, WFDeployeeOption option) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
xmlString String 是 XML字符串
processDefName String 是 流程定义名称
version String 是 版本号
option WFDeployeeOption 是 部署信息
# 返回值

返回类型： String（部署结果）

# 5. refreshBizResourceCache 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.refreshBizResourceCache
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.refreshBizResourceCache(String[])
方法说明 批量更新业务资源定义缓存
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 批量更新业务资源定义缓存
 * @param bizResourceUUIDs 业务资源定义ID数组
 * @return 更新结果
 * @throws WFApiException
 */
public boolean refreshBizResourceCache(String[] bizResourceUUIDs) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizResourceUUIDs String[] 是 业务资源定义ID数组
# 返回值

返回类型： boolean（更新结果）

# 6. refreshProcessDefCache 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.refreshProcessDefCache
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.refreshProcessDefCache(long[])
方法说明 批量更新业务流程定义缓存
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 批量更新业务流程定义缓存
 * @param procDefIDs 流程定义ID数组
 * @return 更新结果
 * @throws WFApiException
 */
public boolean refreshProcessDefCache(long[] procDefIDs) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefIDs long[] 是 流程定义ID数组
# 返回值

返回类型： boolean（更新结果）

# 7. updateProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.updateProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.updateProcess(long, String)
方法说明 更新流程定义
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 更新流程定义
 * @param procDefID 流程定义ID
 * @param xmlString XML字符串
 * @return 更新结果
 * @throws WFApiException
 */
public WFValidateResponse updateProcess(long procDefID, String xmlString) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefID long 是 流程定义ID
xmlString String 是 XML字符串
# 返回值

返回类型： WFValidateResponse（更新结果）

# 8. updateProcessCatalogUuid 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.updateProcessCatalogUuid
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.updateProcessCatalogUuid(long, String)
方法说明 更新流程定义对应的业务目录ID
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 更新流程定义对应的业务目录ID
 * @param procDefID 流程定义ID
 * @param catalogUUID 业务目录ID
 * @return 更新结果
 * @throws WFApiException
 */
public boolean updateProcessCatalogUuid(long procDefID, String catalogUUID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefID long 是 流程定义ID
catalogUUID String 是 业务目录ID
# 返回值

返回类型： boolean（更新结果）

# 9. updateProcessDefinesApp 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.updateProcessDefinesApp
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.updateProcessDefinesApp(String[], AppInfo, AppInfo)
方法说明 更新流程定义的应用信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 更新流程定义的应用信息
 * @param processDefNames 流程定义名称数组
 * @param oldApp 旧应用信息
 * @param newApp 新应用信息
 * @throws WFApiException
 */
public void updateProcessDefinesApp(String[] processDefNames, AppInfo oldApp, AppInfo newApp) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefNames String[] 是 流程定义名称数组
oldApp AppInfo 是 旧应用信息
newApp AppInfo 是 新应用信息
# 返回值

返回类型： void（无返回值）

# 10. setBizProcessDefParticipantRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.setBizProcessDefParticipantRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.setBizProcessDefParticipantRule(long, String, String, String, String, Boolean, String)
方法说明 设置流程定义参与者规则
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 设置流程定义参与者规则
 * @param procDefId 流程定义ID
 * @param processDefName 流程定义名称
 * @param versionSign 版本标识
 * @param actDefId 活动定义ID
 * @param participantRule 参与者规则
 * @param newVersion 是否为新版本
 * @param desc 描述
 * @return 设置结果
 * @throws WFApiException
 */
public WFValidateResponse setBizProcessDefParticipantRule(long procDefId, String processDefName, String versionSign, String actDefId, String participantRule, Boolean newVersion, String desc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefId long 是 流程定义ID
processDefName String 是 流程定义名称
versionSign String 是 版本标识
actDefId String 是 活动定义ID
participantRule String 是 参与者规则
newVersion Boolean 是 是否为新版本
desc String 是 描述
# 返回值

返回类型： WFValidateResponse（设置结果）

# 11. addProcessStarter 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.addProcessStarter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.addProcessStarter(String, String, WFParticipant[])
方法说明 添加业务流程定义的启动者权限
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 添加业务流程定义的启动者权限
 * @param processDefName 流程定义名称
 * @param catalogUuid 业务目录UUID
 * @param starter 启动者权限
 * @throws WFApiException
 */
public void addProcessStarter(String processDefName, String catalogUuid, WFParticipant[] starter) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
catalogUuid String 是 业务目录UUID
starter WFParticipant[] 是 启动者权限
# 返回值

返回类型： void（无返回值）

# 12. deleteProcessStarter 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.deleteProcessStarter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.deleteProcessStarter(String, WFParticipant[])
方法说明 删除业务流程定义的启动者权限
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 删除业务流程定义的启动者权限
 * @param processDefName 流程定义名称
 * @param starter 启动者权限
 * @throws WFApiException
 */
public void deleteProcessStarter(String processDefName, WFParticipant[] starter) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
starter WFParticipant[] 是 启动者权限
# 返回值

返回类型： void（无返回值）

# 13. setProcessDefExtendAttributes 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.setProcessDefExtendAttributes
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.setProcessDefExtendAttributes(long, String, String, String, ExtendedAttribute[], Boolean, Boolean)
方法说明 设置某流程定义中某活动定义扩展属性
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 设置某流程定义中某活动定义扩展属性
 * @param procDefId 流程定义ID
 * @param processDefName 流程定义名称
 * @param versionSign 版本标识
 * @param actDefId 活动定义ID
 * @param attributes 扩展属性
 * @param newVersion 是否为新版本
 * @param isAllCover 是否覆盖所有
 * @return 设置结果
 * @throws WFApiException
 */
public WFValidateResponse setProcessDefExtendAttributes(long procDefId, String processDefName, String versionSign, String actDefId, ExtendedAttribute[] attributes, Boolean newVersion, Boolean isAllCover) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefId long 是 流程定义ID
processDefName String 是 流程定义名称
versionSign String 是 版本标识
actDefId String 是 活动定义ID
attributes ExtendedAttribute[] 是 扩展属性
newVersion Boolean 是 是否为新版本
isAllCover Boolean 是 是否覆盖所有
# 返回值

返回类型： WFValidateResponse（设置结果）

# 14. updateAppTenants 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionDeployeeManager.updateAppTenants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionDeployeeManager.updateAppTenants(AppInfo, AppInfo)
方法说明 更新流程定义的应用信息
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 更新流程定义的应用信息
 * @param oldApp 旧应用信息
 * @param newApp 新应用信息
 * @throws WFApiException
 */
public void updateAppTenants(AppInfo oldApp, AppInfo newApp) throws WFApiException;
# 参数说明java
参数名 类型 必须 说明
oldApp AppInfo 是 旧应用信息
newApp AppInfo 是 新应用信息
# 返回值

返回类型： void（无返回值）

# 十三、WFDefinitionPublishManager

# 1. publishProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionPublishManager.publishProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionPublishManager.publishProcess(long)
方法说明 发布某流程定义模板的指定版本
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 发布某流程定义模板的指定版本
 * @param processDefID 流程定义ID
 * @throws WFApiException
 */
public void publishProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： void（无返回值）

# 2. unpublishProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionPublishManager.unpublishProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionPublishManager.unpublishProcess(long)
方法说明 取消某流程定义的发布
接口类型 Service API（SDK接口）
适用场景 业务系统内部调用、服务间调用
# 方法定义
/**
 * 取消某流程定义的发布
 * @param processDefID 流程定义ID
 * @throws WFApiException
 */
public void unpublishProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： void（无返回值）

# 十四、WFDefinitionQueryManager

# 1. getActivity 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getActivity
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getActivity
方法说明 获取某业务流程中某个活动定义的基本信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中的活动定义信息
# 方法定义
/**
 * 获取某业务流程中某个活动定义的基本信息
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return WFActivityDefine 活动定义对象
 * @throws WFApiException 如果发生API异常
 */
public WFActivityDefine getActivity(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： WFActivityDefine对象

# 2. getActivityForm 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getActivityForm
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getActivityForm
方法说明 获取活动的表单设置
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中活动定义的表单设置
# 方法定义
/**
 * 获取活动的表单设置
 * @param processDefID 流程定义ID
 * @param actDefID 活动定义ID
 * @return WFForm 活动表单对象
 * @throws WFApiException 如果发生API异常
 */
public WFForm getActivityForm(long processDefID, String actDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
actDefID String 是 活动定义ID
# 返回值

返回类型： WFForm对象

# 3. getActivityParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getActivityParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getActivityParticipants
方法说明 获取活动的参与者列表
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中活动定义的参与者
# 方法定义
/**
 * 获取活动的参与者列表
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @param flatToLeaf 是否查询到叶子节点
 * @return List<WFParticipant> 参与者列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFParticipant> getActivityParticipants(long processDefID, String activityDefID, boolean flatToLeaf) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
flatToLeaf boolean 是 是否查询到叶子节点
# 返回值

返回类型： List<WFParticipant>对象

# 4. getExtendAttribute 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getExtendAttribute
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getExtendAttribute
方法说明 获取业务流程或活动定义的扩展属性XML字符串
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程或活动定义的扩展属性
# 方法定义
/**
 * 获取业务流程或活动定义的扩展属性XML字符串
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return String 扩展属性XML字符串
 * @throws WFApiException 如果发生API异常
 */
public String getExtendAttribute(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： String对象

# 5. getPackages 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getPackages
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getPackages
方法说明 获取所有的工作流业务构件包列表
接口类型 Service API（SDK接口）
适用场景 查询所有的工作流业务构件包
# 方法定义
/**
 * 获取所有的工作流业务构件包列表
 * @return List<WFPackage> 构件包列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFPackage> getPackages() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： List<WFPackage>对象

# 6. getProcess1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcess1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcess1
方法说明 通过业务流程ID获取整个业务流程
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的详细信息
# 方法定义
/**
 * 通过业务流程ID获取整个业务流程
 * @param processDefID 流程定义ID
 * @return String 业务流程定义
 * @throws WFApiException 如果发生API异常
 */
public String getProcess1(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： String对象

# 7. getProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcess
方法说明 通过业务流程名称和版本号获取整个业务流程
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的详细信息
# 方法定义
/**
 * 通过业务流程名称和版本号获取整个业务流程
 * @param processDefName 流程定义名称
 * @param version 版本号
 * @return String 业务流程定义
 * @throws WFApiException 如果发生API异常
 */
public String getProcess(String processDefName, String version) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
version String 是 版本号
# 返回值

返回类型： String对象

# 8. getProcessRefBizVars 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcessRefBizVars
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcessRefBizVars
方法说明 获取流程定义的业务变量的定义
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的业务变量定义
# 方法定义
/**
 * 获取流程定义的业务变量的定义
 * @param processDefID 流程定义ID
 * @return List<String> 业务变量定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<String> getProcessRefBizVars(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： List<String>对象

# 9. getProcessRefBizVarXpathByName 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcessRefBizVarXpathByName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcessRefBizVarXpathByName
方法说明 根据变量名称获取流程定义的业务变量的XPATH
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中业务变量的XPATH
# 方法定义
/**
 * 根据变量名称获取流程定义的业务变量的XPATH
 * @param processDefID 流程定义ID
 * @param name 变量名称
 * @return String 业务变量的XPATH
 * @throws WFApiException 如果发生API异常
 */
public String getProcessRefBizVarXpathByName(long processDefID, String name) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
name String 是 变量名称
# 返回值

返回类型： String对象

# 10. getStartActivity 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getStartActivity
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getStartActivity
方法说明 获取某业务流程中开始活动定义的基本信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的开始活动定义信息
# 方法定义
/**
 * 获取某业务流程中开始活动定义的基本信息
 * @param processDefID 流程定义ID
 * @return WFActivityDefine 开始活动定义对象
 * @throws WFApiException 如果发生API异常
 */
public WFActivityDefine getStartActivity(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： WFActivityDefine对象

# 11. hasPublishedProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.hasPublishedProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.hasPublishedProcess
方法说明 判断某业务流程是否存在发布的版本
接口类型 Service API（SDK接口）
适用场景 检查特定业务流程是否有发布的版本
# 方法定义
/**
 * 判断某业务流程是否存在发布的版本
 * @param processDefName 流程定义名称
 * @return boolean 是否存在发布的版本
 * @throws WFApiException 如果发生API异常
 */
public boolean hasPublishedProcess(String processDefName) throws WFApiException;
# 参数说明java
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： boolean对象

# 12. queryActivitiesOfProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryActivitiesOfProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryActivitiesOfProcess
方法说明 查询某业务流程中的所有活动定义
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中的所有活动定义
# 方法定义
/**
 * 查询某业务流程中的所有活动定义
 * @param processDefID 流程定义ID
 * @return List<WFActivityDefine> 活动定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFActivityDefine> queryActivitiesOfProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： List<WFActivityDefine>对象

# 13. queryActivityAllBizResource 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryActivityAllBizResource
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryActivityAllBizResource
方法说明 获取业务流程活动定义绑定的全部业务资源列表
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程活动定义绑定的全部业务资源
# 方法定义
/**
 * 获取业务流程活动定义绑定的全部业务资源列表
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return List<WFBizResource> 业务资源列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFBizResource> queryActivityAllBizResource(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： List<WFBizResource>对象

# 14. queryActivityBizResource 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryActivityBizResource
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryActivityBizResource
方法说明 获取业务流程活动定义绑定的业务资源
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程活动定义绑定的业务资源
# 方法定义
/**
 * 获取业务流程活动定义绑定的业务资源
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return WFBizResource 业务资源对象
 * @throws WFApiException 如果发生API异常
 */
public WFBizResource queryActivityBizResource(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： WFBizResource对象

# 15. queryActivitySubProcessDefName 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryActivitySubProcessDefName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryActivitySubProcessDefName
方法说明 获取业务流程活动定义绑定的子业务流程名称
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程活动定义绑定的子业务流程名称
# 方法定义
/**
 * 获取业务流程活动定义绑定的子业务流程名称
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return String 子业务流程名称
 * @throws WFApiException 如果发生API异常
 */
public String queryActivitySubProcessDefName(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： String对象

# 16. queryActivityTimeLimitCalendarId 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryActivityTimeLimitCalendarId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryActivityTimeLimitCalendarId
方法说明 获取流程活动时间限制工作日历ID
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程活动的时间限制工作日历ID
# 方法定义
/**
 * 获取流程活动时间限制工作日历ID
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return String 时间限制工作日历ID
 * @throws WFApiException 如果发生API异常
 */
public String queryActivityTimeLimitCalendarId(long processDefID, String activityDefID) throws WFApiException;
# 参数说明java
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： String对象

# 17. queryNextActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryNextActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryNextActivities
方法说明 查询某业务流程中某个活动定义的所有直接后继活动
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中某个活动定义的所有直接后继活动
# 方法定义
/**
 * 查询某业务流程中某个活动定义的所有直接后继活动
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return List<WFActivityDefine> 后继活动列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFActivityDefine> queryNextActivities(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： List<WFActivityDefine>对象

# 18. queryNextTransitions 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryNextTransitions
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryNextTransitions
方法说明 根据业务流程ID和活动定义ID查询活动的后继活动连线信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中某个活动定义的后继活动连线信息
# 方法定义
/**
 * 根据业务流程ID和活动定义ID查询活动的后继活动连线信息
 * @param processDefID 流程定义ID
 * @param activityID 活动定义ID
 * @return List<WFConnector> 后继活动连线信息列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFConnector> queryNextTransitions(long processDefID, String activityID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityID String 是 活动定义ID
# 返回值

返回类型： List<WFConnector>对象

# 19. queryNextTransitions1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryNextTransitions1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryNextTransitions1
方法说明 根据业务流程名称和活动定义ID查询活动的后继活动连线信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中某个活动定义的后继活动连线信息
# 方法定义
/**
 * 根据业务流程名称和活动定义ID查询活动的后继活动连线信息
 * @param processDefName 流程定义名称
 * @param activityID 活动定义ID
 * @return List<WFConnector> 后继活动连线信息列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFConnector> queryNextTransitions1(String processDefName, String activityID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
activityID String 是 活动定义ID
# 返回值

返回类型： List<WFConnector>对象

# 20. queryPreviousActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryPreviousActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryPreviousActivities
方法说明 查询某业务流程中某个活动定义的所有直接前驱活动
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程中某个活动定义的所有直接前驱活动
# 方法定义
/**
 * 查询某业务流程中某个活动定义的所有直接前驱活动
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @return List<WFActivityDefine> 前驱活动列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFActivityDefine> queryPreviousActivities(long processDefID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： List<WFActivityDefine>对象

# 21. queryProcessBizCatalog 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessBizCatalog
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessBizCatalog
方法说明 获取业务流程的业务目录信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的业务目录信息
# 方法定义
/**
 * 获取业务流程的业务目录信息
 * @param processDefID 流程定义ID
 * @return WFBusinessCatalog 业务目录信息对象
 * @throws WFApiException 如果发生API异常
 */
public WFBusinessCatalog queryProcessBizCatalog(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： WFBusinessCatalog对象

# 22. queryProcessById 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessById
方法说明 根据业务流程ID查询业务流程的详细信息
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的详细信息
# 方法定义
/**
 * 根据业务流程ID查询业务流程的详细信息
 * @param processDefID 流程定义ID
 * @return WFProcessDefine 业务流程定义对象
 * @throws WFApiException 如果发生API异常
 */
public WFProcessDefine queryProcessById(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： WFProcessDefine对象

# 23. queryProcessCatalogsByPkgId 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessCatalogsByPkgId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessCatalogsByPkgId
方法说明 获取一个构建包下的所有业务流程目录
接口类型 Service API（SDK接口）
适用场景 查询一个构建包下的所有业务流程目录
# 方法定义
/**
 * 获取一个构建包下的所有业务流程目录
 * @param packageID 构件包id
 * @return List<WFProcessCatalog> 业务流程目录列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessCatalog> queryProcessCatalogsByPkgId(String packageID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
packageID String 是 构件包id
# 返回值

返回类型： List<WFProcessCatalog>对象

# 24. queryProcessesByBizCatalogUuid 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByBizCatalogUuid
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByBizCatalogUuid
方法说明 查询某业务目录下的所有新版本业务流程，支持分页
接口类型 Service API（SDK接口）
适用场景 查询某业务目录下的所有新版本业务流程，支持分页
# 方法定义
/**
 * 查询某业务目录下的所有新版本业务流程，支持分页
 * @param catalogUUID 业务目录UUID
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByBizCatalogUuid(String catalogUUID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
catalogUUID String 是 业务目录UUID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 25. queryProcessesByBizCatalogUuidWithPermission 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByBizCatalogUuidWithPermission
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByBizCatalogUuidWithPermission
方法说明 查询某业务目录下的所有新版本业务流程，支持分页，带权限查询
接口类型 Service API（SDK接口）
适用场景 查询某业务目录下的所有新版本业务流程，支持分页，带权限查询
# 方法定义
/**
 * 查询某业务目录下的所有新版本业务流程，支持分页，带权限查询
 * @param personID 人员ID
 * @param authType 权限类型
 * @param catalogID 业务目录ID
 * @param multilevel 是否嵌套查询
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByBizCatalogUuidWithPermission(String personID, String authType, String catalogID, boolean multilevel, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
authType String 是 权限类型
catalogID String 是 业务目录ID
multilevel boolean 是 是否嵌套查询
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 26. queryProcessesByName1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByName1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByName1
方法说明 根据业务流程名称查询对应该名称的所有业务流程
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程名称的所有业务流程
# 方法定义
/**
 * 根据业务流程名称查询对应该名称的所有业务流程
 * @param processDefName 流程定义名称
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByName1(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： List<WFProcessDefine>对象

# 27. queryProcessesByName 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByName
方法说明 根据业务流程名称和状态查询对应该名称的所有业务流程，支持分页
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程名称和状态的所有业务流程，支持分页
# 方法定义
/**
 * 根据业务流程名称和状态查询对应该名称的所有业务流程，支持分页
 * @param processDefName 流程定义名称
 * @param state 状态
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByName(String processDefName, String state, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
state String 是 状态
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 28. queryProcessesByPkgId 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByPkgId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByPkgId
方法说明 查询某构件包下的所有业务流程，支持分页
接口类型 Service API（SDK接口）
适用场景 查询某构件包下的所有业务流程，支持分页
# 方法定义
/**
 * 查询某构件包下的所有业务流程，支持分页
 * @param packageID 构件包id
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByPkgId(String packageID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
packageID String 是 构件包id
# 返回值

返回类型： List<WFProcessDefine>对象

# 29. queryProcessesByPkgId1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByPkgId1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByPkgId1
方法说明 查询某构件包下的所有业务流程，支持分页
接口类型 Service API（SDK接口）
适用场景 查询某构件包下的所有业务流程，支持分页
# 方法定义
/**
 * 查询某构件包下的所有业务流程，支持分页
 * @param packageID 构件包id
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByPkgId1(String packageID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
packageID String 是 构件包id
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 30. queryProcessTimeLimitCalendarId 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessTimeLimitCalendarId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessTimeLimitCalendarId
方法说明 获取流程时间限制工作日历ID
接口类型 Service API（SDK接口）
适用场景 查询特定业务流程的时间限制工作日历ID
# 方法定义
/**
 * 获取流程时间限制工作日历ID
 * @param processDefID 流程定义ID
 * @return String 时间限制工作日历ID
 * @throws WFApiException 如果发生API异常
 */
public String queryProcessTimeLimitCalendarId(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： String对象

# 31. queryPublishedProcesses 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryPublishedProcesses
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryPublishedProcesses
方法说明 查询所有已发布的业务流程，支持分页
接口类型 Service API（SDK接口）
适用场景 查询所有已发布的业务流程，支持分页
# 方法定义
/**
 * 查询所有已发布的业务流程，支持分页
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 已发布的业务流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryPublishedProcesses(PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 32. queryPublishedProcessesWithApps 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryPublishedProcessesWithApps
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryPublishedProcessesWithApps
方法说明 根据应用信息分页查询用户权限内可发起流程
接口类型 Service API（SDK接口）
适用场景 根据应用信息分页查询用户权限内可发起流程
# 方法定义
/**
 * 根据应用信息分页查询用户权限内可发起流程
 * @param processChName 流程中文名称
 * @param appCodes 应用代码数组
 * @param pageCond 分页信息
 * @return List<WFProcessDefineInfo> 可发起流程信息列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefineInfo> queryPublishedProcessesWithApps(String processChName, String[] appCodes, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processChName String 是 流程中文名称
appCodes String[] 是 应用代码数组
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefineInfo>对象

# 33. queryPublishedProcessesWithCatalog 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryPublishedProcessesWithCatalog
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryPublishedProcessesWithCatalog
方法说明 根据目录ID分页查询用户权限内可发起流程
接口类型 Service API（SDK接口）
适用场景 根据目录ID分页查询用户权限内可发起流程
# 方法定义
/**
 * 根据目录ID分页查询用户权限内可发起流程
 * @param catalogUUID 目录UUID
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 可发起流程列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryPublishedProcessesWithCatalog(String catalogUUID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
catalogUUID String 是 目录UUID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 34. queryPublishedProcessesWithCatalogAndApp 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryPublishedProcessesWithCatalogAndApp
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryPublishedProcessesWithCatalogAndApp
方法说明 根据目录及应用分页查询用户权限内可发起流程
接口类型 Service API（SDK接口）
适用场景 根据目录及应用分页查询用户权限内可发起流程
# 方法定义
/**
 * 根据目录及应用分页查询用户权限内可发起流程
 * @param catalogUUID 目录UUID
 * @param appCode 应用代码
 * @param pageCond 分页信息
 * @return List<WFProcessDefineInfo> 可发起流程信息列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefineInfo> queryPublishedProcessesWithCatalogAndApp(String catalogUUID, String appCode, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
catalogUUID String 是 目录UUID
appCode String 是 应用代码
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefineInfo>对象

# 35. getProcessDefineProperties 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcessDefineProperties
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcessDefineProperties
方法说明 获取流程定义的全局业务属性
接口类型 Service API（SDK接口）
适用场景 获取流程定义的全局业务属性
# 方法定义
/**
 * 获取流程定义的全局业务属性
 * @param processDefName 流程定义名称
 * @return WFProcessDefineProperties 流程定义全局业务属性对象
 * @throws WFApiException 如果发生API异常
 */
public WFProcessDefineProperties getProcessDefineProperties(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： WFProcessDefineProperties对象

# 36. getProcessStarter 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getProcessStarter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getProcessStarter
方法说明 获取应用流程数量
接口类型 Service API（SDK接口）
适用场景 获取应用流程数量
# 方法定义
/**
 * 获取应用流程数量
 * @param processDefName 流程定义名称
 * @param starterType 启动者类型
 * @param starterName 启动者名称
 * @param pageCond 分页信息
 * @return List<WFParticipant> 启动者列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFParticipant> getProcessStarter(String processDefName, String starterType, String starterName, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
starterType String 是 启动者类型
starterName String 是 启动者名称
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFParticipant>对象

# 37. queryProcessDefinesInAppSum 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessDefinesInAppSum
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessDefinesInAppSum
方法说明 根据流程中文名称查询应用下的流程定义
接口类型 Service API（SDK接口）
适用场景 根据流程中文名称查询应用下的流程定义
# 方法定义
/**
 * 根据流程中文名称查询应用下的流程定义
 * @param apps 应用信息
 * @return List<AppInfo> 应用流程数量列表
 * @throws WFApiException 如果发生API异常
 */
public List<AppInfo> queryProcessDefinesInAppSum(String[] apps) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
apps String[] 是 应用信息
# 返回值

返回类型： List<AppInfo>对象

# 38. queryProcessesByApps 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByApps
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByApps
方法说明 根据目录及应用分页查询流程定义
接口类型 Service API（SDK接口）
适用场景 根据目录及应用分页查询流程定义
# 方法定义
/**
 * 根据目录及应用分页查询流程定义
 * @param appCodes 应用代码数组
 * @param processChName 流程中文名称
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByApps(String[] appCodes, String processChName, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
appCodes String[] 是 应用代码数组
processChName String 是 流程中文名称
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 39. queryProcessesByBizCatalogUuidAndApp 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.queryProcessesByBizCatalogUuidAndApp
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.queryProcessesByBizCatalogUuidAndApp
方法说明 根据目录及应用分页查询流程定义
接口类型 Service API（SDK接口）
适用场景 根据目录及应用分页查询流程定义
# 方法定义
/**
 * 根据目录及应用分页查询流程定义
 * @param appCode 应用代码
 * @param catalogUuid 目录UUID
 * @param pageCond 分页信息
 * @return List<WFProcessDefine> 流程定义列表
 * @throws WFApiException 如果发生API异常
 */
public List<WFProcessDefine> queryProcessesByBizCatalogUuidAndApp(String appCode, String catalogUuid, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
appCode String 是 应用代码
catalogUuid String 是 目录UUID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>对象

# 40. getExtendAttributes 方法接口文档

# 基本信息
项目 说明
接口名称 WFDefinitionQueryManager.getExtendAttributes
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDefinitionQueryManager.getExtendAttributes
方法说明 获取流程定义的全部环节扩展信息
接口类型 Service API（SDK接口）
适用场景 获取流程定义的全部环节扩展信息
# 方法定义
/**
 * 获取流程定义的全部环节扩展信息
 * @param processDefId 流程定义ID
 * @param actDefIds 活动定义ID数组
 * @return Map<String, Map<String, String>> 环节扩展信息
 * @throws WFApiException 如果发生API异常
 */
public Map<String, Map<String, String>> getExtendAttributes(long processDefId, String[] actDefIds) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义ID
actDefIds String[] 是 活动定义ID数组
# 返回值

返回类型： Map<String, Map<String, String>>对象

# 十五、WFDelegateManager

# 1. confirmDelegatedWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.confirmDelegatedWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.confirmDelegatedWorkItem(long)
方法说明 委托人确认代办人提交的工作项
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人确认代办人提交的工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void confirmDelegatedWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 2. delegateWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.delegateWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.delegateWorkItem(long, WFParticipant[], String)
方法说明 委托人将工作项代办给代办人
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人将工作项代办给代办人
 * @param workItemID 工作项ID
 * @param participants 代办人列表
 * @param delegateType 代办类型
 * @throws WFApiException
 */
public void delegateWorkItem(long workItemID, WFParticipant[] participants, String delegateType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
participants WFParticipant[] 是 代办人列表
delegateType String 是 代办类型（取值范围：DELEG—代办，HELP—协办）
# 返回值

无返回值 void

# 3. delegateWorkItem4Person 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.delegateWorkItem4Person
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.delegateWorkItem4Person(long, String, WFParticipant[], String)
方法说明 委托人将工作项代办给代办人（替委托人代办）
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人将工作项代办给代办人（替委托人代办）
 * @param workItemID 工作项ID
 * @param from 委托人
 * @param participants 代办人列表
 * @param delegateType 代办类型
 * @throws WFApiException
 */
public void delegateWorkItem4Person(long workItemID, String from, WFParticipant[] participants, String delegateType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
from String 是 委托人
participants WFParticipant[] 是 代办人列表
delegateType String 是 代办类型（取值范围：DELEG—代办，HELP—协办）
# 返回值

无返回值 void

# 4. delegateWorkItemDirectly 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.delegateWorkItemDirectly
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.delegateWorkItemDirectly(long, WFParticipant[], String)
方法说明 委托人将工作项代办给代办人，不校验权限
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人将工作项代办给代办人，不校验权限
 * @param workItemID 工作项ID
 * @param participants 代办人列表
 * @param delegateType 代办类型
 * @throws WFApiException
 */
public void delegateWorkItemDirectly(long workItemID, WFParticipant[] participants, String delegateType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
participants WFParticipant[] 是 代办人列表
delegateType String 是 代办类型（取值范围：DELEG—代办，HELP—协办）
# 返回值

无返回值 void

# 5. queryDelegationWorkItems1 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.queryDelegationWorkItems1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.queryDelegationWorkItems1(String, WFParticipant, String, PageCond)
方法说明 根据委托人ID、代办人ID、代办方式组合分页查询代办/协办的工作项
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 根据委托人ID、代办人ID、代办方式组合分页查询代办/协办的工作项
 * @param fromer 委托人ID
 * @param toer 代办人
 * @param delegateType 代办类型
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryDelegationWorkItems1(String fromer, WFParticipant toer, String delegateType, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromer String 是 委托人ID
toer WFParticipant 是 代办人
delegateType String 是 代办类型（取值范围：DELEG—代办，HELP—协办）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>工作项列表

# 6. queryDelegationWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.queryDelegationWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.queryDelegationWorkItems(String, WFParticipant, String, PageCond)
方法说明 根据委托人ID、代办人ID、代办方式组合分页查询代办/协办的工作项
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 根据委托人ID、代办人ID、代办方式组合分页查询代办/协办的工作项
 * @param fromer 委托人ID
 * @param toer 代办人
 * @param delegateType 代办类型
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryDelegationWorkItems(String fromer, WFParticipant toer, String delegateType, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
fromer String 是 委托人ID
toer WFParticipant 是 代办人
delegateType String 是 代办类型（取值范围：DELEG—代办，HELP—协办）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>工作项列表

# 7. redoDelegatedWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.redoDelegatedWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.redoDelegatedWorkItem(long)
方法说明 委托人打回代办人代办的工作项
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人打回代办人代办的工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void redoDelegatedWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 8. rejectDelegatedWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.rejectDelegatedWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.rejectDelegatedWorkItem(long)
方法说明 代办人拒绝代办工作项
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 代办人拒绝代办工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void rejectDelegatedWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 9. withdrawDelegatedWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFDelegateManager.withdrawDelegatedWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFDelegateManager.withdrawDelegatedWorkItem(long)
方法说明 委托人将代办出去的工作项收回
接口类型 Service API（SDK接口）
适用场景 工作项代办管理服务
# 方法定义
/**
 * 委托人将代办出去的工作项收回
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void withdrawDelegatedWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 十六、WFFreeFlowManager

# 1. appointNextActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.appointNextActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.appointNextActivities(long, String, String[])
方法说明 设置某自由活动的后继活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 设置某自由活动的后继活动
 * @param workItemID 工作项ID
 * @param appointStrategy 指派策略
 * @param activityDefID 后继活动定义ID数组
 * @throws WFApiException
 */
public void appointNextActivities(long workItemID, String appointStrategy, String[] activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
appointStrategy String 是 指派策略（值范围：set—覆盖之前设置的结果
append —在之前设置的结果中追加）
activityDefID String[] 是 后继活动定义ID数组
# 返回值

无返回值 void

# 2. appointNextActivitiesByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.appointNextActivitiesByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.appointNextActivitiesByActivityInstId(long, String, String[])
方法说明 设置某活动的后继活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 设置某活动的后继活动
 * @param activityInstID 活动实例ID
 * @param appointStrategy 指派策略
 * @param activityDefID 后继活动定义ID数组
 * @throws WFApiException
 */
public void appointNextActivitiesByActivityInstId(long activityInstID, String appointStrategy, String[] activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
appointStrategy String 是 指派策略（值范围：set—覆盖之前设置的结果
append —在之前设置的结果中追加）
activityDefID String[] 是 后继活动定义ID数组
# 返回值

无返回值 void

# 3. isFreeActivity 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.isFreeActivity
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.isFreeActivity(long)
方法说明 判断工作项ID所对应的活动是否是个自由活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 判断工作项ID所对应的活动是否是个自由活动
 * @param workItemID 工作项ID
 * @return 是否是自由活动
 * @throws WFApiException
 */
public boolean isFreeActivity(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： boolean是否是自由活动

# 4. queryAppointedNextActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.queryAppointedNextActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.queryAppointedNextActivities(long)
方法说明 查询某自由活动已被设置的后继活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 查询某自由活动已被设置的后继活动
 * @param workItemID 工作项ID
 * @return 后继活动定义列表
 * @throws WFApiException
 */
public List<WFActivityDefine> queryAppointedNextActivities(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： List<WFActivityDefine>后继活动定义列表

# 5. queryNextFreeActivityScope 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.queryNextFreeActivityScope
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.queryNextFreeActivityScope(long)
方法说明 根据定义的设置，获取某自由活动可能的后继活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 根据定义的设置，获取某自由活动可能的后继活动
 * @param workItemID 工作项ID
 * @return 可能的后继活动定义列表
 * @throws WFApiException
 */
public List<WFActivityDefine> queryNextFreeActivityScope(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： List<WFActivityDefine>可能的后继活动定义列表

# 6. removeAppointedNextActivities 方法接口文档

# 基本信息
项目 说明
接口名称 WFFreeFlowManager.removeAppointedNextActivities
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFFreeFlowManager.removeAppointedNextActivities(long, String[])
方法说明 从已指定的后继活动中删除后继活动
接口类型 Service API（SDK接口）
适用场景 自由流相关操作接口
# 方法定义
/**
 * 从已指定的后继活动中删除后继活动
 * @param workItemID 工作项ID
 * @param activityDefID 后继活动定义ID数组
 * @throws WFApiException
 */
public void removeAppointedNextActivities(long workItemID, String[] activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
activityDefID String[] 是 后继活动定义ID数组
# 返回值

无返回值 void

# 十七、WFIdentityAuthenticationManager

# 1. getTenantIdentityToken 方法接口文档

# 基本信息
项目 说明
接口名称 WFIdentityAuthenticationManager.getTenantIdentityToken
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFIdentityAuthenticationManager.getTenantIdentityToken(String, String)
方法说明 查询租户令牌
接口类型 Service API（SDK接口）
适用场景 租户令牌相关服务
# 方法定义
/**
 * 查询租户令牌
 * @param id 租户ID
 * @param password 租户密码
 * @return 租户令牌
 * @throws WFApiException
 */
public String getTenantIdentityToken(String id, String password) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
id String 是 租户ID
password String 是 租户密码
# 返回值

返回类型： String租户令牌

# 2. verifyTenant 方法接口文档

# 基本信息
项目 说明
接口名称 WFIdentityAuthenticationManager.verifyTenant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFIdentityAuthenticationManager.verifyTenant(String, String)
方法说明 校验租户令牌是否合法
接口类型 Service API（SDK接口）
适用场景 租户令牌相关服务
# 方法定义
/**
 * 校验租户令牌是否合法
 * @param tenantID 租户ID
 * @param token 租户令牌
 * @return 是否合法
 * @throws WFApiException
 */
public boolean verifyTenant(String tenantID, String token) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenantID String 是 租户ID
token String 是 租户令牌
# 返回值

返回类型： boolean是否合法

# 十八、WFInterimBizResourceManager

# 1. deleteBizCalendar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.deleteBizCalendar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.deleteBizCalendar(String)
方法说明 删除工作日历
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 删除工作日历
 * @param uuid 工作日历UUID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteBizCalendar(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 工作日历UUID
# 返回值

返回类型： int删除结果

# 2. deleteBizHumantask 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.deleteBizHumantask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.deleteBizHumantask(String)
方法说明 删除人工任务
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 删除人工任务
 * @param uuid 人工任务UUID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteBizHumantask(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 人工任务UUID
# 返回值

返回类型： int删除结果

# 3. deleteBizOperation 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.deleteBizOperation
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.deleteBizOperation(String)
方法说明 删除业务操作
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 删除业务操作
 * @param uuid 业务操作UUID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteBizOperation(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务操作UUID
# 返回值

返回类型： int删除结果

# 4. deleteBizRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.deleteBizRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.deleteBizRule(String)
方法说明 删除业务规则
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 删除业务规则
 * @param uuid 业务规则UUID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteBizRule(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务规则UUID
# 返回值

返回类型： int删除结果

# 5. deleteBizVar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.deleteBizVar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.deleteBizVar(String)
方法说明 删除业务变量
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 删除业务变量
 * @param uuid 业务变量UUID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteBizVar(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务变量UUID
# 返回值

返回类型： int删除结果

# 6. findBizCalendar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.findBizCalendar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.findBizCalendar(String)
方法说明 简单查询工作日历
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 简单查询工作日历
 * @param uuid 工作日历UUID
 * @return 工作日历对象
 * @throws WFApiException
 */
public WFBizCalendar findBizCalendar(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 工作日历UUID
# 返回值

返回类型： WFBizCalendar工作日历对象

# 7. findBizHumantask 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.findBizHumantask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.findBizHumantask(String)
方法说明 简单查询人工任务
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 简单查询人工任务
 * @param uuid 人工任务UUID
 * @return 人工任务对象
 * @throws WFApiException
 */
public WFBizHumantask findBizHumantask(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 人工任务UUID
# 返回值

返回类型： WFBizHumantask人工任务对象

# 8. findBizOperation 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.findBizOperation
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.findBizOperation(String)
方法说明 简单查询业务操作
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 简单查询业务操作
 * @param uuid 业务操作UUID
 * @return 业务操作对象
 * @throws WFApiException
 */
public WFBizOperation findBizOperation(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务操作UUID
# 返回值

返回类型： WFBizOperation业务操作对象

# 9. findBizRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.findBizRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.findBizRule(String)
方法说明 简单查询业务规则
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 简单查询业务规则
 * @param uuid 业务规则UUID
 * @return 业务规则对象
 * @throws WFApiException
 */
public WFBizRule findBizRule(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务规则UUID
# 返回值

返回类型： WFBizRule业务规则对象

# 10. findBizVar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.findBizVar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.findBizVar(String)
方法说明 简单查询业务变量
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 简单查询业务变量
 * @param uuid 业务变量UUID
 * @return 业务变量对象
 * @throws WFApiException
 */
public WFBizVar findBizVar(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务变量UUID
# 返回值

返回类型： WFBizVar业务变量对象

# 11. isExistReferences 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.isExistReferences
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.isExistReferences(String, String)
方法说明 判断业务资源的是否被其他引用
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 判断业务资源的是否被其他引用
 * @param bizType 业务资源类型
 * @param uuid 业务资源UUID
 * @return 是否存在引用
 * @throws WFApiException
 */
public boolean isExistReferences(String bizType, String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizType String 是 业务资源类型
uuid String 是 业务资源UUID
# 返回值

返回类型： boolean是否存在引用

# 12. publishBizResource 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.publishBizResource
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.publishBizResource(String, String)
方法说明 将指定的业务资源从临时库发布到运行库
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 将指定的业务资源从临时库发布到运行库
 * @param uuid 业务资源UUID
 * @param bizType 业务资源类型
 * @return 发布结果
 * @throws WFApiException
 */
public boolean publishBizResource(String uuid, String bizType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务资源UUID
bizType String 是 业务资源类型（值范围：0—人工任务 02—业务操作 03—业务变量 04—业务规则）
# 返回值

返回类型： boolean发布结果

# 13. queryBizCalendar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.queryBizCalendar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.queryBizCalendar(WFBizCalendar, PageCond)
方法说明 分页查询工作日历，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 分页查询工作日历，支持复杂条件
 * @param bizCalendar 工作日历明细
 * @param pageCond 分页信息
 * @return 工作日历列表
 * @throws WFApiException
 */
public List<WFBizCalendar> queryBizCalendar(WFBizCalendar bizCalendar, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizCalendar WFBizCalendar 是 工作日历明细
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizCalendar>工作日历列表

# 14. queryBizHumantask 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.queryBizHumantask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.queryBizHumantask(WFBizHumantask, PageCond)
方法说明 分页查询人工任务，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 分页查询人工任务，支持复杂条件
 * @param bizHumantask 人工任务明细
 * @param pageCond 分页信息
 * @return 人工任务列表
 * @throws WFApiException
 */
public List<WFBizHumantask> queryBizHumantask(WFBizHumantask bizHumantask, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizHumantask WFBizHumantask 是 人工任务明细
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizHumantask>人工任务列表

# 15. queryBizOperation 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.queryBizOperation
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.queryBizOperation(WFBizOperation, PageCond)
方法说明 分页查询业务操作，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 分页查询业务操作，支持复杂条件
 * @param operation 业务操作明细
 * @param pageCond 分页信息
 * @return 业务操作列表
 * @throws WFApiException
 */
public List<WFBizOperation> queryBizOperation(WFBizOperation operation, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
operation WFBizOperation 是 业务操作明细
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizOperation>业务操作列表

# 16. queryBizRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.queryBizRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.queryBizRule(WFBizRule, PageCond)
方法说明 分页查询业务规则，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 分页查询业务规则，支持复杂条件
 * @param bizRule 业务规则明细
 * @param pageCond 分页信息
 * @return 业务规则列表
 * @throws WFApiException
 */
public List<WFBizRule> queryBizRule(WFBizRule bizRule, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizRule WFBizRule 是 业务规则明细
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizRule>业务规则列表

# 17. queryBizVar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.queryBizVar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.queryBizVar(WFBizVar, PageCond)
方法说明 分页查询业务变量，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 分页查询业务变量，支持复杂条件
 * @param bizVar 业务变量明细
 * @param pageCond 分页信息
 * @return 业务变量列表
 * @throws WFApiException
 */
public List<WFBizVar> queryBizVar(WFBizVar bizVar, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizVar WFBizVar 是 业务变量明细
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizVar>业务变量列表

# 18. saveBizCalendar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.saveBizCalendar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.saveBizCalendar(WFBizCalendar)
方法说明 保存工作日历
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 保存工作日历
 * @param bizCalendar 工作日历明细
 * @return 保存结果
 * @throws WFApiException
 */
public String saveBizCalendar(WFBizCalendar bizCalendar) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizCalendar WFBizCalendar 是 工作日历明细
# 返回值

返回类型： String保存结果

# 19. saveBizHumantask 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.saveBizHumantask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.saveBizHumantask(WFBizHumantask)
方法说明 保存人工任务
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 保存人工任务
 * @param bizHumantask 人工任务明细
 * @return 保存结果
 * @throws WFApiException
 */
public String saveBizHumantask(WFBizHumantask bizHumantask) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizHumantask WFBizHumantask 是 人工任务明细
# 返回值

返回类型： String保存结果

# 20. saveBizOperation 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.saveBizOperation
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.saveBizOperation(WFBizOperation)
方法说明 保存业务操作
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 保存业务操作
 * @param operation 业务操作明细
 * @return 保存结果
 * @throws WFApiException
 */
public String saveBizOperation(WFBizOperation operation) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
operation WFBizOperation 是 业务操作明细
# 返回值

返回类型： String保存结果

# 21. saveBizRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.saveBizRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.saveBizRule(WFBizRule)
方法说明 保存业务规则
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 保存业务规则
 * @param bizRule 业务规则明细
 * @return 保存结果
 * @throws WFApiException
 */
public String saveBizRule(WFBizRule bizRule) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizRule WFBizRule 是 业务规则明细
# 返回值

返回类型： String保存结果

# 22. saveBizVar 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimBizResourceManager.saveBizVar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimBizResourceManager.saveBizVar(WFBizVar)
方法说明 保存业务变量
接口类型 Service API（SDK接口）
适用场景 业务资源临时库管理服务
# 方法定义
/**
 * 保存业务变量
 * @param bizVar 业务变量明细
 * @return 保存结果
 * @throws WFApiException
 */
public String saveBizVar(WFBizVar bizVar) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizVar WFBizVar 是 业务变量明细
# 返回值

返回类型： String保存结果

# 十九、WFInterimDefinitionManager

# 1. deleteWFBizProcessDef 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.deleteWFBizProcessDef
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.deleteWFBizProcessDef(WFBizProcessDef)
方法说明 删除业务流程定义
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 删除业务流程定义
 * @param bizProcessDef 业务流程定义
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteWFBizProcessDef(WFBizProcessDef bizProcessDef) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizProcessDef WFBizProcessDef 是 业务流程定义
# 返回值

返回类型： int删除结果

# 2. queryActivitiesOfProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.queryActivitiesOfProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.queryActivitiesOfProcess(long)
方法说明 查询流程定义中的活动列表
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 查询流程定义中的活动列表
 * @param processDefID 流程定义ID
 * @return 活动列表
 * @throws WFApiException
 */
public List<WFActivityDefine> queryActivitiesOfProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： List<WFActivityDefine>活动列表

# 3. queryBizProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.queryBizProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.queryBizProcess(long)
方法说明 查询流程定义临时库中业务流程
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 查询流程定义临时库中业务流程
 * @param processDefID 流程定义ID
 * @return 业务流程对象
 * @throws WFApiException
 */
public WFBizProcessDef queryBizProcess(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： WFBizProcessDef业务流程对象

# 4. queryBizProcess1 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.queryBizProcess1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.queryBizProcess1(WFBizProcessDef, PageCond)
方法说明 分页查询业务流程，支持复杂条件
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 分页查询业务流程，支持复杂条件
 * @param bizProcessDef 业务流程定义
 * @param pageCond 分页信息
 * @return 业务流程列表
 * @throws WFApiException
 */
public List<WFBizProcessDef> queryBizProcess1(WFBizProcessDef bizProcessDef, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizProcessDef WFBizProcessDef 是 业务流程定义
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFBizProcessDef>业务流程列表

# 5. queryProcessByName 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.queryProcessByName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.queryProcessByName(String)
方法说明 查询流程定义临时库中的业务流程
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 查询流程定义临时库中的业务流程
 * @param processDefName 流程定义名称
 * @return 业务流程对象
 * @throws WFApiException
 */
public WFBizProcessDef queryProcessByName(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： WFBizProcessDef业务流程对象

# 6. queryProcessContentById 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.queryProcessContentById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.queryProcessContentById(long)
方法说明 获取流程定义的内容，返回为XML格式
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 获取流程定义的内容，返回为XML格式
 * @param processDefID 流程定义ID
 * @return 流程定义内容
 * @throws WFApiException
 */
public String queryProcessContentById(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： String流程定义内容

# 7. saveWFBizProcessDef 方法接口文档

# 基本信息
项目 说明
接口名称 WFInterimDefinitionManager.saveWFBizProcessDef
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFInterimDefinitionManager.saveWFBizProcessDef(WFBizProcessDef)
方法说明 保存流程定义
接口类型 Service API（SDK接口）
适用场景 业务流程定制的流程定义管理接口
# 方法定义
/**
 * 保存流程定义
 * @param bizProcessDef 业务流程定义
 * @return 流程定义ID
 * @throws WFApiException
 */
public long saveWFBizProcessDef(WFBizProcessDef bizProcessDef) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizProcessDef WFBizProcessDef 是 业务流程定义
# 返回值

返回类型： long流程定义ID

# 二十、WFMultiTenancyManager

# 1. createtTenant 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.createtTenant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.createtTenant(String, String, String, String, String, Boolean, String)
方法说明 创建租户
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 创建租户
 * @param tenant_id 租户ID
 * @param domainName 域名
 * @param organizationClass 组织机构实现类
 * @param permissionClass 权限接口实现类
 * @param pwd 密码
 * @param bindDataSourceFlag 是否绑定数据源
 * @param datasource 数据源
 * @return 创建结果
 * @throws WFApiException
 */
public Boolean createtTenant(String tenant_id, String domainName, String organizationClass, String permissionClass, String pwd, Boolean bindDataSourceFlag, String datasource) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenant_id String 是 租户ID
domainName String 是 域名
organizationClass String 是 组织机构实现类
permissionClass String 是 权限接口实现类
pwd String 是 密码
bindDataSourceFlag Boolean 是 是否绑定数据源
datasource String 是 数据源
# 返回值

返回类型： Boolean创建结果

# 2. deleteTenantByID 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.deleteTenantByID
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.deleteTenantByID(String)
方法说明 删除租户信息
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 删除租户信息
 * @param tenant_id 租户ID
 * @return 删除结果
 * @throws WFApiException
 */
public Boolean deleteTenantByID(String tenant_id) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenant_id String 是 租户ID
# 返回值

返回类型： Boolean删除结果

# 3. getTenantIdentityToken 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.getTenantIdentityToken
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.getTenantIdentityToken(String)
方法说明 查询租户令牌
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 查询租户令牌
 * @param id 租户ID
 * @return 租户令牌
 * @throws WFApiException
 */
public String getTenantIdentityToken(String id) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
id String 是 租户ID
# 返回值

返回类型： String租户令牌

# 4. queryAllTenantIds 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.queryAllTenantIds
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.queryAllTenantIds()
方法说明 查询所有租户ID列表
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 查询所有租户ID列表
 * @return 租户ID列表
 * @throws WFApiException
 */
public List<String> queryAllTenantIds() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： List<String>租户ID列表

# 5. queryAllTenants 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.queryAllTenants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.queryAllTenants()
方法说明 查询所有租户信息
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 查询所有租户信息
 * @return 租户信息列表
 * @throws WFApiException
 */
public List<TenantModel> queryAllTenants() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： List<TenantModel>租户信息列表

# 6. queryTenantByID 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.queryTenantByID
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.queryTenantByID(String)
方法说明 查询租户信息
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 查询租户信息
 * @param tenant_id 租户ID
 * @return 租户信息
 * @throws WFApiException
 */
public TenantModel queryTenantByID(String tenant_id) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenant_id String 是 租户ID
# 返回值

返回类型： TenantModel租户信息

# 7. updateTenantByID 方法接口文档

# 基本信息
项目 说明
接口名称 WFMultiTenancyManager.updateTenantByID
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFMultiTenancyManager.updateTenantByID(String, String, String, String, String, String, Boolean, String, Object)
方法说明 修改租户信息
接口类型 Service API（SDK接口）
适用场景 多租户服务
# 方法定义
/**
 * 修改租户信息
 * @param tenant_id 租户ID
 * @param domainName 域名
 * @param organizationClass 组织机构实现类
 * @param permissionClass 权限接口实现类
 * @param oldPwd 原密码
 * @param newPwd 新密码
 * @param bindDataSourceFlag 是否绑定数据源
 * @param datasource 数据源
 * @param extend 拓展信息
 * @return 修改结果
 * @throws WFApiException
 */
public String updateTenantByID(String tenant_id, String domainName, String organizationClass, String permissionClass, String oldPwd, String newPwd, Boolean bindDataSourceFlag, String datasource, Object extend) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenant_id String 是 租户ID
domainName String 是 域名
organizationClass String 是 组织机构实现类
permissionClass String 是 权限接口实现类
oldPwd String 是 原密码
newPwd String 是 新密码
bindDataSourceFlag Boolean 是 是否绑定数据源
datasource String 是 数据源
extend Object 是 拓展信息
# 返回值

返回类型： String修改结果

# 二十一、WFNotificationManager

# 1. confirmNotification 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.confirmNotification
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.confirmNotification(long)
方法说明 确认（阅读）通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 确认（阅读）通知
 * @param notificationID 通知ID
 * @throws WFApiException
 */
public void confirmNotification(long notificationID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
notificationID long 是 通知ID
# 返回值

无返回值 void

# 2. deleteNotification 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.deleteNotification
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.deleteNotification(long)
方法说明 删除通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 删除通知
 * @param notificationID 通知ID
 * @throws WFApiException
 */
public void deleteNotification(long notificationID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
notificationID long 是 通知ID
# 返回值

无返回值 void

# 3. queryNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryNotifications(Map, Map)
方法说明 查询通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询通知
 * @param paramMap1 查询条件
 * @param paramMap2 分页参数
 * @return 通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryNotifications(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 查询条件
paramMap2 Map 是 分页参数
# 返回值

返回类型： List<WFNotificationInst>通知列表

# 4. queryUnViewedActivityInstNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryUnViewedActivityInstNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryUnViewedActivityInstNotifications(String, String, PageCond)
方法说明 查询未确认的活动实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询未确认的活动实例通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 查询未确认的活动实例通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryUnViewedActivityInstNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>未确认的流程实例通知列表

# 5. queryUnViewedProcessInstNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryUnViewedProcessInstNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryUnViewedProcessInstNotifications(String, String, PageCond)
方法说明 查询未确认的流程实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询未确认的流程实例通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 未确认的流程实例通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryUnViewedProcessInstNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>未确认的流程实例通知列表

# 6. queryUnViewedTaskNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryUnViewedTaskNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryUnViewedTaskNotifications(String, String, PageCond)
方法说明 查询未确认的任务通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询未确认的任务通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 未确认的任务通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryUnViewedTaskNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>未确认的任务通知列表

# 7. queryViewedActivityInstNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryViewedActivityInstNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryViewedActivityInstNotifications(String, String, PageCond)
方法说明 查询已阅读的活动实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询已阅读的活动实例通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 已阅读的活动实例通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryViewedActivityInstNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>已阅读的活动实例通知列表

# 8. queryViewedProcessInstNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryViewedProcessInstNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryViewedProcessInstNotifications(String, String, PageCond)
方法说明 查询已阅读的流程实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询已阅读的流程实例通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 已阅读的流程实例通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryViewedProcessInstNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>已阅读的流程实例通知列表

# 9. queryViewedTaskNotifications 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.queryViewedTaskNotifications
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.queryViewedTaskNotifications(String, String, PageCond)
方法说明 查询已阅读的任务通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 查询已阅读的任务通知
 * @param recipientID 通知接收者ID
 * @param timeoutFlag 超时标志
 * @param pc 分页信息
 * @return 已阅读的任务通知列表
 * @throws WFApiException
 */
public List<WFNotificationInst> queryViewedTaskNotifications(String recipientID, String timeoutFlag, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
recipientID String 是 通知接收者ID
timeoutFlag String 是 超时标志（值范围：Y—true
N—false）
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFNotificationInst>已阅读的任务通知列表

# 10. sendActivityInstNotification 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.sendActivityInstNotification
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.sendActivityInstNotification(String, WFParticipant[], String, String, WFActivityInst, NotificationOption)
方法说明 给指定的参与者发送活动实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 给指定的参与者发送活动实例通知
 * @param senderID 通知者ID
 * @param recipients 接收者列表
 * @param title 标题
 * @param content 内容
 * @param activityInst 活动实例
 * @param noption 超时，提醒时间选项
 * @throws WFApiException
 */
public void sendActivityInstNotification(String senderID, WFParticipant[] recipients, String title, String content, WFActivityInst activityInst, NotificationOption noption) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
senderID String 是 通知者ID
recipients WFParticipant[] 是 接收者列表
title String 是 标题
content String 是 内容
activityInst WFActivityInst 是 活动实例
noption NotificationOption 是 超时，提醒时间选项
# 返回值

无返回值 void

# 11. sendProcessInstNotification 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.sendProcessInstNotification
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.sendProcessInstNotification(String, WFParticipant[], String, String, WFProcessInst, NotificationOption)
方法说明 给指定的参与者发送流程实例通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 给指定的参与者发送流程实例通知
 * @param senderID 通知者ID
 * @param recipients 接收者列表
 * @param title 标题
 * @param content 内容
 * @param processInst 流程实例
 * @param noption 超时，提醒时间选项
 * @throws WFApiException
 */
public void sendProcessInstNotification(String senderID, WFParticipant[] recipients, String title, String content, WFProcessInst processInst, NotificationOption noption) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
senderID String 是 通知者ID
recipients WFParticipant[] 是 接收者列表
title String 是 标题
content String 是 内容
processInst WFProcessInst 是 流程实例
noption NotificationOption 是 超时，提醒时间选项
# 返回值

无返回值 void

# 12. sendTaskNotification 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.sendTaskNotification
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.sendTaskNotification(String, WFParticipant[], String, String, WFWorkItem, NotificationOption)
方法说明 给指定的参与者发送任务通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 给指定的参与者发送任务通知
 * @param senderID 通知者ID
 * @param recipients 接收者列表
 * @param title 标题
 * @param content 内容
 * @param workItem 工作项
 * @param noption 超时，提醒时间选项
 * @throws WFApiException
 */
public void sendTaskNotification(String senderID, WFParticipant[] recipients, String title, String content, WFWorkItem workItem, NotificationOption noption) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
senderID String 是 通知者ID
recipients WFParticipant[] 是 接收者列表
title String 是 标题
content String 是 内容
workItem WFWorkItem 是 工作项
noption NotificationOption 是 超时，提醒时间选项
# 返回值

无返回值 void

# 13. sendTaskNotificationToPerson 方法接口文档

# 基本信息
项目 说明
接口名称 WFNotificationManager.sendTaskNotificationToPerson
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFNotificationManager.sendTaskNotificationToPerson(String, String[], String, String, WFWorkItem, NotificationOption)
方法说明 给指定的人发送任务通知
接口类型 Service API（SDK接口）
适用场景 通知（抄送）相关操作的接口
# 方法定义
/**
 * 给指定的人发送任务通知
 * @param senderID 通知者ID
 * @param recipients 接收者列表
 * @param title 标题
 * @param content 内容
 * @param workItem 工作项
 * @param noption 超时，提醒时间选项
 * @throws WFApiException
 */
public void sendTaskNotificationToPerson(String senderID, String[] recipients, String title, String content, WFWorkItem workItem, NotificationOption noption) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
senderID String 是 通知者ID
recipients String[] 是 接收者列表
title String 是 标题
content String 是 内容
workItem WFWorkItem 是 工作项
noption NotificationOption 是 超时，提醒时间选项
# 返回值

无返回值 void

# 二十二、WFOMManager

# 1. findParticipantById 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.findParticipantById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.findParticipantById(String, String)
方法说明 通过ID查找指定的参与者
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 通过ID查找指定的参与者
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @return 参与者对象
 * @throws WFApiException
 */
public WFParticipant findParticipantById(String typeCode, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
# 返回值

返回类型： WFParticipant参与者对象

# 2. findRootParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.findRootParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.findRootParticipants(String)
方法说明 获取某类型下的根参与者
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 获取某类型下的根参与者
 * @param typeCode 类型代码
 * @return 根参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> findRootParticipants(String typeCode) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
# 返回值

返回类型： List<WFParticipant>根参与者列表

# 3. getAllChildParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getAllChildParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getAllChildParticipants(String, String)
方法说明 查询所有下级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 查询所有下级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @return 下级参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getAllChildParticipants(String typeCode, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
# 返回值

返回类型： List<WFParticipant>下级参与者列表

# 4. getAllParentParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getAllParentParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getAllParentParticipants(String, String)
方法说明 查询所有上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 查询所有上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @return 上级参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getAllParentParticipants(String typeCode, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
# 返回值

返回类型： List<WFParticipant>上级参与者列表

# 5. getChildParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getChildParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getChildParticipants(String, String, String)
方法说明 查询某类型的下属参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 查询某类型的下属参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @param childType 子级类型
 * @return 下属参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getChildParticipants(String typeCode, String participantID, String childType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
childType String 是 子级类型
# 返回值

返回类型： List<WFParticipant>下属参与者列表

# 6. getJointChildParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getJointChildParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getJointChildParticipant(String, List<String>)
方法说明 查询交集类型参与者的所有下属参与者，查询到的参与者不一定全是叶子参与者
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 查询交集类型参与者的所有下属参与者，查询到的参与者不一定全是叶子参与者
 * @param jointParticipantType 是否是组合类型（虚参与者）
 * @param participantIDList 参与者ID列表
 * @return 下属参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getJointChildParticipant(String jointParticipantType, List<String> participantIDList) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
jointParticipantType String 是 是否是组合类型（虚参与者）
participantIDList List 是 参与者ID列表
# 返回值

返回类型： List<WFParticipant>下属参与者列表

# 7. getParentParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getParentParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getParentParticipants(String, String, String)
方法说明 查询某类型的上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 查询某类型的上级参与者（工作流引擎已经处理了多级别的参与者，毋须在接口实现中再处理）
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @param parentType 父级类型
 * @return 上级参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getParentParticipants(String typeCode, String participantID, String parentType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
parentType String 是 父级类型
# 返回值

返回类型： List<WFParticipant>上级参与者列表

# 8. getParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getParticipants(String, PageCond)
方法说明 获取某个类型的所有参与者，需要按照PageCond的begin,length要求做分页
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 获取某个类型的所有参与者，需要按照PageCond的begin,length要求做分页
 * @param typeCode 类型代码
 * @param pc 分页信息
 * @return 参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getParticipants(String typeCode, PageCond pc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
pc PageCond 是 分页信息
# 返回值

返回类型： List<WFParticipant>参与者列表

# 9. getParticipantScope 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getParticipantScope
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getParticipantScope(String, String)
方法说明 获取某个参与者的参与范围
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 获取某个参与者的参与范围
 * @param typeCode 类型代码
 * @param participantID 参与者ID
 * @return 参与者范围列表
 * @throws WFApiException
 */
public List<WFParticipant> getParticipantScope(String typeCode, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
participantID String 是 参与者ID
# 返回值

返回类型： List<WFParticipant>参与者范围列表

# 10. getParticipantType 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getParticipantType
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getParticipantType(String)
方法说明 根据code获取参与者类型
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 根据code获取参与者类型
 * @param typeCode 类型代码
 * @return 参与者类型对象
 * @throws WFApiException
 */
public ParticipantType getParticipantType(String typeCode) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
typeCode String 是 类型代码
# 返回值

返回类型： ParticipantType参与者类型对象

# 11. getParticipantTypes 方法接口文档

# 基本信息
项目 说明
接口名称 WFOMManager.getParticipantTypes
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOMManager.getParticipantTypes()
方法说明 获取所有的参与者类型
接口类型 Service API（SDK接口）
适用场景 组织机构服务
# 方法定义
/**
 * 获取所有的参与者类型
 * @return 参与者类型列表
 * @throws WFApiException
 */
public List<ParticipantType> getParticipantTypes() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： List<ParticipantType>参与者类型列表

# 二十三、WFOptMsgManager

# 1. addProcInstOptMsg 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.addProcInstOptMsg
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.addProcInstOptMsg(long, String, String, String, String)
方法说明 增加流程实例操作日志
接口类型 Service API
适用场景 流程实例操作日志记录
# 方法定义
/**
 * 增加流程实例操作日志
 * @param activityInstID 活动实例ID
 * @param producer 日志记录者，发起者（催办/代理/批注）
 * @param receiver 接收者（催办/代办/批注）
 * @param optType 操作类型
 * @param msg 操作信息
 * @return 操作日志ID
 * @throws WFApiException
 */
public long addProcInstOptMsg(long activityInstID, String producer, String receiver, String optType, String msg) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
producer String 是 日志记录者
receiver String 是 接收者
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
msg String 是 操作信息
# 返回值

返回类型： long

# 2. addActivityInstOptMsg 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.addActivityInstOptMsg
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.addActivityInstOptMsg(long, String, String, String, String)
方法说明 增加活动实例操作日志
接口类型 Service API
适用场景 活动实例操作日志记录
# 方法定义
/**
 * 增加活动实例操作日志
 * @param procInstID 流程实例ID
 * @param producer 日志记录者，发起者（催办/代理/批注）
 * @param receiver 接收者（催办/代办/批注）
 * @param optType 操作类型
 * @param msg 操作信息
 * @return 操作日志ID
 * @throws WFApiException
 */
public long addActivityInstOptMsg(long procInstID, String producer, String receiver, String optType, String msg) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procInstID long 是 流程实例ID
producer String 是 日志记录者
receiver String 是 接收者
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
msg String 是 操作信息
# 返回值

返回类型： long

# 3. addWorkItemOptMsg 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.addWorkItemOptMsg
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.addWorkItemOptMsg(long, String, String, String, String, String)
方法说明 增加工作项操作日志
接口类型 Service API
适用场景 工作项操作日志记录
# 方法定义
/**
 * 增加工作项操作日志
 * @param workItemID 工作项ID
 * @param producer 日志记录者，发起者（催办/代理/批注）
 * @param receiver 接收者（催办/代办/批注）
 * @param optType 操作类型
 * @param msg 操作信息
 * @return 操作日志ID
 * @throws WFApiException
 */
public long addWorkItemOptMsg(long workItemID, String producer, String receiver, String optType, String msg) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
producer String 是 日志记录者
receiver String 是 接收者
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
msg String 是 操作信息
# 返回值

返回类型： long

# 4. queryOptMsgDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryOptMsgDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryOptMsgDetail(long)
方法说明 根据操作日志ID查询操作日志信息
接口类型 Service API
适用场景 查询操作日志详情
# 方法定义
/**
 * 根据操作日志ID查询操作日志信息
 * @param optMsgID 操作日志ID
 * @return 操作日志对象
 * @throws WFApiException
 */
public WFOptMsg queryOptMsgDetail(long optMsgID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
optMsgID long 是 操作日志ID
# 返回值

返回类型： WFOptMsg

# 5. queryProcInstOptMsgs 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryProcInstOptMsgs
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryProcInstOptMsgs(long, PageCond)
方法说明 根据流程实例ID查询所有的流程实例操作
接口类型 Service API
适用场景 查询流程实例操作日志
# 方法定义
/**
 * 根据流程实例ID查询所有的流程实例操作
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 流程实例操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryProcInstOptMsgs(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 6. queryActivityInstOptMsgs 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryActivityInstOptMsgs
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryActivityInstOptMsgs(long, PageCond)
方法说明 根据流程实例ID查询所有的活动实例操作
接口类型 Service API
适用场景 查询活动实例操作日志
# 方法定义
/**
 * 根据流程实例ID查询所有的活动实例操作
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 活动实例操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryActivityInstOptMsgs(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 7. queryWorkItemOptMsgs 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryWorkItemOptMsgs
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryWorkItemOptMsgs(long, PageCond)
方法说明 根据流程实例ID查询所有的工作项操作
接口类型 Service API
适用场景 查询工作项操作日志
# 方法定义
/**
 * 根据流程实例ID查询所有的工作项操作
 * @param activityInstID 活动实例ID
 * @param pageCond 分页信息
 * @return 工作项操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryWorkItemOptMsgs(long activityInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 8. queryOptMsgsByProcessId 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryOptMsgsByProcessId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryOptMsgsByProcessId(long, String, PageCond)
方法说明 根据流程实例ID和操作类型查询所有的操作日志
接口类型 Service API
适用场景 查询特定流程实例的操作日志
# 方法定义
/**
 * 根据流程实例ID和操作类型查询所有的操作日志
 * @param processInstID 流程实例ID
 * @param optType 操作类型
 * @param pageCond 分页信息
 * @return 操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryOptMsgsByProcessId(long processInstID, String optType, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 9. queryOptMsgsByActivityId 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryOptMsgsByActivityId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryOptMsgsByActivityId(long, String, PageCond)
方法说明 根据活动实例ID和操作类型查询所有的操作日志
接口类型 Service API
适用场景 查询特定活动实例的操作日志
# 方法定义
/**
 * 根据活动实例ID和操作类型查询所有的操作日志
 * @param activityInstID 活动实例ID
 * @param optType 操作类型
 * @param pageCond 分页信息
 * @return 操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryOptMsgsByActivityId(long activityInstID, String optType, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 10. queryOptMsgsByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryOptMsgsByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryOptMsgsByWorkItemId(long, String, PageCond)
方法说明 根据工作项ID和操作类型查询所有的工作项操作
接口类型 Service API
适用场景 查询特定工作项的操作日志
# 方法定义
/**
 * 根据工作项ID和操作类型查询所有的工作项操作
 * @param workItemID 工作项ID
 * @param optType 操作类型
 * @param pageCond 分页信息
 * @return 工作项操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryOptMsgsByWorkItemId(long workItemID, String optType, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
optType String 是 操作类型（值范围：SUBMIT("提交"),SUSPEND("挂起"), RESUME("恢复"), TERMINATE("终止"), REDO("重做"), PRESS("催办"), REJECT("拒绝"), REASSIGN("改派"), DELEG("代办"), HELP("协办"), WITHDRAW("收回"), BACKACTIVITY("回退"), APPROVAL("审批"), ANNOTATE("批注"), RESTART("重启"),TIMEOUTREMIND("超时预警"),SAVE("暂存"), NOTIFICATION("通知"), GET("领取"),CANCELGET("取消领取"),SIGN("加签")）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 11. queryOptMsgs 方法接口文档

# 基本信息
项目 说明
接口名称 WFOptMsgManager.queryOptMsgs
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFOptMsgManager.queryOptMsgs(WFOptMsg, PageCond)
方法说明 通过查询模板查询操作日志
接口类型 Service API
适用场景 根据查询模板查询操作日志
# 方法定义
/**
 * 通过查询模板查询操作日志
 * @param wfOptMsg 查询模板
 * @param pageCond 分页信息
 * @return 操作日志列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryOptMsgs(WFOptMsg wfOptMsg, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
wfOptMsg WFOptMsg 是 查询模板
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 二十四、WFParticipantQueryManager

# 1. queryParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFParticipantQueryManager.queryParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFParticipantQueryManager.queryParticipants(WFParticipant, PageCond, Map<String, Object>)
方法说明 根据参与者信息查询参与者
接口类型 Service API
适用场景 查询参与者信息
# 方法定义
/**
 * 根据参与者信息查询参与者
 * @param participant 参与者信息
 * @param page 分页信息
 * @param ext 扩展参数
 * @return 参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> queryParticipants(WFParticipant participant, PageCond page, Map<String, Object> ext) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
participant WFParticipant 是 参与者信息
page PageCond 是 分页信息
ext Map<String, Object> 是 扩展参数
# 返回值

返回类型： List<WFParticipant>

# 二十五、WFPermissionManager

# 1. getPermissions 方法接口文档

# 基本信息
项目 说明
接口名称 WFPermissionManager.getPermissions
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFPermissionManager.getPermissions(String)
方法说明 获取用户具有的权限列表
接口类型 Service API
适用场景 权限查询
# 方法定义
/**
 * 获取用户具有的权限列表
 * @param userID 用户ID
 * @return 权限列表
 * @throws WFApiException
 */
public List<String> getPermissions(String userID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userID String 是 用户ID
# 返回值

返回类型： List<String>

# 2. hasPermission 方法接口文档

# 基本信息
项目 说明
接口名称 WFPermissionManager.hasPermission
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFPermissionManager.hasPermission(String, String)
方法说明 判断用户是否具有某权限
接口类型 Service API
适用场景 权限检查
# 方法定义
/**
 * 判断用户是否具有某权限
 * @param userID 用户ID
 * @param permType 权限类型
 * @return 是否具有权限
 * @throws WFApiException
 */
public boolean hasPermission(String userID, String permType) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userID String 是 用户ID
permType String 是 权限类型（bpsclient 或者 bpsmanager）
# 返回值

返回类型： boolean

# 3. validate 方法接口文档

# 基本信息
项目 说明
接口名称 WFPermissionManager.validate
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFPermissionManager.validate(String, String, Map)
方法说明 验证用户身份和权限
接口类型 Service API
适用场景 用户身份验证
# 方法定义
/**
 * 验证用户身份和权限
 * @param userID 用户ID
 * @param pwd 密码
 * @param attributes 拓展属性
 * @return 是否验证通过
 * @throws WFApiException
 */
public boolean validate(String userID, String pwd, Map attributes) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
userID String 是 用户ID
pwd String 是 密码
attributes Map 是 拓展属性
# 返回值

返回类型： boolean

# 二十六、WFProcessInstManager

# 1. addAndStartProcessWithParentActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.addAndStartProcessWithParentActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.addAndStartProcessWithParentActivityInstId(String, String, String, long, long, boolean, Object[])
方法说明 创建并启动工作流实例，同时将它作为子流程实例关联到指定的父流程实例上，返回流程实例ID
接口类型 Service API
适用场景 创建并启动子流程实例
# 方法定义
/**
 * 创建并启动工作流实例，同时将它作为子流程实例关联到指定的父流程实例上，返回流程实例ID
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param parentProcessInstID 父流程实例ID
 * @param actInstID 活动实例ID
 * @param isTransactionSplit 是否启用事务分割功能
 * @param params 参数
 * @return 流程实例ID
 * @throws WFApiException
 */
public long addAndStartProcessWithParentActivityInstId(String processDefName, String processInstName, String processInstDesc, long parentProcessInstID, long actInstID, boolean isTransactionSplit, Object[] params) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
parentProcessInstID long 是 父流程实例ID
actInstID long 是 活动实例ID
isTransactionSplit boolean 是 是否启用事务分割功能
params Object[] 是 参数
# 返回值

返回类型： long

# 2. changeProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.changeProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.changeProcess(long, long)
方法说明 根据流程实例ID，更换该流程实例的流程定义模板
接口类型 Service API
适用场景 更换流程实例的流程定义
# 方法定义
/**
 * 根据流程实例ID，更换该流程实例的流程定义模板
 * @param processInstID 流程实例ID
 * @param processDefID 流程定义ID
 * @throws WFApiException
 */
public void changeProcess(long processInstID, long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
processDefID long 是 流程定义ID
# 返回值

无返回值 void

# 3. changeProcessInstState 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.changeProcessInstState
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.changeProcessInstState(long, int)
方法说明 改变一个流程实例的状态
接口类型 Service API
适用场景 修改流程实例状态
# 方法定义
/**
 * 改变一个流程实例的状态
 * @param processInstID 流程实例ID
 * @param destState 目标状态
 * @throws WFApiException
 */
public void changeProcessInstState(long processInstID, int destState) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
destState int 是 目标状态（值范围：1—未启动
2—运行
3—挂起
7—完成
8—终止
9—取消
10—待激活）
# 返回值

无返回值 void

# 4. clearProcessInstTimeLimit 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.clearProcessInstTimeLimit
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.clearProcessInstTimeLimit(long, String)
方法说明 关闭流程实例上的超时时间和超时提醒
接口类型 Service API
适用场景 清除流程实例的超时设置
# 方法定义
/**
 * 关闭流程实例上的超时时间和超时提醒
 * @param processInstID 流程实例ID
 * @param strategy 清除策略
 * @throws WFApiException
 */
public void clearProcessInstTimeLimit(long processInstID, String strategy) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
strategy String 是 清除策略（值范围：PROC_OVERTIME_REMIND—流程超时
PROCESS_PRE_REMIND—流程预警
all—全部）
# 返回值

无返回值 void

# 5. createAndStartProcessInstance2 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstance2
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstance2(String, String, String)
方法说明 创建并启动工作流实例
接口类型 Service API
适用场景 创建并启动工作流实例
# 方法定义
/**
 * 创建并启动工作流实例
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcessInstance2(String processDefName, String processInstName, String processInstDesc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
# 返回值

返回类型： long

# 6. createAndStartProcessInstance1 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstance1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstance1(String, String, String, boolean)
方法说明 创建并启动工作流实例，并设置事务分割功能
接口类型 Service API
适用场景 创建并启动工作流实例，并设置事务分割功能
# 方法定义
/**
 * 创建并启动工作流实例，并设置事务分割功能
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param transcationSpan 是否分割事务
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcessInstance1(String processDefName, String processInstName, String processInstDesc, boolean transcationSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
transcationSpan boolean 是 是否分割事务
# 返回值

返回类型： long

# 7. createAndStartProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstance(String, String, String, boolean, Object[])
方法说明 创建并启动工作流实例，并设置相关数据
接口类型 Service API
适用场景 创建并启动工作流实例，并设置相关数据
# 方法定义
/**
 * 创建并启动工作流实例，并设置相关数据
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param transcationSpan 是否分割事务
 * @param params 相关数据
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcessInstance(String processDefName, String processInstName, String processInstDesc, boolean transcationSpan, Object[] params) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
transcationSpan boolean 是 是否分割事务
params Object[] 是 相关数据
# 返回值

返回类型： long

# 8. createAndStartProcessInstanceByVersion1 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstanceByVersion1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstanceByVersion1(String, String, String, String)
方法说明 根据流程定义名称和版本信息创建并启动工作流实例
接口类型 Service API
适用场景 根据流程定义名称和版本信息创建并启动工作流实例
# 方法定义
/**
 * 根据流程定义名称和版本信息创建并启动工作流实例
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcessInstanceByVersion1(String processDefName, String processInstName, String processInstDesc, String versionSign) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
# 返回值

返回类型： long

# 9. createAndStartProcessInstanceByVersion 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstanceByVersion
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstanceByVersion(String, String, String, String, boolean)
方法说明 根据流程定义名称和版本信息创建并启动工作流实例，并设置事务分割功能
接口类型 Service API
适用场景 根据流程定义名称和版本信息创建并启动工作流实例，并设置事务分割功能
接口类型 Service API
适用场景 根据流程定义名称和版本信息创建并启动工作流实例，并设置事务分割功能
# 方法定义
/**
 * 根据流程定义名称和版本信息创建并启动工作流实例，并设置事务分割功能
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @param transcationSpan 是否分割事务
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcessInstanceByVersion(String processDefName, String processInstName, String processInstDesc, String versionSign, boolean transcationSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
transcationSpan boolean 是 是否分割事务
# 返回值

返回类型： long

# 10. createAndStartProcessInstanceWithId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessInstanceWithId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessInstanceWithId(String, String, String, String, boolean, Object[], Map<String, Object>, long)
方法说明 根据流程定义名称、版本信息、流程参数、事务分割功能和流程实例ID创建并启动工作流实例
接口类型 Service API
适用场景 根据流程定义名称、版本信息、流程参数、事务分割功能和流程实例ID创建并启动工作流实例
接口类型 Service API
适用场景 根据流程定义名称、版本信息、流程参数、事务分割功能和流程实例ID创建并启动工作流实例
# 方法定义
/**
 * 根据流程定义名称、版本信息、流程参数、事务分割功能和流程实例ID创建并启动工作流实例
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @param transcationSpan 是否分割事务
 * @param params 流程参数
 * @param map 相关数据
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void createAndStartProcessInstanceWithId(String processDefName, String processInstName, String processInstDesc, String versionSign, boolean transcationSpan, Object[] params, Map<String, Object> map, long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
transcationSpan boolean 是 是否分割事务
params Object[] 是 流程参数
map Map<String, Object> 是 相关数据
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 11. createAndStartProcessWithParentActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcessWithParentActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcessWithParentActivityInstId(String, String, String, long, long, boolean, Object[])
方法说明 创建并启动工作流实例，并将其作为子流程实例关联到指定的父流程实例上
接口类型 Service API
适用场景 创建并启动子流程实例，并将其关联到父流程实例上
# 方法定义
/**
 * 创建并启动工作流实例，并将其作为子流程实例关联到指定的父流程实例上
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param parentProcessInstID 父流程实例ID
 * @param actInstID 活动实例ID
 * @param isTransactionSplit 是否启用事务分割功能
 * @param params 参数
 * @throws WFApiException
 */
public void createAndStartProcessWithParentActivityInstId(String processDefName, String processInstName, String processInstDesc, long parentProcessInstID, long actInstID, boolean isTransactionSplit, Object[] params) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
parentProcessInstID long 是 父流程实例ID
actInstID long 是 活动实例ID
isTransactionSplit boolean 是 是否启用事务分割功能
params Object[] 是 参数
# 返回值

无返回值 void

# 12. createAndStartProcInstAndSetRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcInstAndSetRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcInstAndSetRelativeData(String, String, String, boolean, Map<String, Object>)
方法说明 创建并启动流程实例，并设置相关数据
接口类型 Service API
适用场景 创建并启动流程实例，并设置相关数据
# 方法定义
/**
 * 创建并启动流程实例，并设置相关数据
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param transcationSpan 是否分割事务
 * @param map 相关数据
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcInstAndSetRelativeData(String processDefName, String processInstName, String processInstDesc, boolean transcationSpan, Map<String, Object> map) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
transcationSpan boolean 是 是否分割事务
map Map<String, Object> 是 相关数据
# 返回值

返回类型： long

# 13. createAndStartProcInstByVersionAndSetRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createAndStartProcInstByVersionAndSetRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createAndStartProcInstByVersionAndSetRelativeData(String, String, String, String, boolean, Map<String, Object>)
方法说明 根据流程定义版本创建并启动流程实例，并设置相关数据
接口类型 Service API
适用场景 根据流程定义版本创建并启动流程实例，并设置相关数据
# 方法定义
/**
 * 根据流程定义版本创建并启动流程实例，并设置相关数据
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @param transcationSpan 是否分割事务
 * @param map 相关数据
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createAndStartProcInstByVersionAndSetRelativeData(String processDefName, String processInstName, String processInstDesc, String versionSign, boolean transcationSpan, Map<String, Object> map) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
transcationSpan boolean 是 是否分割事务
map Map<String, Object> 是 相关数据
# 返回值

返回类型： long

# 14. createProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createProcessInstance(String, String, String)
方法说明 创建工作流实例
接口类型 Service API
适用场景 创建工作流实例
# 方法定义
/**
 * 创建工作流实例
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createProcessInstance(String processDefName, String processInstName, String processInstDesc) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
# 返回值

返回类型： long

# 15. createProcessInstanceByVersion 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createProcessInstanceByVersion
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createProcessInstanceByVersion(String, String, String, String)
方法说明 根据流程定义版本创建工作流实例
接口类型 Service API
适用场景 根据流程定义版本创建工作流实例
接口类型 Service API
适用场景 根据流程定义版本创建工作流实例
# 方法定义
/**
 * 根据流程定义版本创建工作流实例
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createProcessInstanceByVersion(String processDefName, String processInstName, String processInstDesc, String versionSign) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
# 返回值

返回类型： long

# 16. createProcessInstanceWithId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createProcessInstanceWithId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createProcessInstanceWithId(String, String, String, String, long)
方法说明 根据流程定义版本创建工作流实例，并设置流程实例ID
接口类型 Service API
适用场景 根据流程定义版本创建工作流实例，并设置流程实例ID
接口类型 Service API
适用场景 根据流程定义版本创建工作流实例，并设置流程实例ID
# 方法定义
/**
 * 根据流程定义版本创建工作流实例，并设置流程实例ID
 * @param processDefName 流程定义名称
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param versionSign 流程定义版本信息
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void createProcessInstanceWithId(String processDefName, String processInstName, String processInstDesc, String versionSign, long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
versionSign String 是 流程定义版本信息
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 17. deleteProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.deleteProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.deleteProcessInstance(long)
方法说明 根据流程实例ID删除流程实例
接口类型 Service API
适用场景 删除流程实例
# 方法定义
/**
 * 根据流程实例ID删除流程实例
 * @param processInstID 流程实例ID
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： int

# 18. deleteProcessInstBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.deleteProcessInstBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.deleteProcessInstBatch(long[])
方法说明 根据流程实例ID批量删除流程实例
接口类型 Service API
适用场景 批量删除流程实例
# 方法定义
/**
 * 根据流程实例ID批量删除流程实例
 * @param processInstID 流程实例ID数组
 * @return 删除结果
 * @throws WFApiException
 */
public int deleteProcessInstBatch(long[] processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long[] 是 流程实例ID数组
# 返回值

返回类型： int

# 19. excuteAnnotateProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.excuteAnnotateProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.excuteAnnotateProcessInstance(long, String)
方法说明 执行流程实例批注
接口类型 Service API
适用场景 执行流程实例批注
# 方法定义
/**
 * 执行流程实例批注
 * @param processInstID 流程实例ID
 * @param annotateInfo 批注信息
 * @throws WFApiException
 */
public void excuteAnnotateProcessInstance(long processInstID, String annotateInfo) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
annotateInfo String 是 批注信息
# 返回值

无返回值 void

# 20. excutePressProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.excutePressProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.excutePressProcessInstance(long, String)
方法说明 执行流程实例催办
接口类型 Service API
适用场景 执行流程实例催办
# 方法定义
/**
 * 执行流程实例催办
 * @param processInstID 流程实例ID
 * @param pressReason 催办原因
 * @throws WFApiException
 */
public void excutePressProcessInstance(long processInstID, String pressReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pressReason String 是 催办原因
# 返回值

无返回值 void

# 21. generateProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.generateProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.generateProcessInstId(String, String)
方法说明 根据流程定义名称和版本信息生成流程实例ID
接口类型 Service API
适用场景 生成流程实例ID
# 方法定义
/**
 * 根据流程定义名称和版本信息生成流程实例ID
 * @param processDefName 流程定义名称
 * @param versionSign 流程定义版本信息
 * @return 流程实例ID
 * @throws WFApiException
 */
public long generateProcessInstId(String processDefName, String versionSign) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
versionSign String 是 流程定义版本信息
# 返回值

返回类型： long

# 22. getNextActivitiesMaybeArrived 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getNextActivitiesMaybeArrived
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getNextActivitiesMaybeArrived(long)
方法说明 查询满足条件的后继活动，可以查询出非路由活动的各种类型的后继活动
接口类型 Service API
适用场景 查询后继活动
# 方法定义
/**
 * 查询满足条件的后继活动，可以查询出非路由活动的各种类型的后继活动
 * @param actInstID 活动实例ID
 * @return 后继活动列表
 * @throws WFApiException
 */
public List<WFActivityDefine> getNextActivitiesMaybeArrived(long actInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
# 返回值

返回类型： List<WFActivityDefine>

# 23. getProbableParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getProbableParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getProbableParticipants(long, String)
方法说明 根据当前相关数据解析某个活动定义的参与者
接口类型 Service API
适用场景 解析活动定义的参与者
# 方法定义
/**
 * 根据当前相关数据解析某个活动定义的参与者
 * @param processInstID 流程实例ID
 * @param activityID 活动ID
 * @return 参与者列表
 * @throws WFApiException
 */
public List<WFParticipant> getProbableParticipants(long processInstID, String activityID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityID String 是 活动ID
# 返回值

返回类型： List<WFParticipant>

# 24. getProcessInstElapsedTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getProcessInstElapsedTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getProcessInstElapsedTime(long)
方法说明 返回该流程实例的总体有效执行时间
接口类型 Service API
适用场景 计算流程实例的执行时间
# 方法定义
/**
 * 返回该流程实例的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的流程执行时间
 * @param processInstID 流程实例ID
 * @return 流程实例的执行时间
 * @throws WFApiException
 */
public long getProcessInstElapsedTime(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： long

# 25. getProcessInstNextStates 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getProcessInstNextStates
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getProcessInstNextStates(long)
方法说明 查询流程实例的可转换状态列表
接口类型 Service API
适用场景 查询流程实例的可转换状态
# 方法定义
/**
 * 查询流程实例的可转换状态列表
 * @param processInstID 流程实例ID
 * @return 可转换状态列表
 * @throws WFApiException
 */
public List<Integer> getProcessInstNextStates(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： List<Integer>

# 26. getProcessInstState 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getProcessInstState
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getProcessInstState(long)
方法说明 查询流程实例的状态
接口类型 Service API
适用场景 查询流程实例的状态
# 方法定义
/**
 * 查询流程实例的状态
 * @param processInstID 流程实例ID
 * @return 流程实例的状态
 * @throws WFApiException
 */
public int getProcessInstState(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： int

# 27. queryAnnotateListByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryAnnotateListByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryAnnotateListByProcessInstId(long, PageCond)
方法说明 查询流程实例的批注列表
接口类型 Service API
适用场景 查询流程实例的批注列表
# 方法定义
/**
 * 查询流程实例的批注列表
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 批注列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryAnnotateListByProcessInstId(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 28. queryApprovalMsgByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryApprovalMsgByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryApprovalMsgByProcessInstId(long, PageCond)
方法说明 根据流程实例ID查询审批意见列表
接口类型 Service API
适用场景 查询流程实例的审批意见列表
# 方法定义
/**
 * 根据流程实例ID查询审批意见列表
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 审批意见列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryApprovalMsgByProcessInstId(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 29. queryPressListByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryPressListByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryPressListByProcessInstId(long, PageCond)
方法说明 查询流程实例的催办列表
接口类型 Service API
适用场景 查询流程实例的催办列表
# 方法定义
/**
 * 查询流程实例的催办列表
 * @param processInstID 流程实例ID
 * @param pageCond 分页信息
 * @return 催办列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryPressListByProcessInstId(long processInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 30. queryProcessInstDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryProcessInstDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryProcessInstDetail(long)
方法说明 查询流程实例的详细信息
接口类型 Service API
适用场景 查询流程实例的详细信息
# 方法定义
/**
 * 查询流程实例的详细信息
 * @param processInstID 流程实例ID
 * @return 流程实例详细信息
 * @throws WFApiException
 */
public WFProcessInst queryProcessInstDetail(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： WFProcessInst

# 31. queryProcessInstsByBizCatalogUuid 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryProcessInstsByBizCatalogUuid
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryProcessInstsByBizCatalogUuid(String, String, String, boolean, PageCond)
方法说明 根据业务目录ID查询业务流程实例，支持嵌套和权限查询
接口类型 Service API
适用场景 查询业务流程实例
# 方法定义
/**
 * 根据业务目录ID查询业务流程实例，支持嵌套和权限查询
 * @param personID 用户ID
 * @param authType 权限类型
 * @param parentCatalogID 父业务目录ID
 * @param multilevel 是否嵌套查询
 * @param pageCond 分页信息
 * @return 业务流程实例列表
 * @throws WFApiException
 */
public List<WFProcessInst> queryProcessInstsByBizCatalogUuid(String personID, String authType, String parentCatalogID, boolean multilevel, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 用户ID
authType String 是 权限类型
parentCatalogID String 是 父业务目录ID
multilevel boolean 是 是否嵌套查询
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessInst>

# 32. queryProcessInstsByProcessId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryProcessInstsByProcessId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryProcessInstsByProcessId(long, PageCond)
方法说明 根据流程定义ID获取流程实例列表
接口类型 Service API
适用场景 查询流程实例列表
# 方法定义
/**
 * 根据流程定义ID获取流程实例列表
 * @param processDefID 流程定义ID
 * @param pageCond 分页信息
 * @return 流程实例列表
 * @throws WFApiException
 */
public List<WFProcessInst> queryProcessInstsByProcessId(long processDefID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessInst>

# 33. queryProcessInstsWithActivityState 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryProcessInstsWithActivityState
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryProcessInstsWithActivityState(long, String, int, PageCond)
方法说明 按照流程定义ID、活动定义ID和状态查询所有的流程实例
接口类型 Service API
适用场景 查询特定活动和状态的流程实例
# 方法定义
/**
 * 按照流程定义ID、活动定义ID和状态查询所有的流程实例
 * @param processDefID 流程定义ID
 * @param activityDefID 活动定义ID
 * @param activityState 活动状态
 * @param pageCond 分页信息
 * @return 流程实例列表
 * @throws WFApiException
 */
public List<WFProcessInst> queryProcessInstsWithActivityState(long processDefID, String activityDefID, int activityState, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
activityDefID String 是 活动定义ID
activityState int 是 活动状态（值范围：1—未启动
2—运行
3—挂起
7—完成
8—终止
9—取消
10—待激活
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessInst>

# 34. querySubProcessInstIdsByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.querySubProcessInstIdsByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.querySubProcessInstIdsByActivityInstId(long)
方法说明 根据子流程活动实例ID查询活动对应的子流程实例ID列表
接口类型 Service API
适用场景 查询子流程实例ID列表
# 方法定义
/**
 * 根据子流程活动实例ID查询活动对应的子流程实例ID列表
 * @param subActInstID 子流程活动实例ID
 * @return 子流程实例ID列表
 * @throws WFApiException
 */
public long[] querySubProcessInstIdsByActivityInstId(long subActInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
subActInstID long 是 子流程活动实例ID
# 返回值

返回类型： long[]

# 35. refreshProcessInstCache 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.refreshProcessInstCache
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.refreshProcessInstCache(long[])
方法说明 批量更新流程实例缓存
接口类型 Service API
适用场景 更新流程实例缓存
# 方法定义
/**
 * 批量更新流程实例缓存
 * @param procInstIDs 流程实例ID数组
 * @return 更新结果
 * @throws WFApiException
 */
public boolean refreshProcessInstCache(long[] procInstIDs) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procInstIDs long[] 是 流程实例ID数组
# 返回值

返回类型： boolean

# 36. restartFinishedProcessInst 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.restartFinishedProcessInst
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.restartFinishedProcessInst(long)
方法说明 重启已完成的流程实例（未转历史）
接口类型 Service API
适用场景 重启已完成的流程实例
# 方法定义
/**
 * 重启已完成的流程实例（未转历史）
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void restartFinishedProcessInst(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 37. restartFinishedProcessInst1 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.restartFinishedProcessInst1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.restartFinishedProcessInst1(long, String, WFParticipant[], boolean)
方法说明 重启已完成的流程实例（未转历史），激活指定活动并指派参与者
接口类型 Service API
适用场景 重启已完成的流程实例并激活指定活动
# 方法定义
/**
 * 重启已完成的流程实例（未转历史），激活指定活动并指派参与者
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @param participants 参与者集合
 * @return 流程实例ID
 * @throws WFApiException
 */
public long restartFinishedProcessInst1(long processInstID, String activityDefID, WFParticipant[] participants) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
participants WFParticipant[] 是 参与者集合
# 返回值

返回类型： long

# 38. resumeProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.resumeProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.resumeProcessInstance(long)
方法说明 恢复某个被挂起的流程实例
接口类型 Service API
适用场景 恢复挂起的流程实例
# 方法定义
/**
 * 恢复某个被挂起的流程实例
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void resumeProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 39. setProcessInstAttributeBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.setProcessInstAttributeBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.setProcessInstAttributeBatch(long, Map<String, Object>)
方法说明 批量修改流程实例的基本属性
接口类型 Service API
适用场景 批量修改流程实例属性
# 方法定义
/**
 * 批量修改流程实例的基本属性
 * @param processInstID 流程实例ID
 * @param attrubuteMap 属性集合
 * @throws WFApiException
 */
public void setProcessInstAttributeBatch(long processInstID, Map<String, Object> attrubuteMap) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
attrubuteMap Map<String, Object> 是 属性集合
# 返回值

无返回值 void

# 40. setProcessInstTimeLimit 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.setProcessInstTimeLimit
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.setProcessInstTimeLimit(long, WFTimePeriod, WFTimePeriod)
方法说明 修改指定流程实例的时间限制
接口类型 Service API
适用场景 修改流程实例的时间限制
# 方法定义
/**
 * 修改指定流程实例的时间限制
 * @param processInstID 流程实例ID
 * @param timeLimit 时间限制
 * @param remindTime 提醒时间
 * @throws WFApiException
 */
public void setProcessInstTimeLimit(long processInstID, WFTimePeriod timeLimit, WFTimePeriod remindTime) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
timeLimit WFTimePeriod 是 时间限制
remindTime WFTimePeriod 是 提醒时间
# 返回值

无返回值 void

# 41. startProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.startProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.startProcessInstance(long)
方法说明 启动工作流实例
接口类型 Service API
适用场景 启动工作流实例
# 方法定义
/**
 * 启动工作流实例
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void startProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 42. startProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.startProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.startProcessInstance(long, boolean, Object[])
方法说明 启动工作流实例，并设置事务分割功能
接口类型 Service API
适用场景 启动工作流实例，并设置事务分割功能
# 方法定义
/**
 * 启动工作流实例，并设置事务分割功能
 * @param processInstID 流程实例ID
 * @param isTransactionSplit 是否启用事务分割功能
 * @param params 流程参数
 * @throws WFApiException
 */
public void startProcessInstance(long processInstID, boolean isTransactionSplit, Object[] params) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
isTransactionSplit boolean 是 是否启用事务分割功能
params Object[] 是 流程参数
# 返回值

无返回值 void

# 43. startProcessInstanceWithBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.startProcessInstanceWithBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.startProcessInstanceWithBizInfo(long, boolean, Object[], String, Map<String, Object>)
方法说明 启动工作流实例，并设置业务冗余数据
接口类型 Service API
适用场景 启动工作流实例，并设置业务冗余数据
# 方法定义
/**
 * 启动工作流实例，并设置业务冗余数据
 * @param processInstID 流程实例ID
 * @param isTransactionSplit 是否启用事务分割功能
 * @param params 流程参数
 * @param tableName 表名
 * @param bizInfo 业务冗余数据
 * @throws WFApiException
 */
public void startProcessInstanceWithBizInfo(long processInstID, boolean isTransactionSplit, Object[] params, String tableName, Map<String, Object> bizInfo) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
isTransactionSplit boolean 是 是否启用事务分割功能
params Object[] 是 流程参数
tableName String 是 表名
bizInfo Map<String, Object> 是 业务冗余数据
# 返回值

无返回值 void

# 44. startProcessInstAndFinishFirstWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.startProcessInstAndFinishFirstWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.startProcessInstAndFinishFirstWorkItem(long, boolean, Object[])
方法说明 启动工作流实例，并完成第一个工作项
接口类型 Service API
适用场景 启动工作流实例，并完成第一个工作项
# 方法定义
/**
 * 启动工作流实例，并完成第一个工作项
 * @param processInstID 流程实例ID
 * @param isTransactionSplit 是否启用事务分割功能
 * @param params 流程参数
 * @throws WFApiException
 */
public void startProcessInstAndFinishFirstWorkItem(long processInstID, boolean isTransactionSplit, Object[] params) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
isTransactionSplit boolean 是 是否启用事务分割功能
params Object[] 是 流程参数
# 返回值

无返回值 void

# 45. suspendProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.suspendProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.suspendProcessInstance(long)
方法说明 挂起某个流程实例
接口类型 Service API
适用场景 挂起流程实例
# 方法定义
/**
 * 挂起某个流程实例
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void suspendProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 46. terminateProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.terminateProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.terminateProcessInstance(long)
方法说明 终止某个流程实例
接口类型 Service API
适用场景 终止流程实例
# 方法定义
/**
 * 终止某个流程实例
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void terminateProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 47. terminateProcessInstanceAndCompensate 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.terminateProcessInstanceAndCompensate
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.terminateProcessInstanceAndCompensate(long)
方法说明 终止某个流程实例，并调用流程和上活动已经配置的回退补偿
接口类型 Service API
适用场景 终止流程实例并执行回退补偿
# 方法定义
/**
 * 终止某个流程实例，并调用流程和上活动已经配置的回退补偿
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void terminateProcessInstanceAndCompensate(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 48. upgradeProcessInstance 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.upgradeProcessInstance
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.upgradeProcessInstance(long)
方法说明 升级一个流程实例
接口类型 Service API
适用场景 升级流程实例
# 方法定义
/**
 * 升级一个流程实例
 * @param processInstID 流程实例ID
 * @throws WFApiException
 */
public void upgradeProcessInstance(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

无返回值 void

# 49. createProcessInstanceAndFinishFirstWorkItemWithStrategy 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.createProcessInstanceAndFinishFirstWorkItemWithStrategy
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.createProcessInstanceAndFinishFirstWorkItemWithStrategy(String, String, String, String, NextActivityInfo[], String, Map<String, Object>, String[])
方法说明 根据策略创建流程并启动流程实例并完成第一个工作项
接口类型 Service API
适用场景 根据策略创建并启动流程实例，并完成第一个工作项
# 方法定义
/**
 * 根据策略创建流程并启动流程实例并完成第一个工作项
 * @param processDefName 流程定义名称
 * @param processVersion 流程版本
 * @param processInstName 流程实例名称
 * @param processInstDesc 流程实例描述
 * @param nextActivityInfos 后续活动信息
 * @param submitType 提交类型
 * @param map 相关数据
 * @param reviewPersons 审核人员
 * @return 流程实例ID
 * @throws WFApiException
 */
public long createProcessInstanceAndFinishFirstWorkItemWithStrategy(String processDefName, String processVersion, String processInstName, String processInstDesc, NextActivityInfo[] nextActivityInfos, String submitType, Map<String, Object> map, String[] reviewPersons) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
processVersion String 是 流程版本
processInstName String 是 流程实例名称
processInstDesc String 是 流程实例描述
nextActivityInfos NextActivityInfo[] 是 后续活动信息
submitType String 是 提交类型
map Map<String, Object> 是 相关数据
reviewPersons String[] 是 审核人员
# 返回值

返回类型： long

# 50. getNextActiveAndParticipants 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.getNextActiveAndParticipants
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.getNextActiveAndParticipants(long, Map<String, Object>, boolean, boolean, boolean, String)
方法说明 获取后续活动定义及参与者
接口类型 Service API
适用场景 获取后续活动定义及参与者
# 方法定义
/**
 * 获取后续活动定义及参与者
 * @param workItemId 工作项ID
 * @param relaData 相关数据
 * @param showLeafParticipant 是否显示叶子参与者
 * @param ignoreAppointedParticipant 是否忽略已指派的参与者
 * @param passAutoAvyFlag 是否传递自动分配标志
 * @param subflowStrategy 子流程策略
 * @return 后续活动定义及参与者列表
 * @throws WFApiException
 */
public List<WFActivityDefine> getNextActiveAndParticipants(long workItemId, Map<String, Object> relaData, boolean showLeafParticipant, boolean ignoreAppointedParticipant, boolean passAutoAvyFlag, String subflowStrategy) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
relaData Map<String, Object> 是 相关数据
showLeafParticipant boolean 是 是否显示叶子参与者
ignoreAppointedParticipant boolean 是 是否忽略已指派的参与者
passAutoAvyFlag boolean 是 是否传递自动分配标志
subflowStrategy String 是 子流程策略（值范围：1—预提交遇子流程跳过
2—预提交遇子流程停止）
# 返回值

返回类型： List<WFActivityDefine>

# 51. queryStartedProcessInstById 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryStartedProcessInstById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryStartedProcessInstById(String, long)
方法说明 根据员工ID和流程实例ID查询单个发起流程实例信息
接口类型 Service API
适用场景 查询单个发起流程实例信息
# 方法定义
/**
 * 根据员工ID和流程实例ID查询单个发起流程实例信息
 * @param personId 员工ID
 * @param processInstId 流程实例ID
 * @return 发起流程实例信息
 * @throws WFApiException
 */
public WFProcessInstInfo queryStartedProcessInstById(String personId, long processInstId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 员工ID
processInstId long 是 流程实例ID
# 返回值

返回类型： WFProcessInstInfo

# 52. queryStartedProcessInsts 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryStartedProcessInsts
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryStartedProcessInsts(WorkitemQueryInfo, PageCond)
方法说明 查询当前用户已发起的流程列表
接口类型 Service API
适用场景 查询当前用户已发起的流程列表
# 方法定义
/**
 * 查询当前用户已发起的流程列表
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 已发起的流程列表
 * @throws WFApiException
 */
public List<WFProcessInstInfo> queryStartedProcessInsts(WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessInstInfo>

# 53. queryStartedProcessInstsInTaskCenter 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessInstManager.queryStartedProcessInstsInTaskCenter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessInstManager.queryStartedProcessInstsInTaskCenter(WorkitemQueryInfo, PageCond)
方法说明 查询当前用户已发起的流程列表-任务中心专用
接口类型 Service API
适用场景 查询当前用户已发起的流程列表-任务中心专用
# 方法定义
/**
 * 查询当前用户已发起的流程列表-任务中心专用
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 已发起的流程列表
 * @throws WFApiException
 */
public List<WFProcessInstInfo> queryStartedProcessInstsInTaskCenter(WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessInstInfo>

# 二十七、WFProcessLogManager

# 1. addProcessLog 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessLogManager.addProcessLog
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessLogManager.addProcessLog(long, String, String, String, Map<String, String>)
方法说明 记录代理代办相关操作的日志
接口类型 Service API
适用场景 记录代理代办操作的日志
# 方法定义
/**
 * 记录代理代办相关操作的日志
 * @param workItemID 工作项ID
 * @param operateType 操作类型
 * @param operatorID 操作人员ID
 * @param content 内容
 * @param extendAttributes 附加属性
 * @throws WFApiException
 */
public void addProcessLog(long workItemID, String operateType, String operatorID, String content, Map<String, String> extendAttributes) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
operateType String 是 操作类型
operatorID String 是 操作人员ID
content String 是 内容
extendAttributes Map<String, String> 是 附加属性
# 返回值

无返回值 void

# 2. getProcessLogByActivityId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessLogManager.getProcessLogByActivityId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessLogManager.getProcessLogByActivityId(long, String)
方法说明 根据活动定义获取该活动定义代理代办相关操作的日志
接口类型 Service API
适用场景 查询活动定义的代理代办日志
# 方法定义
/**
 * 根据活动定义获取该活动定义代理代办相关操作的日志
 * @param processInstID 流程实例ID
 * @param activityDefID 活动定义ID
 * @return 代理代办操作日志列表
 * @throws WFApiException
 */
public List<WFMessage> getProcessLogByActivityId(long processInstID, String activityDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
activityDefID String 是 活动定义ID
# 返回值

返回类型： List<WFMessage>

# 3. getProcessLogByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessLogManager.getProcessLogByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessLogManager.getProcessLogByActivityInstId(long)
方法说明 根据活动实例ID获取该活动实例代理代办相关操作的日志
接口类型 Service API
适用场景 查询活动实例的代理代办日志
# 方法定义
/**
 * 根据活动实例ID获取该活动实例代理代办相关操作的日志
 * @param activityInstID 活动实例ID
 * @return 代理代办操作日志列表
 * @throws WFApiException
 */
public List<WFMessage> getProcessLogByActivityInstId(long activityInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
# 返回值

返回类型： List<WFMessage>

# 4. getProcessLogByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessLogManager.getProcessLogByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessLogManager.getProcessLogByProcessInstId(long)
方法说明 根据流程实例获取该实例的所有代理代办相关操作日志
接口类型 Service API
适用场景 查询流程实例的代理代办日志
# 方法定义
/**
 * 根据流程实例获取该实例的所有代理代办相关操作日志
 * @param processInstID 流程实例ID
 * @return 代理代办操作日志列表
 * @throws WFApiException
 */
public List<WFMessage> getProcessLogByProcessInstId(long processInstID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
# 返回值

返回类型： List<WFMessage>

# 5. getProcessLogByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFProcessLogManager.getProcessLogByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFProcessLogManager.getProcessLogByWorkItemId(long)
方法说明 根据工作项ID获取该工作项的代理代办相关操作日志
接口类型 Service API
适用场景 查询工作项的代理代办日志
# 方法定义
/**
 * 根据工作项ID获取该工作项的代理代办相关操作日志
 * @param workItemID 工作项ID
 * @return 代理代办操作日志列表
 * @throws WFApiException
 */
public List<WFMessage> getProcessLogByWorkItemId(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： List<WFMessage>

# 二十八、WFQueryManager

# 1. queryActivityInstances 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryActivityInstances
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryActivityInstances(Map, Map)
方法说明 根据条件查询活动实例
接口类型 Service API
适用场景 查询活动实例
# 方法定义
/**
 * 根据条件查询活动实例
 * @param paramMap1 活动实例查询条件
 * @param paramMap2 分页信息
 * @return 活动实例列表
 * @throws WFApiException
 */
public List<Map> queryActivityInstances(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 活动实例查询条件
paramMap2 Map 是 分页信息
# 返回值

返回类型： List<Map>

# 2. queryAgents 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryAgents
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryAgents(Map)
方法说明 根据代理条件查询所有的代理信息
接口类型 Service API
适用场景 查询代理信息
# 方法定义
/**
 * 根据代理条件查询所有的代理信息
 * @param paramMap 代理查询条件
 * @return 代理信息列表
 * @throws WFApiException
 */
public List<Map> queryAgents(Map paramMap) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap Map 是 代理查询条件
# 返回值

返回类型： List<Map>

# 3. queryProcesses 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryProcesses
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryProcesses(Map, Map)
方法说明 根据条件查询流程定义对象
接口类型 Service API
适用场景 查询流程定义对象
# 方法定义
/**
 * 根据条件查询流程定义对象
 * @param paramMap1 流程定义对象查询条件
 * @param paramMap2 分页信息
 * @return 流程定义对象列表
 * @throws WFApiException
 */
public List<Map> queryProcesses(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 流程定义对象查询条件
paramMap2 Map 是 分页信息
# 返回值

返回类型： List<Map>

# 4. queryWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryWorkItems(Map, Map)
方法说明 根据条件查询工作项
接口类型 Service API
适用场景 查询工作项
# 方法定义
/**
 * 根据条件查询工作项
 * @param paramMap1 工作项查询条件
 * @param paramMap2 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<Map> queryWorkItems(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 工作项查询条件
paramMap2 Map 是 分页信息
# 返回值

返回类型： List<Map>

# 5. queryProcessInstances 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryProcessInstances
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryProcessInstances(Map, Map)
方法说明 根据条件查询流程实例
接口类型 Service API
适用场景 查询流程实例
# 方法定义
/**
 * 根据条件查询流程实例
 * @param paramMap1 流程实例查询条件
 * @param paramMap2 分页信息
 * @return 流程实例列表
 * @throws WFApiException
 */
public List<Map> queryProcessInstances(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 流程实例查询条件
paramMap2 Map 是 分页信息
# 返回值

返回类型： List<Map>

# 6. queryAuditRecords 方法接口文档

# 基本信息
项目 说明
接口名称 WFQueryManager.queryAuditRecords
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFQueryManager.queryAuditRecords(Map, Map)
方法说明 根据条件查询审计日志
接口类型 Service API
适用场景 查询审计日志
# 方法定义
/**
 * 根据条件查询审计日志
 * @param paramMap1 审计日志查询条件
 * @param paramMap2 分页信息
 * @return 审计日志列表
 * @throws WFApiException
 */
public List<Map> queryAuditRecords(Map paramMap1, Map paramMap2) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
paramMap1 Map 是 审计日志查询条件
paramMap2 Map 是 分页信息
# 返回值

返回类型： List<Map>

# 二十九、WFRelativeDataManager

# 1. appendRelativeDataItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.appendRelativeDataItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.appendRelativeDataItem(long, String, Object)
方法说明 向数组或者集合类型的相关数据添加值对象
接口类型 Service API
适用场景 添加相关数据
# 方法定义
/**
 * 向数组或者集合类型的相关数据添加值对象
 * @param processInstID 流程实例ID
 * @param path 相关数据路径
 * @param relaData 要存放到相关数据区中的值对象
 * @throws WFApiException
 */
public void appendRelativeDataItem(long processInstID, String path, Object relaData) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
path String 是 相关数据路径
relaData Object 是 要存放的值对象
# 返回值

无返回值 void

# 2. getRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.getRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.getRelativeData(long, String)
方法说明 根据流程实例ID，获得相关数据中指定路径下的值
接口类型 Service API
适用场景 获取相关数据
# 方法定义
/**
 * 根据流程实例ID，获得相关数据中指定路径下的值
 * @param processInstID 流程实例ID
 * @param path 相关数据路径
 * @return 相关数据值
 * @throws WFApiException
 */
public Object getRelativeData(long processInstID, String path) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
path String 是 相关数据路径
# 返回值

返回类型： Object

# 3. getRelativeDataBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.getRelativeDataBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.getRelativeDataBatch(long, String[])
方法说明 批量获得相关数据中指定路径下的值
接口类型 Service API
适用场景 批量获取相关数据
# 方法定义
/**
 * 批量获得相关数据中指定路径下的值
 * @param processInstID 流程实例ID
 * @param path 相关数据路径数组
 * @return 相关数据值列表
 * @throws WFApiException
 */
public List<Object> getRelativeDataBatch(long processInstID, String[] path) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
path String[] 是 相关数据路径数组
# 返回值

返回类型： List<Object>

# 4. removeRelativeDataBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.removeRelativeDataBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.removeRelativeDataBatch(long, String[])
方法说明 根据流程实例ID，移除相关数据中指定路径下的节点
接口类型 Service API
适用场景 移除相关数据节点
# 方法定义
/**
 * 根据流程实例ID，移除相关数据中指定路径下的节点
 * @param processInstID 流程实例ID
 * @param xpath 相关数据路径（可变长输入参数）
 * @throws WFApiException
 */
public void removeRelativeDataBatch(long processInstID, String[] xpath) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
xpath String[] 是 相关数据路径数组
# 返回值

无返回值 void

# 5. setRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.setRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.setRelativeData(long, String, Object)
方法说明 根据流程实例ID，将对象值放到相关数据区中指定的xpath下
接口类型 Service API
适用场景 设置相关数据
# 方法定义
/**
 * 根据流程实例ID，将对象值放到相关数据区中指定的xpath下
 * @param processInstID 流程实例ID
 * @param xpath 相关数据路径
 * @param relaData 要存放到相关数据区中的值对象
 * @throws WFApiException
 */
public void setRelativeData(long processInstID, String xpath, Object relaData) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
xpath String 是 相关数据路径
relaData Object 是 要存放的值对象
# 返回值

无返回值 void

# 6. setRelativeDataBatch1 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.setRelativeDataBatch1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.setRelativeDataBatch1(long, Map<String, Object>)
方法说明 根据流程实例ID，批量设置相关数据中指定路径下的值
接口类型 Service API
适用场景 批量设置相关数据
# 方法定义
/**
 * 根据流程实例ID，批量设置相关数据中指定路径下的值
 * @param processInstID 流程实例ID
 * @param relaDatas 要设置的相关数据的路径及其值
 * @throws WFApiException
 */
public void setRelativeDataBatch1(long processInstID, Map<String, Object> relaDatas) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
relaDatas Map<String, Object> 是 要设置的相关数据
# 返回值

无返回值 void

# 7. setRelativeDataBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.setRelativeDataBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.setRelativeDataBatch(long, Object[])
方法说明 根据流程实例ID，批量设置相关数据中指定路径下的值
接口类型 Service API
适用场景 批量设置相关数据
# 方法定义
/**
 * 根据流程实例ID，批量设置相关数据中指定路径下的值
 * @param processInstID 流程实例ID
 * @param objects 要设置的相关数据的路径及其值
 * @throws WFApiException
 */
public void setRelativeDataBatch(long processInstID, Object[] objects) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
objects Object[] 是 要设置的相关数据
# 返回值

无返回值 void

# 8. getRelativeDataByProcessDefineId 方法接口文档

# 基本信息
项目 说明
接口名称 WFRelativeDataManager.getRelativeDataByProcessDefineId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRelativeDataManager.getRelativeDataByProcessDefineId(long, String)
方法说明 根据流程定义ID获得相关数据
接口类型 Service API
适用场景 获取流程定义的相关数据
# 方法定义
/**
 * 根据流程定义ID获得相关数据
 * @param processDefineId 流程定义ID
 * @param path 相关数据路径
 * @return 相关数据值
 * @throws WFApiException
 */
public RelativeDataField getRelativeDataByProcessDefineId(long processDefineId, String path) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefineId long 是 流程定义ID
path String 是 相关数据路径
# 返回值

返回类型： RelativeDataField

# 三十、WFRuntimeBizResourceManager

# 1. findBizHumantask 方法接口文档

# 基本信息
项目 说明
接口名称 WFRuntimeBizResourceManager.findBizHumantask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRuntimeBizResourceManager.findBizHumantask(String)
方法说明 查询人工任务
接口类型 Service API
适用场景 查询人工任务
# 方法定义
/**
 * 查询人工任务
 * @param uuid 人工任务UUID
 * @return 人工任务对象
 * @throws WFApiException
 */
public WFBizHumantask findBizHumantask(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 人工任务UUID
# 返回值

返回类型： WFBizHumantask

# 2. findBizOperation 方法接口文档

# 基本信息
项目 说明
接口名称 WFRuntimeBizResourceManager.findBizOperation
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRuntimeBizResourceManager.findBizOperation(String)
方法说明 查询业务操作
接口类型 Service API
适用场景 查询业务操作
# 方法定义
/**
 * 查询业务操作
 * @param uuid 业务操作UUID
 * @return 业务操作对象
 * @throws WFApiException
 */
public WFBizOperation findBizOperation(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务操作UUID
# 返回值

返回类型： WFBizOperation

# 3. findBizRule 方法接口文档

# 基本信息
项目 说明
接口名称 WFRuntimeBizResourceManager.findBizRule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRuntimeBizResourceManager.findBizRule(String)
方法说明 查询业务规则
接口类型 Service API
适用场景 查询业务规则
# 方法定义
/**
 * 查询业务规则
 * @param uuid 业务规则UUID
 * @return 业务规则对象
 * @throws WFApiException
 */
public WFBizRule findBizRule(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务规则UUID
# 返回值

返回类型： WFBizRule

# 4. findBizVar 方法接口文档

# 基本信息
项目 说明
接口名称 WFRuntimeBizResourceManager.findBizVar
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFRuntimeBizResourceManager.findBizVar(String)
方法说明 查询业务变量
接口类型 Service API
适用场景 查询业务变量
# 方法定义
/**
 * 查询业务变量
 * @param uuid 业务变量UUID
 * @return 业务变量对象
 * @throws WFApiException
 */
public WFBizVar findBizVar(String uuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
uuid String 是 业务变量UUID
# 返回值

返回类型： WFBizVar

# 三十一、WFSecurityManager

# 1. hasAccessProcessPermission 方法接口文档

# 基本信息
项目 说明
接口名称 WFSecurityManager.hasAccessProcessPermission
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFSecurityManager.hasAccessProcessPermission(long)
方法说明 验证已登录人员是否具有启动流程的权限
接口类型 Service API
适用场景 权限验证
# 方法定义
/**
 * 验证已登录人员是否具有启动流程的权限
 * @param processDefID 流程定义ID
 * @return 是否具有权限
 * @throws WFApiException
 */
public boolean hasAccessProcessPermission(long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefID long 是 流程定义ID
# 返回值

返回类型： boolean

# 2. hasAccessWorkItemPermission 方法接口文档

# 基本信息
项目 说明
接口名称 WFSecurityManager.hasAccessWorkItemPermission
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFSecurityManager.hasAccessWorkItemPermission(long)
方法说明 验证已登录人员是否具有执行工作项的权限
接口类型 Service API
适用场景 权限验证
# 方法定义
/**
 * 验证已登录人员是否具有执行工作项的权限
 * @param workItemID 工作项ID
 * @return 是否具有权限
 * @throws WFApiException
 */
public boolean hasAccessWorkItemPermission(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： boolean

# 3. queryPersonStartableProcesses 方法接口文档

# 基本信息
项目 说明
接口名称 WFSecurityManager.queryPersonStartableProcesses
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFSecurityManager.queryPersonStartableProcesses(String, PageCond)
方法说明 查询某人可以启动的流程定义列表
接口类型 Service API
适用场景 查询可启动的流程定义列表
# 方法定义
/**
 * 查询某人可以启动的流程定义列表
 * @param personID 用户ID
 * @param pageCond 分页信息
 * @return 可启动的流程定义列表
 * @throws WFApiException
 */
public List<WFProcessDefine> queryPersonStartableProcesses(String personID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 用户ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>

# 4. querySelfStartableProcesses 方法接口文档

# 基本信息
项目 说明
接口名称 WFSecurityManager.querySelfStartableProcesses
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFSecurityManager.querySelfStartableProcesses(PageCond)
方法说明 查询已登录人可以启动的流程
接口类型 Service API
适用场景 查询已登录人可以启动的流程
# 方法定义
/**
 * 查询已登录人可以启动的流程
 * @param pageCond 分页信息
 * @return 可启动的流程定义列表
 * @throws WFApiException
 */
public List<WFProcessDefine> querySelfStartableProcesses(PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFProcessDefine>

# 三十二、WFSupervisionManager

# 1. queryAutoActivityInstsWithException 方法接口文档

# 基本信息
项目 说明
接口名称 WFSupervisionManager.queryAutoActivityInstsWithException
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFSupervisionManager.queryAutoActivityInstsWithException(long, long, String, String, Date, Date, PageCond)
方法说明 根据条件查询异常状态的自动活动
接口类型 Service API
适用场景 查询异常状态的活动实例
# 方法定义
/**
 * 根据条件查询异常状态的自动活动
 * @param actInstID 活动实例ID
 * @param procInstID 流程实例ID
 * @param actDefID 活动定义ID
 * @param actInstName 活动实例名称
 * @param startTimeMin 开始时间范围左边界
 * @param startTimeMax 开始时间范围右边界
 * @param pageCond 分页信息
 * @return 异常状态的活动实例列表
 * @throws WFApiException
 */
public List<WFActivityInst> queryAutoActivityInstsWithException(long actInstID, long procInstID, String actDefID, String actInstName, Date startTimeMin, Date startTimeMax, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
procInstID long 是 流程实例ID
actDefID String 是 活动定义ID
actInstName String 是 活动实例名称
startTimeMin Date 是 开始时间范围左边界
startTimeMax Date 是 开始时间范围右边界
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFActivityInst>

# 三十三、WFTaskPoolManager

# 1. addTaskResource 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.addTaskResource
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.addTaskResource
方法说明 添加任务到任务池
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 添加任务到任务池
 * @param task 任务资源
 * @throws WFApiException
 */
public void addTaskResource(TaskResource task) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
task TaskResource 是 任务资源
# 返回值

无返回值 void

# 2. addTaskResourceFromWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.addTaskResourceFromWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.addTaskResourceFromWorkItem
方法说明 添加流程工作项到任务池中指定队列
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 添加流程工作项到任务池中指定队列
 * @param qname 任务队列名
 * @param workItem 工作项
 * @param refEcludeUniqueID 指定参与者排除过滤的业务编号
 * @param priority 优先级
 * @param option 扩展字段extend1~5 设置
 * @throws WFApiException
 */
public void addTaskResourceFromWorkItem(String qname, WFWorkItem workItem, String refEcludeUniqueID, long priority, Map<String, Object> option) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
qname String 是 任务队列名
workItem WFWorkItem 是 工作项
refEcludeUniqueID String 是 指定参与者排除过滤的业务编号
priority long 是 优先级
option Map<String, Object> 是 扩展字段设置
# 返回值

无返回值 void

# 3. appendExcludeParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.appendExcludeParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.appendExcludeParticipant
方法说明 在原来基础上追加排除的参与者
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 在原来基础上追加排除的参与者
 * @param excludeUniqueID 排除的唯一ID
 * @param participantID 参与者ID
 * @throws WFApiException
 */
public void appendExcludeParticipant(String excludeUniqueID, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
excludeUniqueID String 是 排除的唯一ID
participantID String 是 参与者ID
# 返回值

无返回值 void

# 4. getOneTask 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.getOneTask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.getOneTask
方法说明 根据队列名获取一个任务支持配置默认过滤器对任务进行过滤
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 根据队列名获取一个任务支持配置默认过滤器对任务进行过滤
 * @param qname 队列名
 * @return 任务资源
 * @throws WFApiException
 */
public TaskResource getOneTask(String qname) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
qname String 是 队列名
# 返回值

返回类型： TaskResource

# 5. getOneTaskWithFilter 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.getOneTaskWithFilter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.getOneTaskWithFilter
方法说明 指定任务队列和过滤器获取任务
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 指定任务队列和过滤器获取任务
 * @param qname 队列名
 * @param filter 过滤器
 * @return 任务资源
 * @throws WFApiException
 */
public TaskResource getOneTaskWithFilter(String qname, AbstractTaskFilter filter) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
qname String 是 队列名
filter AbstractTaskFilter 是 过滤器
# 返回值

返回类型： TaskResource

# 6. removeExcludeParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.removeExcludeParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.removeExcludeParticipant
方法说明 根据排除参与者编号，清空排除参与者
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 根据排除参与者编号，清空排除参与者
 * @param excludeUniqueID 排除的唯一ID
 * @throws WFApiException
 */
public void removeExcludeParticipant(String excludeUniqueID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
excludeUniqueID String 是 排除的唯一ID
# 返回值

无返回值 void

# 7. removeTaskResource 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.removeTaskResource
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.removeTaskResource
方法说明 指定任务ID，从任务池中删除任务
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 指定任务ID，从任务池中删除任务
 * @param taskID 任务ID
 * @throws WFApiException
 */
public void removeTaskResource(long taskID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
taskID long 是 任务ID
# 返回值

无返回值 void

# 8. setExcludeParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFTaskPoolManager.setExcludeParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFTaskPoolManager.setExcludeParticipant
方法说明 重设excludeUniqueID对应的排除参与者字符串，此字符串中多个参与者之间用半角英文","分割
接口类型 Bizlet
适用场景 任务池管理
# 方法定义
/**
 * 重设excludeUniqueID对应的排除参与者字符串，此字符串中多个参与者之间用半角英文","分割
 * @param excludeUniqueID 排除的唯一ID
 * @param participantID 参与者id
 * @throws WFApiException
 */
public void setExcludeParticipant(String excludeUniqueID, String participantID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
excludeUniqueID String 是 排除的唯一ID
participantID String 是 参与者id
# 返回值

无返回值 void

# 三十四、WFWorkItemDrawbackManager

# 1. drawbackWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemDrawbackManager.drawbackWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemDrawbackManager.drawbackWorkItem(long, boolean, boolean)
方法说明 拽回工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 拽回工作项
 * @param workItemID 工作项ID
 * @param isRestartAllWI 是否重启当前活动的所有工作项
 * @param isCallRollbackEvent 拽回后是否调用当前活动的回退应用
 * @throws WFApiException
 */
public void drawbackWorkItem(long workItemID, boolean isRestartAllWI, boolean isCallRollbackEvent) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
isRestartAllWI boolean 是 是否重启当前活动的所有工作项
isCallRollbackEvent boolean 是 拽回后是否调用当前活动的回退应用
# 返回值

无返回值 void

# 2. isDrawbackEnable 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemDrawbackManager.isDrawbackEnable
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemDrawbackManager.isDrawbackEnable(long)
方法说明 判断任务是否可以拽回
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 判断任务是否可以拽回
 * @param workItemID 工作项ID
 * @return 是否可以拽回
 * @throws WFApiException
 */
public boolean isDrawbackEnable(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： boolean

# 三十五、WFWorkItemManager

# 1. addApprovalMsg 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.addApprovalMsg
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.addApprovalMsg(long, String)
方法说明 为某个工作项添加审批意见
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 为某个工作项添加审批意见
 * @param workItemID 工作项ID
 * @param approvalMsg 审批意见
 * @throws WFApiException
 */
public void addApprovalMsg(long workItemID, String approvalMsg) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
approvalMsg String 是 审批意见
# 返回值

无返回值 void

# 2. addWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.addWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.addWorkItem(long, WFParticipant[])
方法说明 动态增加某个活动实例的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 动态增加某个活动实例的工作项
 * @param activityInstID 活动实例ID
 * @param participant 参与者集合
 * @throws WFApiException
 */
public void addWorkItem(long activityInstID, WFParticipant[] participant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
participant WFParticipant[] 是 参与者集合
# 返回值

无返回值 void

# 3. addWorkItemParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.addWorkItemParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.addWorkItemParticipant(long, WFParticipant)
方法说明 新增工作项的参与者
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 新增工作项的参与者
 * @param workItem 工作项ID
 * @param participant 参与者
 * @throws WFApiException
 */
public void addWorkItemParticipant(long workItem, WFParticipant participant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItem long 是 工作项ID
participant WFParticipant 是 参与者
# 返回值

无返回值 void

# 4. assignWorkItemToPerson 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.assignWorkItemToPerson
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.assignWorkItemToPerson(long, String)
方法说明 指派工作项给指定人员（替别人领取）
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 指派工作项给指定人员（替别人领取）
 * @param workItemID 工作项ID
 * @param personID 参与者ID
 * @throws WFApiException
 */
public void assignWorkItemToPerson(long workItemID, String personID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
personID String 是 参与者ID
# 返回值

无返回值 void

# 5. assignWorkItemToSelf 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.assignWorkItemToSelf
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.assignWorkItemToSelf(long)
方法说明 已登录人员领取工作项（按工作项ID领取）
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 已登录人员领取工作项（按工作项ID领取）
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void assignWorkItemToSelf(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 6. clearWorkItemParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.clearWorkItemParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.clearWorkItemParticipant(long)
方法说明 清除工作项的所有参与者
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 清除工作项的所有参与者
 * @param workItemID 工作项ID
 * @return 清除结果
 * @throws WFApiException
 */
public int clearWorkItemParticipant(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： int

# 7. clearWorkItemTimeLimit 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.clearWorkItemTimeLimit
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.clearWorkItemTimeLimit(long, String)
方法说明 清除工作项时间限制
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 清除工作项时间限制
 * @param workItemID 工作项ID
 * @param strategy 需要清除的时间限制类型
 * @return 清除结果
 * @throws WFApiException
 */
public int clearWorkItemTimeLimit(long workItemID, String strategy) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
strategy String 是 需要清除的时间限制类型（WI_OVERTIME_REMIND—工作项超时
WI_PRE_REMIND—工作项预警）
# 返回值

返回类型： int

# 8. createWorkitem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.createWorkitem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.createWorkitem(long, WFParticipant[])
方法说明 动态增加某个活动实例的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 动态增加某个活动实例的工作项
 * @param activityInstID 活动实例ID
 * @param participant 参与者集合
 * @return 工作项ID
 * @throws WFApiException
 */
public long createWorkitem(long activityInstID, WFParticipant[] participant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
participant WFParticipant[] 是 参与者集合
# 返回值

返回类型： long

# 9. createWorkitemWithId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.createWorkitemWithId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.createWorkitemWithId(long, WFParticipant[], long)
方法说明 动态增加某个活动实例的工作项，并设置工作项ID
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 动态增加某个活动实例的工作项，并设置工作项ID
 * @param activityInstID 活动实例ID
 * @param participant 参与者集合
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void createWorkitemWithId(long activityInstID, WFParticipant[] participant, long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstID long 是 活动实例ID
participant WFParticipant[] 是 参与者集合
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 10. excuteAnnotateTask 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.excuteAnnotateTask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.excuteAnnotateTask(long, String)
方法说明 执行任务批注
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 执行任务批注
 * @param workItemID 工作项ID
 * @param annotateInfo 批注信息
 * @throws WFApiException
 */
public void excuteAnnotateTask(long workItemID, String annotateInfo) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
annotateInfo String 是 批注信息
# 返回值

无返回值 void

# 11. excutePressTask 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.excutePressTask
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.excutePressTask(long, String)
方法说明 执行任务催办
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 执行任务催办
 * @param workItemID 工作项ID
 * @param pressReason 催办原因
 * @throws WFApiException
 */
public void excutePressTask(long workItemID, String pressReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
pressReason String 是 催办原因
# 返回值

无返回值 void

# 12. finishWorkItem1 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItem1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItem1(long, boolean)
方法说明 完成指定工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 完成指定工作项
 * @param workItemID 工作项ID
 * @param transactionSpan 是否启用分段事务
 * @throws WFApiException
 */
public void finishWorkItem1(long workItemID, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
transactionSpan boolean 是 是否启用分段事务
# 返回值

无返回值 void

# 13. finishWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItem(long, boolean, String)
方法说明 完成指定工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 完成指定工作项
 * @param workItemID 工作项ID
 * @param transactionSpan 是否启用分段事务
 * @param submitReason 提交工作项原因
 * @throws WFApiException	
 */
public void finishWorkItem(long workItemID, boolean transactionSpan, String submitReason) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
transactionSpan boolean 是 是否启用分段事务
submitReason String 是 提交工作项原因
# 返回值

无返回值 void

# 14. finishWorkItem4Person 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItem4Person
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItem4Person(long, boolean)
方法说明 代替某人提交工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 代替某人提交工作项
 * @param workItemID 工作项ID
 * @param transactionSpan 是否启用分段事务
 * @throws WFApiException
 */
public void finishWorkItem4Person(long workItemID, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
transactionSpan boolean 是 是否启用分段事务
# 返回值

无返回值 void

# 15. finishWorkItemBatch 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItemBatch
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItemBatch(long[], boolean)
方法说明 批量提交工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 批量提交工作项
 * @param workItemIDArr 工作项ID数组
 * @param transactionSpan 是否启用分段事务
 * @throws WFApiException
 */
public void finishWorkItemBatch(long[] workItemIDArr, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemIDArr long[] 是 工作项ID数组
transactionSpan boolean 是 是否启用分段事务
# 返回值

无返回值 void

# 16. finishWorkItemDirectly 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItemDirectly
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItemDirectly(long, boolean)
方法说明 完成指定工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 完成指定工作项
 * @param workItemID 工作项ID
 * @param transactionSpan 是否启用分段事务
 * @throws WFApiException
 */
public void finishWorkItemDirectly(long workItemID, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
transactionSpan boolean 是 是否启用分段事务
# 返回值

无返回值 void

# 17. finishWorkItemWithOption 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItemWithOption
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItemWithOption(long, Map<String, Object>, Map<String, Object>)
方法说明 完成指定工作项，并设置相关数据
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 完成指定工作项，并设置相关数据
 * @param workItemID 工作项ID
 * @param option 拓展数据
 * @param map 相关数据
 * @throws WFApiException
 */
public void finishWorkItemWithOption(long workItemID, Map<String, Object> option, Map<String, Object> map) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
option Map<String, Object> 是 拓展数据
map Map<String, Object> 是 相关数据
# 返回值

无返回值 void

# 18. finishWorkItemWithRelativeData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItemWithRelativeData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItemWithRelativeData(long, Map<String, Object>, boolean)
方法说明 完成指定工作项，并设置相关数据
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 完成指定工作项，并设置相关数据
 * @param workItemID 工作项ID
 * @param map 相关数据
 * @param transactionSpan 是否启用分段事务
 * @throws WFApiException
 */
public void finishWorkItemWithRelativeData(long workItemID, Map<String, Object> map, boolean transactionSpan) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
map Map<String, Object> 是 相关数据
transactionSpan boolean 是 是否启用分段事务
# 返回值

无返回值 void

# 19. generateWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.generateWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.generateWorkItemId()
方法说明 生成工作项ID
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 生成工作项ID
 * @return 工作项ID
 * @throws WFApiException
 */
public long generateWorkItemId() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： long

# 20. getApprovalMsgByTaskId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.getApprovalMsgByTaskId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.getApprovalMsgByTaskId(long, PageCond)
方法说明 根据任务ID获取审批意见
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据任务ID获取审批意见
 * @param workItemID 工作项ID
 * @param pageCond 分页信息
 * @return 审批意见列表
 * @throws WFApiException
 */
public List<WFOptMsg> getApprovalMsgByTaskId(long workItemID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 21. getNextActionList 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.getNextActionList
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.getNextActionList(long)
方法说明 获取某一工作项下一个可执行动作列表
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 获取某一工作项下一个可执行动作列表
 * @param workItemID 工作项ID
 * @return 可执行动作列表
 * @throws WFApiException
 */
public List<String> getNextActionList(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： List<String>

# 22. getWorkItemElapsedTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.getWorkItemElapsedTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.getWorkItemElapsedTime(long, long)
方法说明 返回该工作项的总体有效执行时间
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 返回该工作项的总体有效执行时间，即按该工作流配置的工作日历计算得出的工作时间内的工作项执行时间
 * @param processInstID 流程实例ID
 * @param workItemID 工作项ID
 * @return 工作项的执行时间
 * @throws WFApiException
 */
public long getWorkItemElapsedTime(long processInstID, long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
workItemID long 是 工作项ID
# 返回值

返回类型： long

# 23. modifyProcessInstName 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.modifyProcessInstName
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.modifyProcessInstName(long, String)
方法说明 修改工作项的流程实例名称
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 修改工作项的流程实例名称
 * @param workItemID 工作项ID
 * @param processInstName 流程实例名称
 * @return 修改结果
 * @throws WFApiException
 */
public int modifyProcessInstName(long workItemID, String processInstName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
processInstName String 是 流程实例名称
# 返回值

返回类型： int

# 24. modifyWorkItemUrl 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.modifyWorkItemUrl
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.modifyWorkItemUrl(long, String, String)
方法说明 修改工作项url
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 修改工作项url
 * @param workItemID 工作项ID
 * @param urlType url的类型(页面|页面流|其他|无)
 * @param url url链接
 * @return 修改结果
 * @throws WFApiException
 */
public int modifyWorkItemUrl(long workItemID, String urlType, String url) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
urlType String 是 url的类型(值范围：bfsform—bps表单
0—其他
W—页面
N—无
F—页面流)
url String 是 url链接
# 返回值

返回类型： int

# 25. queryAnnotateListByTaskId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryAnnotateListByTaskId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryAnnotateListByTaskId(long, PageCond)
方法说明 根据任务ID查询批注列表
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据任务ID查询批注列表
 * @param workItemId 工作项ID
 * @param pageCond 分页信息
 * @return 批注列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryAnnotateListByTaskId(long workItemId, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 26. queryNextWorkItemsByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryNextWorkItemsByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryNextWorkItemsByActivityInstId(long, boolean)
方法说明 查询出当前活动完成后生成下一个活动的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 查询出当前活动完成后生成下一个活动的工作项
 * @param actInstID 活动实例ID
 * @param fetchParticipant 是否包含参与者
 * @return 下一个活动的工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryNextWorkItemsByActivityInstId(long actInstID, boolean fetchParticipant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
fetchParticipant boolean 是 是否包含参与者
# 返回值

返回类型： List<WFWorkItem>

# 27. queryNextWorkItemsByProcessInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryNextWorkItemsByProcessInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryNextWorkItemsByProcessInstId(long, boolean)
方法说明 查询指定流程实例启动后生成下一个活动的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 查询指定流程实例启动后生成下一个活动的工作项
 * @param processInstID 流程实例ID
 * @param fetchParticipant 是否包含参与者
 * @return 下一个活动的工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryNextWorkItemsByProcessInstId(long processInstID, boolean fetchParticipant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstID long 是 流程实例ID
fetchParticipant boolean 是 是否包含参与者
# 返回值

返回类型： List<WFWorkItem>

# 28. queryNextWorkItemsByWorkItemID 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryNextWorkItemsByWorkItemID
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryNextWorkItemsByWorkItemID(long, boolean)
方法说明 查询出已完成的工作项生成的后继活动的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 查询出已完成的工作项生成的后继活动的工作项
 * @param workItemID 工作项ID
 * @param fetchParticipant 是否包含参与者
 * @return 后继活动的工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryNextWorkItemsByWorkItemID(long workItemID, boolean fetchParticipant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
fetchParticipant boolean 是 是否包含参与者
# 返回值

返回类型： List<WFWorkItem>

# 29. queryOptMsgByTaskId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryOptMsgByTaskId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryOptMsgByTaskId(long, PageCond)
方法说明 根据任务ID查询操作消息列表
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据任务ID查询操作消息列表
 * @param workItemID 工作项ID
 * @param pageCond 分页信息
 * @return 操作消息列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryOptMsgByTaskId(long workItemID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 30. queryPressListByTaskId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryPressListByTaskId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryPressListByTaskId(long, PageCond)
方法说明 根据任务ID查询催办列表
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据任务ID查询催办列表
 * @param workItemId 工作项ID
 * @param pageCond 分页信息
 * @return 催办列表
 * @throws WFApiException
 */
public List<WFOptMsg> queryPressListByTaskId(long workItemId, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFOptMsg>

# 31. queryRestWorkItemsCountByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryRestWorkItemsCountByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryRestWorkItemsCountByWorkItemId(long)
方法说明 根据工作项ID查询剩余工作项数量
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据工作项ID查询剩余工作项数量
 * @param workItemID 工作项ID
 * @return 剩余工作项数量
 * @throws WFApiException
 */
public int queryRestWorkItemsCountByWorkItemId(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： int

# 32. queryWorkItemDelay 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryWorkItemDelay
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryWorkItemDelay(long)
方法说明 根据工作项ID查询工作项超时数
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据工作项ID查询工作项超时数
 * @param workItemID 工作项ID
 * @return 工作项超时数
 * @throws WFApiException
 */
public WFTimePeriod queryWorkItemDelay(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： WFTimePeriod

# 33. queryWorkItemDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryWorkItemDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryWorkItemDetail(long)
方法说明 根据工作项ID查询工作项的详细信息
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据工作项ID查询工作项的详细信息
 * @param workItemID 工作项ID
 * @return 工作项详细信息
 * @throws WFApiException
 */
public WFWorkItem queryWorkItemDetail(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： WFWorkItem

# 34. queryWorkItemParticipantInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryWorkItemParticipantInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryWorkItemParticipantInfo(long)
方法说明 根据工作项ID查询工作项参与者信息
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据工作项ID查询工作项参与者信息
 * @param workItemID 工作项ID
 * @return 工作项参与者信息列表
 * @throws WFApiException
 */
public List<WIParticipantInfo> queryWorkItemParticipantInfo(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： List<WIParticipantInfo>

# 35. queryWorkItemsByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryWorkItemsByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryWorkItemsByActivityInstId(long, PageCond)
方法说明 根据活动实例ID查询工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据活动实例ID查询工作项
 * @param actInstID 活动实例ID
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryWorkItemsByActivityInstId(long actInstID, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
actInstID long 是 活动实例ID
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 36. queryWorkItemUrl 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.queryWorkItemUrl
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.queryWorkItemUrl(long)
方法说明 根据工作项ID查询工作项的URL
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据工作项ID查询工作项的URL
 * @param workItemID 工作项ID
 * @return 工作项URL
 * @throws WFApiException
 */
public String queryWorkItemUrl(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

返回类型： String

# 37. reassignWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.reassignWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.reassignWorkItem(long, String)
方法说明 将指定的工作项改派到指定的参与者（只能是个人）
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 将指定的工作项改派到指定的参与者（只能是个人）
 * @param workItemID 工作项ID
 * @param personID 参与者ID
 * @throws WFApiException
 */
public void reassignWorkItem(long workItemID, String personID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
personID String 是 参与者ID
# 返回值

无返回值 void

# 38. reassignWorkItemAndUpdateStartTime 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.reassignWorkItemAndUpdateStartTime
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.reassignWorkItemAndUpdateStartTime(long, String)
方法说明 将指定的工作项改派到指定的参与者（只能是个人），并更新工作项开始时间
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 将指定的工作项改派到指定的参与者（只能是个人），并更新工作项开始时间
 * @param workItemID 工作项ID
 * @param personID 参与者ID
 * @throws WFApiException
 */
public void reassignWorkItemAndUpdateStartTime(long workItemID, String personID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
personID String 是 参与者ID
# 返回值

无返回值 void

# 39. reassignWorkItemAndUpdateStartTimeEx 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.reassignWorkItemAndUpdateStartTimeEx
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.reassignWorkItemAndUpdateStartTimeEx(long, WFParticipant[])
方法说明 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色，并更新工作项开始时间
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色，并更新工作项开始时间
 * @param workItemID 工作项ID
 * @param participantArr 参与者集合
 * @throws WFApiException
 */
public void reassignWorkItemAndUpdateStartTimeEx(long workItemID, WFParticipant[] participantArr) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
participantArr WFParticipant[] 是 参与者集合
# 返回值

无返回值 void

# 40. reassignWorkItemEx 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.reassignWorkItemEx
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.reassignWorkItemEx(long, WFParticipant[])
方法说明 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 将工作项改派给指定的参与者，可以改派给多个个人、机构、角色
 * @param workItemID 工作项ID
 * @param participantArr 参与者集合
 * @throws WFApiException
 */
public void reassignWorkItemEx(long workItemID, WFParticipant[] participantArr) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
participantArr WFParticipant[] 是 参与者集合
# 返回值

无返回值 void

# 41. removeWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.removeWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.removeWorkItem(long)
方法说明 删除工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 删除工作项
 * @param workitemID 工作项ID
 * @return 删除结果
 * @throws WFApiException
 */
public int removeWorkItem(long workitemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workitemID long 是 工作项ID
# 返回值

返回类型： int

# 42. removeWorkItemParticipant 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.removeWorkItemParticipant
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.removeWorkItemParticipant(long, WFParticipant)
方法说明 删除工作项的某个参与者
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 删除工作项的某个参与者
 * @param workItemID 工作项ID
 * @param participant 参与者
 * @return 删除结果
 * @throws WFApiException
 */
public int removeWorkItemParticipant(long workItemID, WFParticipant participant) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
participant WFParticipant 是 参与者
# 返回值

返回类型： int

# 43. restartWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.restartWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.restartWorkItem(long)
方法说明 重启动已经结束的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 重启动已经结束的工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void restartWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 44. resumeWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.resumeWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.resumeWorkItem(long)
方法说明 恢复指定的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 恢复指定的工作项
 * @param workitemID 工作项ID
 * @throws WFApiException
 */
public void resumeWorkItem(long workitemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workitemID long 是 工作项ID
# 返回值

无返回值 void

# 45. saveWorkItemWithOption 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.saveWorkItemWithOption
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.saveWorkItemWithOption(long, Map<String, Object>, Map<String, Object>)
方法说明 保存指定工作项，并设置相关数据
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 保存指定工作项，并设置相关数据
 * @param workItemID 工作项ID
 * @param option 拓展数据
 * @param map 相关数据
 * @throws WFApiException
 */
public void saveWorkItemWithOption(long workItemID, Map<String, Object> option, Map<String, Object> map) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
option Map<String, Object> 是 拓展数据
map Map<String, Object> 是 相关数据
# 返回值

无返回值 void

# 46. setWorkItemTimeLimit 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.setWorkItemTimeLimit
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.setWorkItemTimeLimit(long, WFTimePeriod, WFTimePeriod)
方法说明 设置工作项时间限制
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 设置工作项时间限制
 * @param workItemID 工作项ID
 * @param timeLimit 时间限制
 * @param remindTime 提醒时间
 * @return 设置结果
 * @throws WFApiException
 */
public int setWorkItemTimeLimit(long workItemID, WFTimePeriod timeLimit, WFTimePeriod remindTime) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
timeLimit WFTimePeriod 是 时间限制
remindTime WFTimePeriod 是 提醒时间
# 返回值

返回类型： int

# 47. suspendWorkitem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.suspendWorkitem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.suspendWorkitem(long)
方法说明 挂起指定的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 挂起指定的工作项
 * @param workitemID 工作项ID
 * @throws WFApiException
 */
public void suspendWorkitem(long workitemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workitemID long 是 工作项ID
# 返回值

无返回值 void

# 48. terminateWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.terminateWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.terminateWorkItem(long)
方法说明 终止指定的工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 终止指定的工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void terminateWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 49. updateApprovalMsg 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.updateApprovalMsg
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.updateApprovalMsg(long, long, String)
方法说明 根据审批意见ID修改审批意见
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据审批意见ID修改审批意见
 * @param workItemID 工作项ID
 * @param messageID 审批意见ID
 * @param approvalMsg 审批意见
 * @throws WFApiException
 */
public void updateApprovalMsg(long workItemID, long messageID, String approvalMsg) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
messageID long 是 审批意见ID
approvalMsg String 是 审批意见
# 返回值

无返回值 void

# 50. withdrawWorkItem 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.withdrawWorkItem
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.withdrawWorkItem(long)
方法说明 取消领取某个工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 取消领取某个工作项
 * @param workItemID 工作项ID
 * @throws WFApiException
 */
public void withdrawWorkItem(long workItemID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemID long 是 工作项ID
# 返回值

无返回值 void

# 51. reviewWorkitems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.reviewWorkitems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.reviewWorkitems(String, long[])
方法说明 任务待阅转已阅
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 任务待阅转已阅
 * @param personId 参与者ID
 * @param workItemIds 工作项ID数组
 * @throws WFApiException
 */
public void reviewWorkitems(String personId, long[] workItemIds) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 参与者ID
workItemIds long[] 是 工作项ID数组
# 返回值

无返回值 void

# 52. finishWorkItemWithStrategy 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorkItemManager.finishWorkItemWithStrategy
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorkItemManager.finishWorkItemWithStrategy(long, boolean, WFParticipant[], String, NextActivityInfo[], String, String, Map<String, Object>, String[])
方法说明 根据策略完成工作项
接口类型 Service API
适用场景 工作项管理
# 方法定义
/**
 * 根据策略完成工作项
 * @param workItemId 工作项ID
 * @param isTransactionSpan 是否启用分段事务
 * @param participants 参与者数组
 * @param appointStrategy 指派策略
 * @param nextActivityInfos 后续活动信息数组
 * @param submitReason 提交原因
 * @param submitType 提交类型
 * @param map 相关数据
 * @param reviewPersons 审核人员数组
 * @throws WFApiException
 */
public void finishWorkItemWithStrategy(long workItemId, boolean isTransactionSpan, WFParticipant[] participants, String appointStrategy, NextActivityInfo[] nextActivityInfos, String submitReason, String submitType, Map<String, Object> map, String[] reviewPersons) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
isTransactionSpan boolean 是 是否启用分段事务
participants WFParticipant[] 是 参与者数组
appointStrategy String 是 指派策略（值范围：set—覆盖之前设置的结果
append —在之前设置的结果中追加）
nextActivityInfos NextActivityInfo[] 是 后续活动信息数组
submitReason String 是 提交原因
submitType String 是 提交类型（值范围：back—跳转提交
back_workItem—跳转已完成任务提交
back_deal—跳转回驳回时处理人（适用于单工作项领取场景）
back|back_workItem—允许他人审批且已审批用户不再审批
default_submit—原路径提交）
map Map<String, Object> 是 相关数据
reviewPersons String[] 是 审核人员数组
# 返回值

无返回值 void

# 三十六、WFWorklistQueryManager

# 1. queryCollectiveWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryCollectiveWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryCollectiveWorkItems(List<WFParticipant>, int, String, boolean, PageCond)
方法说明 查询指定集合（角色、机构、岗位）的工作项
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定集合（角色、机构、岗位）的工作项
 * @param collectiveIDs 集合参与者列表
 * @param wiState 工作项状态
 * @param sortField 排序字段
 * @param includeHistory 是否包含历史表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryCollectiveWorkItems(List<WFParticipant> collectiveIDs, int wiState, String sortField, boolean includeHistory, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
collectiveIDs List 是 集合参与者列表
wiState int 是 工作项状态（值范围：4—待领取
8—挂起
10—运行
12—完成
13—终止
14—取消）
sortField String 是 排序字段
includeHistory boolean 是 是否包含历史表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 2. queryPersonEntrustFinishedWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonEntrustFinishedWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonEntrustFinishedWorkItems(String, String, boolean, PageCond)
方法说明 查询指定人员委托出去并且已经完成的工作项信息
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员委托出去并且已经完成的工作项信息
 * @param personID 人员ID
 * @param scope 任务来源
 * @param forHistory 是否包含历史表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonEntrustFinishedWorkItems(String personID, String scope, boolean forHistory, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
forHistory boolean 是 是否包含历史表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 3. queryPersonEntrustFinishedWorkItemsWithBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonEntrustFinishedWorkItemsWithBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonEntrustFinishedWorkItemsWithBizInfo(String, String, boolean, String, String, List<Object>, List<Object>, PageCond)
方法说明 查询指定人员委托出去并且已经完成的工作项信息，结合业务冗余数据查询条件
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员委托出去并且已经完成的工作项信息，结合业务冗余数据查询条件
 * @param personID 人员ID
 * @param scope 任务来源
 * @param forHistory 是否包含历史表
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonEntrustFinishedWorkItemsWithBizInfo(String personID, String scope, boolean forHistory, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
forHistory boolean 是 是否包含历史表
bizTableName String 是 业务冗余表名 （wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "scope": "SELF,AGENT,DELEG,HELP",
    "includeHistory": true,
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 4. queryPersonEntrustWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonEntrustWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonEntrustWorkItems(String, String, PageCond)
方法说明 查询指定人员委托出去的工作项信息
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员委托出去的工作项信息
 * @param personID 人员ID
 * @param scope 任务来源
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonEntrustWorkItems(String personID, String scope, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 5. queryPersonEntrustWorkItemsWithBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonEntrustWorkItemsWithBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonEntrustWorkItemsWithBizInfo(String, String, String, String, List<Object>, List<Object>, PageCond)
方法说明 查询指定人员委托出去的工作项信息，结合业务冗余数据查询条件
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员委托出去的工作项信息，结合业务冗余数据查询条件
 * @param personID 人员ID
 * @param scope 任务来源
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonEntrustWorkItemsWithBizInfo(String personID, String scope, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
bizTableName String 是 业务冗余表名（wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "scope": "SELF,AGENT,DELEG,HELP",
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 6. queryPersonFinishedWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonFinishedWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonFinishedWorkItems(String, String, boolean, PageCond)
方法说明 查询指定人员完成的工作项
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员完成的工作项
 * @param personID 人员ID
 * @param scope 任务来源
 * @param includeHistory 是否包含历史表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonFinishedWorkItems(String personID, String scope, boolean includeHistory, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
includeHistory boolean 是 是否包含历史表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 7. queryPersonFinishedWorkItemsWithBizInfo1 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonFinishedWorkItemsWithBizInfo1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonFinishedWorkItemsWithBizInfo1(String, String, boolean, String, String, List<Object>, List<Object>, PageCond)
方法说明 查询指定人员完成的工作项（结合业务冗余数据查询条件）
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员完成的工作项（结合业务冗余数据查询条件）
 * @param personID 人员ID
 * @param scope 任务来源
 * @param includeHistory 是否包含历史表
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonFinishedWorkItemsWithBizInfo1(String personID, String scope, boolean includeHistory, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
includeHistory boolean 是 是否包含历史表
bizTableName String 是 业务冗余表名（wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "scope": "SELF,AGENT,DELEG,HELP",
    "includeHistory": true,
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 8. queryPersonFinishedWorkItemsWithBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonFinishedWorkItemsWithBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonFinishedWorkItemsWithBizInfo(String, String, boolean, String, String, List<Object>, List<Object>, String, PageCond)
方法说明 查询指定人员完成的工作项（结合业务冗余数据查询条件）
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员完成的工作项（结合业务冗余数据查询条件）
 * @param personID 人员ID
 * @param scope 任务来源
 * @param includeHistory 是否包含历史表
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param joinFields 业务关联字段
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonFinishedWorkItemsWithBizInfo(String personID, String scope, boolean includeHistory, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, String joinFields, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
includeHistory boolean 是 是否包含历史表
bizTableName String 是 业务冗余表名（wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
joinFields String 是 业务关联字段（工作项和业务冗余表做关联 默认rootProcInstID,processInstID）
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "scope": "SELF,AGENT,DELEG,HELP",
    "includeHistory": true,
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "joinFields":"",
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 9. queryPersonWorkItems 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItems
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItems(String, String, String, PageCond)
方法说明 查询用户的待办工作项列表
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询用户的待办工作项列表
 * @param personID 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param pagecond 分页信息
 * @return 待办工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonWorkItems(String personID, String permission, String scope, PageCond pagecond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
pagecond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

# 10. queryPersonWorkItemsWithBizInfo1 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemsWithBizInfo1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemsWithBizInfo1(String, String, String, String, List<Object>, List<Object>, PageCond)
方法说明 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件）
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件）
 * @param personID 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonWorkItemsWithBizInfo1(String personID, String permission, String scope, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
bizTableName String 是 业务冗余表名（wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "permission":"ALL",
    "scope": "SELF,AGENT,DELEG,HELP",
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 11. queryPersonWorkItemsWithBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemsWithBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemsWithBizInfo(String, String, String, String, List<Object>, List<Object>, String, PageCond)
方法说明 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件）
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员的待领取或者正在运行的工作项列表（结合业务冗余数据查询条件）
 * @param personID 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param bizTableName 业务冗余表名
 * @param wiSql 工作项查询条件sql
 * @param bizSql 业务冗余数据查询条件Sql
 * @param wiBindList 工作项查询绑定值列表
 * @param bizBindList 业务冗余数据查询绑定值列表
 * @param joinFields 业务关联字段
 * @param pageCond 分页信息
 * @return 工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryPersonWorkItemsWithBizInfo(String personID, String permission, String scope, String bizTableName, String wiSql, String bizSql, List<Object> wiBindList, List<Object> bizBindList, String joinFields, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personID String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
bizTableName String 是 业务冗余表名（wfbizmapping中BIZTABLENAME）
wiSql String 是 工作项查询条件sql
bizSql String 是 业务冗余数据查询条件Sql
wiBindList List 是 工作项查询绑定值列表
bizBindList List 是 业务冗余数据查询绑定值列表
joinFields String 是 业务关联字段
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItem>

查询示例

{
    "personId": "1",
    "permission":"ALL",
    "scope": "SELF,AGENT,DELEG,HELP",
    "includeHistory": true,
    "bizTableName": "xf_student",
    "wiSql": "WORKITEMNAME = ? and ISTIMEOUT = ?",
    "bizSql": " name = ?",
    "wiBindList": [
        "人工活动1",
        "N"
    ],
    "bizBindList": [
        "张三"
    ],
    "joinFields":"",
    "pageCond": {
        "begin": 0,
        "beginIndex": 0,
        "count": true,
        "currentPage": 0,
        "first": true,
        "last": true,
        "length": 10,
        "totalCount": 0,
        "totalPage": 0
    }
}

# 12. queryWorkItemBizInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryWorkItemBizInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryWorkItemBizInfo(List<WFWorkItem>, String)
方法说明 扩展工作项的业务属性。该方法必须在EOS PlatForm平台上使用，BPS 6.0中该方法无法使用!
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 扩展工作项的业务属性。该方法必须在EOS PlatForm平台上使用，BPS 6.0中该方法无法使用!
 * @param workItems 工作项列表
 * @param dataSource 数据源
 * @return 扩展后的工作项列表
 * @throws WFApiException
 */
public List<WFWorkItem> queryWorkItemBizInfo(List<WFWorkItem> workItems, String dataSource) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItems List 是 工作项列表
dataSource String 是 数据源
# 返回值

返回类型： List<WFWorkItem>

# 13. queryPersonFinishedWorkItemsWithInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonFinishedWorkItemsWithInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonFinishedWorkItemsWithInfo(String, String, boolean, WorkitemQueryInfo, PageCond)
方法说明 查询指定人员完成的工作项(根据工作项信息查询)
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员完成的工作项(根据工作项信息查询)
 * @param personId 人员ID
 * @param scope 任务来源
 * @param includeHistory 是否包含历史表
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 工作项信息列表
 * @throws WFApiException
 */
public List<WFWorkItemInfo> queryPersonFinishedWorkItemsWithInfo(String personId, String scope, boolean includeHistory, WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
includeHistory boolean 是 是否包含历史表
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItemInfo>

# 14. queryPersonWorkItemsWithInfoInTaskCenter 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemsWithInfoInTaskCenter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemsWithInfoInTaskCenter(String, String, String, WorkitemQueryInfo, PageCond)
方法说明 查询用户的待办工作项列表-任务中心专用
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询用户的待办工作项列表-任务中心专用
 * @param personId 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 待办工作项列表
 * @throws WFApiException
 */
public List<WFWorkItemInfo> queryPersonWorkItemsWithInfoInTaskCenter(String personId, String permission, String scope, WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItemInfo>

# 15. queryPersonWorkItemWithInfoById 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemWithInfoById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemWithInfoById(String, long)
方法说明 根据工作项ID查询单个待办工作项信息
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 根据工作项ID查询单个待办工作项信息
 * @param arg0 人员ID
 * @param processDefID 流程定义ID
 * @return 待办工作项信息
 * @throws WFApiException
 */
public WFWorkItemInfo queryPersonWorkItemWithInfoById(String arg0, long processDefID) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
arg0 String 是 人员ID
processDefID long 是 流程定义ID
# 返回值

返回类型： WFWorkItemInfo

# 16. queryPersonWorkItemReviews 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemReviews
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemReviews(String, String, String, boolean, WorkitemQueryInfo, PageCond)
方法说明 查询指定人员的待阅/已阅工作项-任务中心专用
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询指定人员的待阅/已阅工作项-任务中心专用
 * @param reviewStatus 阅读状态
 * @param personId 人员ID
 * @param scope 任务来源
 * @param includeHistory 是否包含历史表
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 待阅/已阅工作项列表
 * @throws WFApiException
 */
public List<WFWorkItemInfo> queryPersonWorkItemReviews(String reviewStatus, String personId, String scope, boolean includeHistory, WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
reviewStatus String 是 阅读状态(值范围：0，未阅，1已阅)
personId String 是 人员ID
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
includeHistory boolean 是 是否包含历史表
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItemInfo>

# 17. queryPersonReviewWorkItemWithInfoById 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonReviewWorkItemWithInfoById
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonReviewWorkItemWithInfoById(String, long)
方法说明 根据工作项ID查询单个待阅/已阅工作项信息
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 根据工作项ID查询单个待阅/已阅工作项信息
 * @param personId 人员ID
 * @param workItemId 工作项ID
 * @return 待阅/已阅工作项信息
 * @throws WFApiException
 */
public WFWorkItemInfo queryPersonReviewWorkItemWithInfoById(String personId, long workItemId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 人员ID
workItemId long 是 工作项ID
# 返回值

返回类型： WFWorkItemInfo

# 18. queryPersonWorkItemsWithInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemsWithInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemsWithInfo(String, String, String, WorkitemQueryInfo, PageCond)
方法说明 查询用户的待办工作项列表(根据工作项信息查询)
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询用户的待办工作项列表(根据工作项信息查询)
 * @param personId 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 待办工作项列表
 * @throws WFApiException
 */
public List<WFWorkItemInfo> queryPersonWorkItemsWithInfo(String personId, String permission, String scope, WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItemInfo>

# 19. queryPersonWorkItemsWithInfoInTaskCenter 方法接口文档

# 基本信息
项目 说明
接口名称 WFWorklistQueryManager.queryPersonWorkItemsWithInfoInTaskCenter
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWorklistQueryManager.queryPersonWorkItemsWithInfoInTaskCenter(String, String, String, WorkitemQueryInfo, PageCond)
方法说明 查询用户的待办工作项列表-任务中心专用
接口类型 Service API
适用场景 工作项查询服务
# 方法定义
/**
 * 查询用户的待办工作项列表-任务中心专用
 * @param personId 人员ID
 * @param permission 执行权限
 * @param scope 任务来源
 * @param info 工作项查询信息
 * @param pageCond 分页信息
 * @return 待办工作项列表
 * @throws WFApiException
 */
public List<WFWorkItemInfo> queryPersonWorkItemsWithInfoInTaskCenter(String personId, String permission, String scope, WorkitemQueryInfo info, PageCond pageCond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
personId String 是 人员ID
permission String 是 执行权限(值范围：ALL—全部
PUBLIC—公共
PRIVATE—个人

PUBLIC,PRIVATE—组合查询)
scope String 是 任务来源（值范围：ALL—全部
AGENT—代理
DELEG—代办
HELP—协办
AGENT,DELEG,HELP—组合）
info WorkitemQueryInfo 是 工作项查询信息
pageCond PageCond 是 分页信息
# 返回值

返回类型： List<WFWorkItemInfo>

# 三十七、WFWSManager

# 1. isEmbeddedServer 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.isEmbeddedServer
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.isEmbeddedServer
方法说明 判断服务器是否为嵌入式服务器
接口类型 Service API
适用场景 系统环境检测
# 方法定义
/**
 * 判断服务器是否为嵌入式服务器
 * @return 是否为嵌入式服务器
 * @throws WFApiException
 */
public boolean isEmbeddedServer() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 2. isMultiTenantMode 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.isMultiTenantMode
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.isMultiTenantMode
方法说明 判断系统是否为多租户模式
接口类型 Service API
适用场景 系统环境检测
# 方法定义
/**
 * 判断系统是否为多租户模式
 * @return 是否为多租户模式
 * @throws WFApiException
 */
public boolean isMultiTenantMode() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 3. hasBizProcessCustomizeModule 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.hasBizProcessCustomizeModule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.hasBizProcessCustomizeModule
方法说明 判断系统是否包含业务流程定制模块
接口类型 Service API
适用场景 系统功能检测
# 方法定义
/**
 * 判断系统是否包含业务流程定制模块
 * @return 是否包含业务流程定制模块
 * @throws WFApiException
 */
public boolean hasBizProcessCustomizeModule() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 4. hasBizFormCustomizeModule 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.hasBizFormCustomizeModule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.hasBizFormCustomizeModule
方法说明 判断系统是否包含业务表单定制模块
接口类型 Service API
适用场景 系统功能检测
# 方法定义
/**
 * 判断系统是否包含业务表单定制模块
 * @return 是否包含业务表单定制模块
 * @throws WFApiException
 */
public boolean hasBizFormCustomizeModule() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 5. hasBizProcessStatisticsModule 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.hasBizProcessStatisticsModule
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.hasBizProcessStatisticsModule
方法说明 判断系统是否包含流程统计分析模块
接口类型 Service API
适用场景 系统功能检测
# 方法定义
/**
 * 判断系统是否包含流程统计分析模块
 * @return 是否包含流程统计分析模块
 * @throws WFApiException
 */
public boolean hasBizProcessStatisticsModule() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 6. getProcessDefinitionString 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getProcessDefinitionString
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getProcessDefinitionString
方法说明 根据流程定义ID获取流程定义的XML字符串
接口类型 Service API
适用场景 流程定义管理
# 方法定义
/**
 * 根据流程定义ID获取流程定义的XML字符串
 * @param processDefId 流程定义ID
 * @return 流程定义的XML字符串
 * @throws WFApiException
 */
public String getProcessDefinitionString(long processDefId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义ID
# 返回值

返回类型： String

# 7. saveProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.saveProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.saveProcess
方法说明 保存流程定义
接口类型 Service API
适用场景 流程定义管理
# 方法定义
/**
 * 保存流程定义
 * @param processDefId 流程定义ID
 * @param xmlString 流程定义的XML字符串
 * @return 保存结果
 * @throws WFApiException
 */
public WFValidateResponse saveProcess(long processDefId, String xmlString) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义ID
xmlString String 是 流程定义XML
# 返回值

返回类型： WFValidateResponse

# 8. validateProcessString 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.validateProcessString
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.validateProcessString
方法说明 校验流程定义的XML字符串
接口类型 Service API
适用场景 流程定义管理
# 方法定义
/**
 * 校验流程定义的XML字符串
 * @param xmlString 流程定义的XML字符串
 * @return 校验结果
 * @throws WFApiException
 */
public WFValidateResponse validateProcessString(String xmlString) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
xmlString String 是 流程定义XML
# 返回值

返回类型： WFValidateResponse

# 9. getRelaDataString 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getRelaDataString
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getRelaDataString
方法说明 根据流程实例ID获取相关数据的字符串
接口类型 Service API
适用场景 流程实例管理
# 方法定义
/**
 * 根据流程实例ID获取相关数据的字符串
 * @param processInstId 流程实例ID
 * @return 相关数据的字符串
 * @throws WFApiException
 */
public String getRelaDataString(long processInstId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstId long 是 流程实例ID
# 返回值

返回类型： String

# 10. getSystemInfo 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getSystemInfo
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getSystemInfo
方法说明 获取系统信息
接口类型 Service API
适用场景 系统信息查询
# 方法定义
/**
 * 获取系统信息
 * @return 系统信息
 * @throws WFApiException
 */
public Properties getSystemInfo() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： Properties

# 11. startTransport 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.startTransport
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.startTransport
方法说明 启动转历史操作
接口类型 Service API
适用场景 历史数据迁移
# 方法定义
/**
 * 启动转历史操作
 * @return 转历史结果
 * @throws WFApiException
 */
public TranHistoryResult startTransport() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： TranHistoryResult

# 12. getTransportResult 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getTransportResult
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getTransportResult
方法说明 获取转历史结果
接口类型 Service API
适用场景 历史数据迁移
# 方法定义
/**
 * 获取转历史结果
 * @return 转历史结果
 * @throws WFApiException
 */
public TranHistoryResult getTransportResult() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： TranHistoryResult

# 13. listPackagesInWorking 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.listPackagesInWorking
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.listPackagesInWorking
方法说明 列出当前应用的工作目录中某个构件包中所有的指定类型文件
接口类型 Service API
适用场景 文件管理
# 方法定义
/**
 * 列出当前应用的工作目录中某个构件包中所有的指定类型文件
 * @param contributionName 构件包名称
 * @param type 文件类型
 * @return 文件列表
 * @throws WFApiException
 */
public String[] listPackagesInWorking(String contributionName, String type) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
contributionName String 是 构件包名称
type String 是 文件类型
# 返回值

返回类型： String[]

# 14. listPackageFilesInWorkingDir 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.listPackageFilesInWorkingDir
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.listPackageFilesInWorkingDir
方法说明 列出当前应用的工作目录下,一个构件包中某个package中的所有指定类型的文件绝对路径列表
接口类型 Service API
适用场景 文件管理
# 方法定义
/**
 * 列出当前应用的工作目录下,一个构件包中某个package中的所有指定类型的文件绝对路径列表
 * @param contributionName 构件包名称
 * @param packageName 包名
 * @param type 文件类型
 * @return 文件绝对路径列表
 * @throws WFApiException
 */
public String[] listPackageFilesInWorkingDir(String contributionName, String packageName, String type) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
contributionName String 是 构件包名称
packageName String 是 包名
type String 是 文件类型
# 返回值

返回类型： String[]

# 15. getDelegateProcessLog 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getDelegateProcessLog
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getDelegateProcessLog
方法说明 获取代理代办相关操作日志
接口类型 Service API
适用场景 日志管理
# 方法定义
/**
 * 获取代理代办相关操作日志
 * @param processInstId 流程实例ID
 * @param activityInstId 活动实例ID
 * @param workItemId 工作项ID
 * @param activityDefId 活动定义ID
 * @return 代理代办操作日志列表
 * @throws WFApiException
 */
public List<WFMessage> getDelegateProcessLog(long processInstId, String activityInstId, String workItemId, String activityDefId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstId long 是 流程实例ID
activityInstId String 是 活动实例ID
workItemId String 是 工作项ID
activityDefId String 是 活动定义ID
# 返回值

返回类型： List<WFMessage>

# 16. getWFProcess 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getWFProcess
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getWFProcess
方法说明 通过业务流程ID获取流程定义对象
接口类型 Service API
适用场景 流程定义管理
# 方法定义
/**
 * 通过业务流程ID获取流程定义对象
 * @param procDefId 流程定义ID
 * @return 流程定义对象
 * @throws WFApiException
 */
public WFProcess getWFProcess(long procDefId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
procDefId long 是 流程定义ID
# 返回值

返回类型： WFProcess

# 17. queryProcessCatalogsBybizCatalogId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessCatalogsBybizCatalogId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessCatalogsBybizCatalogId
方法说明 获得一个构建包下的所有业务流程目录
接口类型 Service API
适用场景 业务目录管理
# 方法定义
/**
 * 获得一个构建包下的所有业务流程目录
 * @param bizCatalogId 业务目录ID
 * @return 业务流程目录列表
 * @throws WFApiException
 */
public List<WFProcessCatalog> queryProcessCatalogsBybizCatalogId(String bizCatalogId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
bizCatalogId String 是 业务目录ID
# 返回值

返回类型： List<WFProcessCatalog>

# 18. countProcessDefine 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.countProcessDefine
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.countProcessDefine
方法说明 统计业务流程下的版本数
接口类型 Service API
适用场景 流程定义统计
# 方法定义
/**
 * 统计业务流程下的版本数
 * @param processDefName 流程定义名称
 * @return 版本数
 * @throws WFApiException
 */
public int countProcessDefine(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： int

# 19. getLastVersionSign 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getLastVersionSign
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getLastVersionSign
方法说明 获得业务流程的最新版本号
接口类型 Service API
适用场景 流程版本管理
# 方法定义
/**
 * 获得业务流程的最新版本号
 * @param processDefName 流程定义名称
 * @return 最新版本号
 * @throws WFApiException
 */
public String getLastVersionSign(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： String

# 20. getPublishedVersionSign 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getPublishedVersionSign
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getPublishedVersionSign
方法说明 获得业务流程的发布版本号
接口类型 Service API
适用场景 流程版本管理
# 方法定义
/**
 * 获得业务流程的发布版本号
 * @param processDefName 流程定义名称
 * @return 发布版本号
 * @throws WFApiException
 */
public String getPublishedVersionSign(String processDefName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefName String 是 流程定义名称
# 返回值

返回类型： String

# 21. queryProcessViewObject 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessViewObject
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessViewObject
方法说明 根据流程名称查询流程View对象
接口类型 Service API
适用场景 流程视图查询
# 方法定义
/**
 * 根据流程名称查询流程View对象
 * @param processName 流程名称
 * @return 流程View对象
 * @throws WFApiException
 */
public ProcessViewObject queryProcessViewObject(String processName) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processName String 是 流程名称
# 返回值

返回类型： ProcessViewObject

# 22. queryProcessViewObject1 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessViewObject1
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessViewObject1
方法说明 查询流程View对象
接口类型 Service API
适用场景 流程视图查询
# 方法定义
/**
 * 查询流程View对象
 * @param processId 流程ID
 * @return 流程View对象
 * @throws WFApiException
 */
public ProcessViewObject queryProcessViewObject1(long processId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processId long 是 流程ID
# 返回值

返回类型： ProcessViewObject

# 23. queryProcessInstViewObject 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessInstViewObject
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessInstViewObject
方法说明 查询流程实例View对象
接口类型 Service API
适用场景 流程实例视图查询
# 方法定义
/**
 * 查询流程实例View对象
 * @param processInstId 流程实例ID
 * @return 流程实例View对象
 * @throws WFApiException
 */
public ProcessInstViewObject queryProcessInstViewObject(long processInstId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processInstId long 是 流程实例ID
# 返回值

返回类型： ProcessInstViewObject

# 24. queryProcessViewObjectTemp 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessViewObjectTemp
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessViewObjectTemp
方法说明 查询临时库流程View对象
接口类型 Service API
适用场景 流程视图查询
# 方法定义
/**
 * 查询临时库流程View对象
 * @param processId 流程ID
 * @return 流程View对象
 * @throws WFApiException
 */
public ProcessViewObject queryProcessViewObjectTemp(long processId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processId long 是 流程ID
# 返回值

返回类型： ProcessViewObject

# 25. getFormFieldModelByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getFormFieldModelByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getFormFieldModelByWorkItemId
方法说明 根据工作项ID获取表单字段模型
接口类型 Service API
适用场景 表单字段查询
# 方法定义
/**
 * 根据工作项ID获取表单字段模型
 * @param workItemId 工作项ID
 * @return 表单字段列表
 * @throws WFApiException
 */
@Deprecated
public List<FormField> getFormFieldModelByWorkItemId(long workItemId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
# 返回值

返回类型： List<FormField>

# 26. getFormFieldByWorkItemId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getFormFieldByWorkItemId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getFormFieldByWorkItemId
方法说明 根据工作项ID获取表单对象
接口类型 Service API
适用场景 表单对象查询
# 方法定义
/**
 * 根据工作项ID获取表单对象
 * @param workItemId 工作项ID
 * @param prefix 前缀
 * @param formName 表单名称
 * @param requestContextPath 请求上下文路径
 * @param isConvertHtml 是否转化为HTML
 * @return 表单对象列表
 * @throws WFApiException
 */
@Deprecated
public List<AutoFormFieldTagBean> getFormFieldByWorkItemId(long workItemId, String prefix, String formName, String requestContextPath, boolean isConvertHtml) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
workItemId long 是 工作项ID
prefix String 是 前缀
formName String 是 表单名称
requestContextPath String 是 请求上下文路径
isConvertHtml boolean 是 是否转化为HTML
# 返回值

返回类型： List<AutoFormFieldTagBean>

# 27. getFormFieldByActivityInstId 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getFormFieldByActivityInstId
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getFormFieldByActivityInstId
方法说明 根据活动实例ID获取表单对象
接口类型 Service API
适用场景 表单对象查询
# 方法定义
/**
 * 根据活动实例ID获取表单对象
 * @param activityInstId 活动实例ID
 * @param prefix 前缀
 * @param formName 表单名称
 * @param requestContextPath 请求上下文路径
 * @param isConvertHtml 是否转化为HTML
 * @return 表单对象列表
 * @throws WFApiException
 */
@Deprecated
public List<AutoFormFieldTagBean> getFormFieldByActivityInstId(long activityInstId, String prefix, String formName, String requestContextPath, boolean isConvertHtml) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
activityInstId long 是 活动实例ID
prefix String 是 前缀
formName String 是 表单名称
requestContextPath String 是 请求上下文路径
isConvertHtml boolean 是 是否转化为HTML
# 返回值

返回类型： List<AutoFormFieldTagBean>

# 28. getProcessFormfields 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getProcessFormfields
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getProcessFormfields
方法说明 获取启动表单对象
接口类型 Service API
适用场景 表单对象查询
# 方法定义
/**
 * 获取启动表单对象
 * @param processDefId 流程定义ID
 * @param prefix 前缀
 * @param formName 表单名称
 * @param requestContextPath 请求上下文路径
 * @param isConvertHtml 是否转化为HTML
 * @return 表单对象列表
 * @throws WFApiException
 */
@Deprecated
public List<AutoFormFieldTagBean> getProcessFormfields(long processDefId, String prefix, String formName, String requestContextPath, boolean isConvertHtml) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义ID
prefix String 是 前缀
formName String 是 表单名称
requestContextPath String 是 请求上下文路径
isConvertHtml boolean 是 是否转化为HTML
# 返回值

返回类型： List<AutoFormFieldTagBean>

# 29. getProcessFormfieldsModel 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getProcessFormfieldsModel
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getProcessFormfieldsModel
方法说明 获取启动表单对象模型
接口类型 Service API
适用场景 表单对象查询
# 方法定义
/**
 * 获取启动表单对象模型
 * @param processDefId 流程定义ID
 * @return 表单字段列表
 * @throws WFApiException
 */
@Deprecated
public List<FormField> getProcessFormfieldsModel(long processDefId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义ID
# 返回值

返回类型： List<FormField>

# 30. getWFLinkColorConfigModel 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getWFLinkColorConfigModel
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getWFLinkColorConfigModel
方法说明 获取流程图连线配置信息
接口类型 Service API
适用场景 流程图配置查询
# 方法定义
/**
 * 获取流程图连线配置信息
 * @return 流程图连线配置模型
 * @throws WFApiException
 */
@Deprecated
public WFLinkColorConfigModel getWFLinkColorConfigModel() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： WFLinkColorConfigModel

# 31. enableBPSCatalogPermission 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.enableBPSCatalogPermission
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.enableBPSCatalogPermission
方法说明 判断是否开启业务目录权限开关
接口类型 Service API
适用场景 权限管理
# 方法定义
/**
 * 判断是否开启业务目录权限开关
 * @return 是否开启业务目录权限
 * @throws WFApiException
 */
@Deprecated
public boolean enableBPSCatalogPermission() throws WFApiException;
# 参数说明

无参数

# 返回值

返回类型： boolean

# 32. executeMDXQuery 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.executeMDXQuery
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.executeMDXQuery
方法说明 多维查询操作
接口类型 Service API
适用场景 数据查询
# 方法定义
/**
 * 多维查询操作
 * @param ctx 查询条件
 * @param namingQueryId mdx查询语句ID
 * @return 查询结果
 * @throws WFApiException
 */
@Deprecated
public String executeMDXQuery(Map<String, String> ctx, String namingQueryId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
ctx Map<String, String> 是 查询条件
namingQueryId String 是 mdx查询语句ID
# 返回值

返回类型： String

# 33. collectHistoryData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.collectHistoryData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.collectHistoryData
方法说明 收集历史数据
接口类型 Service API
适用场景 数据收集
# 方法定义
/**
 * 收集历史数据
 * @param year 年份
 * @param locale 字符集
 * @return 是否成功
 * @throws WFApiException
 */
@Deprecated
public boolean collectHistoryData(int year, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
year int 是 年份
locale String 是 字符集
# 返回值

返回类型： boolean

# 34. collectCurrentMonthData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.collectCurrentMonthData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.collectCurrentMonthData
方法说明 收集当前月份的数据
接口类型 Service API
适用场景 数据收集
# 方法定义
/**
 * 收集当前月份的数据
 * @param locale 字符集
 * @return 是否成功
 * @throws WFApiException
 */
@Deprecated
public boolean collectCurrentMonthData(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： boolean

# 35. collectOneMonthData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.collectOneMonthData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.collectOneMonthData
方法说明 收集指定月份的数据
接口类型 Service API
适用场景 数据收集
# 方法定义
/**
 * 收集指定月份的数据
 * @param year 年份
 * @param month 月份
 * @param locale 字符集
 * @return 是否成功
 * @throws WFApiException
 */
@Deprecated
public boolean collectOneMonthData(int year, int month, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
year int 是 年份
month int 是 月份
locale String 是 字符集
# 返回值

返回类型： boolean

# 36. collectFactData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.collectFactData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.collectFactData
方法说明 收集默认的事实表数据（上一月数据）
接口类型 Service API
适用场景 数据收集
# 方法定义
/**
 * 收集默认的事实表数据（上一月数据）
 * @param locale 字符集
 * @return 是否成功
 * @throws WFApiException
 */
@Deprecated
public boolean collectFactData(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： boolean

# 37. readEltConfigModel 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.readEltConfigModel
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.readEltConfigModel
方法说明 读取数据统计模型信息
接口类型 Service API
适用场景 数据统计模型管理
# 方法定义
/**
 * 读取数据统计模型信息
 * @param locale 字符集
 * @return 数据统计模型
 * @throws WFApiException
 */
@Deprecated
public EtlConfigModel readEltConfigModel(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： EtlConfigModel

# 38. writeEltConfigModel 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.writeEltConfigModel
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.writeEltConfigModel
方法说明 写入数据统计模型信息，并立即生效
接口类型 Service API
适用场景 数据统计模型管理
# 方法定义
/**
 * 写入数据统计模型信息，并立即生效
 * @param model 参数对象
 * @param locale 字符集
 * @throws WFApiException
 */
@Deprecated
public void writeEltConfigModel(EtlConfigModel model, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
model EtlConfigModel 是 参数对象
locale String 是 字符集
# 返回值

无返回值 void

# 39. isInitHistoryData 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.isInitHistoryData
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.isInitHistoryData
方法说明 判断是否初始化过历史数据
接口类型 Service API
适用场景 历史数据管理
# 方法定义
/**
 * 判断是否初始化过历史数据
 * @param locale 字符集
 * @return 是否初始化过历史数据
 * @throws WFApiException
 */
@Deprecated
public boolean isInitHistoryData(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： boolean

# 40. queryProcessTimeoutDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessTimeoutDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessTimeoutDetail
方法说明 查询流程超时详细信息
接口类型 Service API
适用场景 流程超时管理
# 方法定义
/**
 * 查询流程超时详细信息
 * @param cond 查询条件
 * @return 流程超时详细信息
 * @throws WFApiException
 */
public ProcessDetailResult queryProcessTimeoutDetail(ProcessCond cond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
cond ProcessCond 是 查询条件
# 返回值

返回类型： ProcessDetailResult

# 41. queryActivityTimeoutDetail 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryActivityTimeoutDetail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryActivityTimeoutDetail
方法说明 查询活动超时详细信息
接口类型 Service API
适用场景 活动超时管理
# 方法定义
/**
 * 查询活动超时详细信息
 * @param cond 查询条件
 * @return 活动超时详细信息
 * @throws WFApiException
 */
public ProcessDetailResult queryActivityTimeoutDetail(ProcessCond cond) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
cond ProcessCond 是 查询条件
# 返回值

返回类型： ProcessDetailResult

# 42. getEtlEmail 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getEtlEmail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getEtlEmail
方法说明 以逻辑流的方式返回etl Email 收件人
接口类型 Service API
适用场景 ETL 配置管理
# 方法定义
/**
 * 以逻辑流的方式返回etl Email 收件人
 * @param locale 字符集
 * @return ETL Email 收件人
 * @throws WFApiException
 */
@Deprecated
public String getEtlEmail(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： String

# 43. saveEtlEmail 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.saveEtlEmail
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.saveEtlEmail
方法说明 以逻辑流的方式保存etl Email 收件人
接口类型 Service API
适用场景 ETL 配置管理
# 方法定义
/**
 * 以逻辑流的方式保存etl Email 收件人
 * @param etlEmail ETL Email 收件人
 * @param locale 字符集
 * @throws WFApiException
 */
@Deprecated
public void saveEtlEmail(String etlEmail, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
etlEmail String 是 ETL Email 收件人
locale String 是 字符集
# 返回值

无返回值 void

# 44. getIsOpenProcedure 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getIsOpenProcedure
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getIsOpenProcedure
方法说明 以逻辑流的方式返回是否开启存储过程
接口类型 Service API
适用场景 存储过程配置管理
# 方法定义
/**
 * 以逻辑流的方式返回是否开启存储过程
 * @param locale 字符集
 * @return 是否开启存储过程
 * @throws WFApiException
 */
@Deprecated
public boolean getIsOpenProcedure(String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
locale String 是 字符集
# 返回值

返回类型： boolean

# 45. saveIsOpenProcedure 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.saveIsOpenProcedure
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.saveIsOpenProcedure
方法说明 以逻辑流的方式保存是否开启存储过程
接口类型 Service API
适用场景 存储过程配置管理
# 方法定义
/**
 * 以逻辑流的方式保存是否开启存储过程
 * @param isOpen 是否开启
 * @param locale 字符集
 * @throws WFApiException
 */
@Deprecated
public void saveIsOpenProcedure(boolean isOpen, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
isOpen boolean 是 是否开启
locale String 是 字符集
# 返回值

无返回值 void

# 46. setUnLock 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.setUnLock
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.setUnLock
方法说明 手工强制解锁
接口类型 Service API
适用场景 系统解锁操作
# 方法定义
/**
 * 手工强制解锁
 * @param flag 是否解锁
 * @param locale 字符集
 * @throws WFApiException
 */
@Deprecated
public void setUnLock(boolean flag, String locale) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
flag boolean 是 是否解锁
locale String 是 字符集
# 返回值

无返回值 void

# 47. validateConnection 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.validateConnection
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.validateConnection
方法说明 根据租户绑定的数据源测试连接
接口类型 Service API
适用场景 数据源连接测试
# 方法定义
/**
 * 根据租户绑定的数据源测试连接
 * @param tenantId 租户ID
 * @return 连接是否成功
 * @throws WFApiException
 */
public boolean validateConnection(String tenantId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
tenantId String 是 租户ID
# 返回值

返回类型： boolean

# 48. queryProcessesByBizCatalogUuid 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.queryProcessesByBizCatalogUuid
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.queryProcessesByBizCatalogUuid
方法说明 查询某业务目录下的所有业务流程（最新版本）
接口类型 Service API
适用场景 业务目录管理
# 方法定义
/**
 * 查询某业务目录下的所有业务流程（最新版本）
 * @param catalogUuid 业务目录UUID
 * @return 业务流程列表
 * @throws WFApiException
 */
public List<WFProcessDefine> queryProcessesByBizCatalogUuid(String catalogUuid) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
catalogUuid String 是 业务目录UUID
# 返回值

返回类型： List<WFProcessDefine>

# 49. getProcessRefBizVars 方法接口文档

# 基本信息
项目 说明
接口名称 WFWSManager.getProcessRefBizVars
方法全路径 com.primeton.gocom.bfp.common.bpsclient.WFWSManager.getProcessRefBizVars
方法说明 根据流程定义ID,取出流程引用的业务变量
接口类型 Service API
适用场景 流程变量管理
# 方法定义
/**
 * 根据流程定义ID,取出流程引用的业务变量
 * @param processDefId 流程定义id
 * @return 业务变量列表
 * @throws WFApiException
 */
@Deprecated
public List<String> getProcessRefBizVars(long processDefId) throws WFApiException;
# 参数说明
参数名 类型 必须 说明
processDefId long 是 流程定义id
# 返回值

返回类型： List<String>

← 服务实体接口说明 →