org.dromara.warm.flow.core.service

Interface DefService

All Superinterfaces:

IWarmService<Definition>

All Known Implementing Classes:

DefServiceImpl

public interface DefService
extends IWarmService<Definition>

流程定义Service接口

Since:

2023-03-29

Author:

warm

Method Summary

Modifier and Type	Method and Description
boolean	active(Long id) 激活流程
boolean	checkAndSave(Definition definition) 新增流程定义表数据，新增后需要通过saveXml接口保存流程节点和流程跳转数据 校验后新增
void	closeFlowByCodeList(List<String> flowCodeList)
boolean	copyDef(Long id) 复制流程定义
org.dom4j.Document	exportXml(Long id) 导出流程定义(流程定义、流程节点和流程跳转数据)xml的Document对象
String	flowChart(Long instanceId) 根据流程实例ID,获取流程图的图片流(渲染颜色)
List<FlowChart>	flowChartData(Long instanceId) 根据流程实例ID,获取流程图元数据
String	flowChartNoColor(Long definitionId) 根据流程定义ID,获取流程图的图片流(不渲染颜色)
List<FlowChart>	flowChartNoColorData(Long definitionId) 根据流程定义ID,获取流程图元数据
Definition	importXml(InputStream is) 导入流程定义、流程节点和流程跳转数据
boolean	publish(Long id) 发布流程定义
List<Definition>	queryByCodeList(List<String> flowCodeList)
boolean	removeDef(List<Long> ids) 删除流程定义相关数据
void	saveXml(Definition def) 保存流程节点和流程跳转数据
void	saveXml(Long id, String xmlString) 保存流程节点和流程跳转数据
boolean	unActive(Long id) 挂起流程：流程定义挂起后，相关的流程实例都无法继续流转
boolean	unPublish(Long id) 取消发布流程定义
String	xmlString(Long id) 获取流程定义xml(流程定义、流程节点和流程跳转数据)的字符串

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

importXml

Definition importXml(InputStream is)
              throws Exception

导入流程定义、流程节点和流程跳转数据

Parameters:

is - 流程定义xml的输入流

Throws:

Exception

saveXml

void saveXml(Definition def)
      throws Exception

保存流程节点和流程跳转数据

Parameters:

def - 流程定义对象

Throws:

Exception

saveXml

void saveXml(Long id,
             String xmlString)
      throws Exception

保存流程节点和流程跳转数据

Parameters:

id - 流程定义id

xmlString - 流程定义xml字符串

Throws:

Exception

exportXml

org.dom4j.Document exportXml(Long id)

导出流程定义(流程定义、流程节点和流程跳转数据)xml的Document对象

Parameters:

id - 流程定义id

Returns:

Document

xmlString

String xmlString(Long id)

获取流程定义xml(流程定义、流程节点和流程跳转数据)的字符串

Parameters:

id - 流程定义id

Returns:

xmlString

queryByCodeList

List<Definition> queryByCodeList(List<String> flowCodeList)

closeFlowByCodeList

void closeFlowByCodeList(List<String> flowCodeList)

checkAndSave

boolean checkAndSave(Definition definition)

新增流程定义表数据，新增后需要通过saveXml接口保存流程节点和流程跳转数据 校验后新增

Parameters:

definition - 流程定义对象

Returns:

boolean

removeDef

boolean removeDef(List<Long> ids)

删除流程定义相关数据

Parameters:

ids - 流程定义id列表

Returns:

boolean

publish

boolean publish(Long id)

发布流程定义

Parameters:

id - 流程定义id

Returns:

boolean

unPublish

boolean unPublish(Long id)

取消发布流程定义

Parameters:

id - 流程定义id

Returns:

boolean

copyDef

boolean copyDef(Long id)

复制流程定义

Parameters:

id - 流程定义id

Returns:

boolean

flowChart

String flowChart(Long instanceId)
          throws IOException

根据流程实例ID,获取流程图的图片流(渲染颜色)

Parameters:

instanceId - 流程实例id

Returns:

base64编码的图片流字符串

Throws:

IOException

flowChartData

List<FlowChart> flowChartData(Long instanceId)
                       throws IOException

根据流程实例ID,获取流程图元数据

Parameters:

instanceId - 流程实例id

Returns:

List

Throws:

IOException

flowChartNoColor

String flowChartNoColor(Long definitionId)
                 throws IOException

根据流程定义ID,获取流程图的图片流(不渲染颜色)

Parameters:

definitionId - 流程定义id

Returns:

base64编码的图片流字符串

Throws:

IOException

flowChartNoColorData

List<FlowChart> flowChartNoColorData(Long definitionId)
                              throws IOException

根据流程定义ID,获取流程图元数据

Parameters:

definitionId - 流程定义id

Returns:

List

Throws:

IOException

active

boolean active(Long id)

激活流程

Parameters:

id - 流程定义id

unActive

boolean unActive(Long id)

挂起流程：流程定义挂起后，相关的流程实例都无法继续流转

Parameters:

id - 流程定义id