相关接口类说明

WorkflowFactory

功能说明

工厂类，用于获取工作流操作和管理接口的实例。

方法列表

方法名	功能描述	参数	返回值
`getWorkflowOperator()`	获取工作流操作接口实例	无	`IWorkflowOperator`
`getWorkflowManager()`	获取工作流管理接口实例	无	`IWorkflowManager`
`getWorkParaBean()`	创建参数对象实例	无	`WorkParaBean`

使用示例

java

// 获取操作接口
IWorkflowOperator opr = WorkflowFactory.getWorkflowOperator();

// 获取管理接口
IWorkflowManager mgr = WorkflowFactory.getWorkflowManager();

// 创建参数对象
WorkParaBean param = WorkflowFactory.getWorkParaBean();

IWorkflowOperator

功能说明

工作流实例操作接口，提供创建、打开、关闭实例以及各种流程流转操作。

方法列表

方法名	功能描述	参数	返回值
`create(WorkParaBean)`	创建流程实例	`WorkParaBean` - 参数对象	`IWorkResult`
`open(WorkParaBean)`	打开流程实例	`WorkParaBean` - 参数对象	`IWorkResult`
`close(String, String, String)`	关闭流程实例	`workId`, `trackId`, `userId`	`void`
`operator(WorkParaBean)`	执行实例操作	`WorkParaBean` - 参数对象	`IWorkResult`
`operators(List)`	批量执行实例操作	`List<WorkParaBean>` - 参数列表	`List<IWorkResult>`
`operatorsTransactionalConsistency(List)`	事务一致性批量操作	`List<WorkParaBean>` - 参数列表	`List<IWorkResult>`
`getHistory(String, String)`	获取实例历史记录	`workId`, `identifier`	`List<DBLog>`

IWorkflowManager

功能说明

工作流实例管理接口，提供工作移交、实例恢复、暂停/恢复、结束等管理操作。

方法列表

方法名	功能描述	参数	返回值
`handOverWork(WorkParaBean)`	工作移交	`WorkParaBean` - 参数对象	`IWorkResult`
`receiveHandOverWork(WorkParaBean)`	接收工作移交	`WorkParaBean` - 参数对象	`IWorkResult`
`activeTrack(WorkParaBean)`	激活实例路径	`WorkParaBean` - 参数对象	`IWorkResult`
`recoverWork(WorkParaBean)`	恢复实例到指定版本	`WorkParaBean` - 参数对象	`IWorkResult`
`pauseWork(WorkParaBean)`	暂停实例	`WorkParaBean` - 参数对象	`IWorkResult`
`resumeWork(WorkParaBean)`	恢复实例	`WorkParaBean` - 参数对象	`IWorkResult`
`endWork(WorkParaBean)`	结束实例	`WorkParaBean` - 参数对象	`IWorkResult`
`replaceOperator(WorkParaBean)`	替换办理人	`WorkParaBean` - 参数对象	`IWorkResult`
`deleteWork(WorkParaBean)`	删除实例	`WorkParaBean` - 参数对象	`IWorkResult`
`updateWorkFlowData(WorkParaBean)`	更新实例定义数据	`WorkParaBean` - 参数对象	`IWorkResult`
`queryTodoList(String, String, String)`	查询待办列表	`userId`, `tenantCode`, `identifier`	`List<TodoItem>`
`queryDoneList(String, String, String)`	查询已办列表	`userId`, `tenantCode`, `identifier`	`List<DoneItem>`
`queryReadList(String, String, String)`	查询待阅列表	`userId`, `tenantCode`, `identifier`	`List<ReadItem>`
`queryReadDoneList(String, String, String)`	查询已阅列表	`userId`, `tenantCode`, `identifier`	`List<ReadDoneItem>`

WorkParaBean

功能说明

工作流操作参数封装类，用于传递各种操作所需的参数。

核心字段

字段名	类型	说明
`flowId`	String	流程定义ID
`workId`	String	实例ID
`trackId`	String	路径ID
`nodeId`	String	节点ID
`userId`	String	用户ID
`tenantCode`	String	租户ID
`dataIdentifier`	String	业务数据源标识
`flowIdentifier`	String	流程数据源标识
`actionClass`	String	操作实现类全路径
`funname`	String	操作标识
`actionname`	String	操作中文名称
`submitflag`	String	是否确认操作
`nextNodeId`	String	下一节点ID
`selectAuthorMap`	Map<String,String>	选择的办理人信息
`flowVarMap`	Map<String,String>	流程变量

核心方法

方法名	功能描述
`setFlowId(String)`	设置流程定义ID
`setWorkId(String)`	设置实例ID
`setTrackId(String)`	设置路径ID
`setNodeId(String)`	设置节点ID
`setUserId(String)`	设置用户ID
`setTenantCode(String)`	设置租户ID
`setDataIdentifier(String)`	设置业务数据源标识
`setFlowIdentifier(String)`	设置流程数据源标识
`setActionClass(String)`	设置操作实现类
`setFunname(String)`	设置操作标识
`setActionname(String)`	设置操作名称
`setSubmitflag(String)`	设置确认标志
`setNextNodeId(String)`	设置下一节点ID
`setSelectAuthorMap(Map)`	设置办理人Map
`putSelectAuthor(String, String)`	添加单个办理人
`setFlowVarMap(Map)`	设置流程变量Map

IWorkResult

功能说明

工作流操作返回结果接口，封装操作执行后的返回信息。

核心方法

方法名	功能描述	返回值类型
`getResult()`	获取操作结果码	`int`
`getBackMsg()`	获取返回提示信息	`String`
`getWork()`	获取实例信息对象	`DBWork`
`getCurNode()`	获取当前节点配置	`IXmlNode`
`getCurTrackInfo()`	获取当前路径信息	`DBTrack`
`getNextTrackInfos()`	获取下一路径信息列表	`List<DBTrack>`
`getCurUser()`	获取当前执行人信息	`IRunUser`
`getFlowInfo()`	获取流程定义信息	`IXmlFlowInfo`
`getFlowVarMap()`	获取流程变量Map	`Map<String,String>`
`getNextNodes()`	获取下一节点列表	`List<INextNode>`
`getNextNodeids()`	获取下一节点ID数组	`String[]`

结果码说明

结果码	含义
0	成功
1	无法获取下一节点
2	提示选择节点
3	提示办理人为空
4	提示选择人员
5	流程结束
6	子流程未结束
7	流程暂停
8	流程异常终止
9	其他错误提示
14	已经启动过子流程
15	需要选择子流程
16	协办人提交
17	不满足合并节点的离开规则
22	进入规则调用异常
23	离开规则调用错误
24	该节点类型不支持相应的操作
25	启用规则调用错误
26	节点激活失败

IXmlNode

功能说明

节点配置信息接口，封装流程定义中节点的配置信息。

核心方法

方法名	功能描述	返回值类型
`getNodeId()`	获取节点ID	`String`
`getNodeName()`	获取节点名称	`String`
`getNodeType()`	获取节点类型	`String`
`getAuthorType()`	获取办理人类型	`String`
`getLineInfos()`	获取路由信息列表	`List<IXmlLine>`

IXmlFlowInfo

功能说明

流程定义信息接口，封装流程定义的整体信息。

核心方法

方法名	功能描述	返回值类型
`getFlowId()`	获取流程ID	`String`
`getFlowName()`	获取流程名称	`String`
`getStartNodeId()`	获取开始节点ID	`String`
`getNodeInfos()`	获取所有节点配置	`Map<String, IXmlNode>`

DBWork

功能说明

实例信息对象，封装流程实例的运行时数据。

核心字段

字段名	类型	说明
`workId`	String	实例ID
`flowId`	String	流程定义ID
`workName`	String	实例名称
`status`	int	实例状态
`createTime`	Date	创建时间
`creator`	String	创建人

DBTrack

功能说明

路径信息对象，封装流程实例中路径的运行时数据。

核心字段

字段名	类型	说明
`trackId`	String	路径ID
`workId`	String	所属实例ID
`nodeId`	String	当前节点ID
`status`	int	路径状态

IRunUser

功能说明

运行时用户信息接口，封装当前操作人的信息。

核心方法

方法名	功能描述	返回值类型
`getUserId()`	获取用户ID	`String`
`getUserName()`	获取用户名称	`String`
`getDeptId()`	获取部门ID	`String`
`getDeptName()`	获取部门名称	`String`

相关接口类说明 ​

WorkflowFactory ​

功能说明 ​

方法列表 ​

使用示例 ​

IWorkflowOperator ​

功能说明 ​

方法列表 ​

IWorkflowManager ​

功能说明 ​

方法列表 ​

WorkParaBean ​

功能说明 ​

核心字段 ​

核心方法 ​

IWorkResult ​

功能说明 ​

核心方法 ​

结果码说明 ​

IXmlNode ​

功能说明 ​

核心方法 ​

IXmlFlowInfo ​

功能说明 ​

核心方法 ​

DBWork ​

功能说明 ​

核心字段 ​

DBTrack ​

功能说明 ​

核心字段 ​

IRunUser ​

功能说明 ​

核心方法 ​

相关接口类说明

WorkflowFactory

功能说明

方法列表

使用示例

IWorkflowOperator

功能说明

方法列表

IWorkflowManager

功能说明

方法列表

WorkParaBean

功能说明

核心字段

核心方法

IWorkResult

功能说明

核心方法

结果码说明

IXmlNode

功能说明

核心方法

IXmlFlowInfo

功能说明

核心方法

DBWork

功能说明

核心字段

DBTrack

功能说明

核心字段

IRunUser

功能说明

核心方法