org.dromara.warm.flow.core.service

Interface InsService

All Superinterfaces:

IWarmService<Instance>

All Known Implementing Classes:

InsServiceImpl

public interface InsService
extends IWarmService<Instance>

流程实例Service接口

Since:

2023-03-29

Author:

warm

Method Summary

Modifier and Type	Method and Description
boolean	active(Long id) 激活实例
boolean	remove(List<Long> instanceIds) 根据实例ids，删除流程
Instance	skipByInsId(Long instanceId, FlowParams flowParams) 根据实例id，流程跳转，一般是开始节点后第一个节点，用来提交申请，此时不可有同时两个待办任务
Instance	start(String businessId, FlowParams flowParams) 传入业务id开启流程
Instance	termination(Long instanceId, FlowParams flowParams) 终止流程，提前结束流程，将所有待办任务转历史
boolean	unActive(Long id) 挂起实例，流程实例挂起后，该流程实例无法继续流转

Methods inherited from interface org.dromara.warm.flow.core.orm.service.IWarmService

exists, getById, getByIds, getDao, getOne, list, list, orderBy, orderByAsc, orderByCreateTime, orderByDesc, orderById, orderByUpdateTime, page, remove, removeById, removeByIds, save, saveBatch, saveBatch, selectCount, updateBatch, updateById

Method Detail

start

Instance start(String businessId,
               FlowParams flowParams)

传入业务id开启流程

Parameters:

businessId: - 业务id[必传]

flowParams: - 包含流程相关参数的对象 - flowCode: 流程编码 [必传] - handler: 办理人唯一标识[建议传] - variable: 流程变量[按需传输] - flowStatus: 流程状态，自定义流程状态[按需传输] - ext: 扩展字段，预留给业务系统使用[按需传输]

Returns:

流程实例

skipByInsId

Instance skipByInsId(Long instanceId,
                     FlowParams flowParams)

根据实例id，流程跳转，一般是开始节点后第一个节点，用来提交申请，此时不可有同时两个待办任务

Parameters:

instanceId:流程实例id[必传] -

flowParams:包含流程相关参数的对象 - - skipType:跳转类型(PASS审批通过 REJECT退回) [必传] - nodeCode: 办理人权限标识，比如用户，角色，部门等,未设置办理人或者ignore为true可不传 [按需传输] - permissionFlag: 办理人权限标识，比如用户，角色，部门等[只有未设置办理人时可不传] - message: 审批意见[按需传输] - handler: 办理人唯一标识[建议传] - variable: 流程变量[按需传输,跳转条件放入流程变量<互斥网关必传>] - flowStatus: 流程状态，自定义流程状态[按需传输] - ignore 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]

Returns:

流程实例

termination

Instance termination(Long instanceId,
                     FlowParams flowParams)

终止流程，提前结束流程，将所有待办任务转历史

Parameters:

instanceId:流程实例id[必传] -

flowParams:包含流程相关参数的对象 - - message: 审批意见 [按需传输] - handler: 办理人唯一标识[建议传] - flowStatus: 流程状态，自定义流程状态[按需传输] - ignore 转办忽略权限校验，默认不忽略（true：忽略，false：不忽略）[按需传输]

remove

boolean remove(List<Long> instanceIds)

根据实例ids，删除流程

Parameters:

instanceIds: - 流程实例集合[必传]

active

boolean active(Long id)

激活实例

Parameters:

id - 流程实例id: [必传]

unActive

boolean unActive(Long id)

挂起实例，流程实例挂起后，该流程实例无法继续流转

Parameters:

id - 流程实例id: [必传]