基础框架文档中心

外观

API ​

引擎通过 WorkflowEngineImpl 类对外提供服务。它实现了 WorkflowEngine 接口，在实际开发中可以以该接口注入服务。

java
@Autowired
WorkflowEngine engine;

下面列出引擎提供的 API ，更多详细信息请查看项目 swagger 文档。

create ​

  • 描述：创建工作
  • 参数：
    • {WorkAddDto} input
  • 返回：
    • {String} 工作编号

step ​

  • 描述：根据节点推进工作
  • 参数：
    • {WorkStepNodeDto} input
  • 返回：到达的节点列表

step ​

  • 描述：根据任务推进工作
  • 参数：
    • WorkStepDto input 任务dto
  • 返回：到达的节点列表

reject ​

  • 描述：驳回工作
  • 参数：
    • WorkRejectDto input
  • 返回：无

rejectWithoutDeal ​

  • 描述：驳回工作但不办理当前任务，即保持现有节点不变

    注意：此时dealMsg办理信息无效

  • 参数：
    • WorkRejectDto input
  • 返回：无

cancel ​

  • 描述：取消工作
  • 参数：
    • WorkCancelDto input
  • 返回：无

cancel ​

  • 描述：取消工作

    办理描述信息默认为 “{当前用户}取消工作”

    此时不要求提供节点等信息，因此也无法作其它数据验证。仅在外部应用交互等特殊情况下使用此方法。

  • 参数：
    • String workId
  • 返回：无

cancel ​

  • 描述：取消工作

    此时不要求提供节点等信息，因此也无法作其它数据验证。仅在外部应用交互等特殊情况下使用此方法。

  • 参数：
    • String workId 工作编号
    • String dealMsg 办理消息
  • 返回：无

cancel ​

  • 描述：取消工作

    设置rejectParentToNode可级联回退父流程：

    如果取消当前工作后已无其它子工作，则会将父流程节点任务标记为退回，同时退回到目标节点。 否则，会将目标节点追加到父流程当前节点。

  • 参数：

    • String workId 工作编号
    • String dealMsg 办理消息
    • String rejectParentToNode 父流程回退节点，仅在存在父工作时生效。

  • 返回：无

cancel ​

  • 描述：取消工作
  • 参数：

    • String workId 工作编号

    • String dealMsg 办理消息

    • boolean cascadeParentWork 是否级联推进父工作

      如果取消子流程工作后不存在其它进行中的子流程工作，则会推进父流程工作。

    • Object bizData 业务自定义对象

  • 返回：无

pause ​

  • 描述：暂停工作
  • 参数：
    • String workId 工作编号
  • 返回：无

start ​

  • 描述：启动工作 注意：只能启动在暂停状态的工作
  • 参数：
    • String workId 工作编号
  • 返回：无

delete ​

  • 描述：删除工作。
  • 参数：
    • String workId 工作编号
    • Boolean ignoreOwner 是否忽略任务所有者，默认只能删除本人创建的工作。
    • Boolean mustAtStart 当前工作是否必须在发起节点，默认为true。
  • 返回：无

comment ​

  • 描述：添加办理备注信息
  • 参数：
    • String workId 工作编号
    • String content 评论内容
  • 返回：无

transfer ​

  • 描述：转交工作给指定人员
  • 参数：
    • String taskId 任务编号
    • String userId 用户编号
    • String msg 备注
    • Boolean ignoreOwner 是否忽略任务所有者，默认非工作参与人无法操作。
  • 返回：无

sendReadonly ​

  • 描述：转发工作给指定人员
  • 参数：
    • String taskId 任务编号
    • List<String> userIds 用户编号列表
    • String msg 备注
    • Boolean ignoreOwner 是否忽略任务所有者，默认非工作参与人无法操作。
    • Boolean throwWhenIncludeCurrentUser 当接收人为当前办理人时，是否抛出异常。默认为 true。
  • 返回：无

changeTitle ​

  • 描述：修改工作标题
  • 参数：
    • String workId 工作编号
    • String title 标题
  • 返回：无

changeDealMsg ​

  • 描述：修改任务办理意见，仅用于保存工作时
  • 参数：
    • String taskId 任务编号
    • String content 意见内容
  • 返回：无

getBizInfo ​

  • 描述：获取业务相关信息
  • 参数：
    • String taskId 任务编号
    • String boolean throwWhenCanNotDeal 工作或任务不能办理时抛出异常
    • Boolean ignoreOwner 是否忽略任务所有者，默认非工作参与人无法操作。
  • 返回：TaskBizVo 业务vo

getBizInfo ​

  • 描述：获取业务相关信息
  • 参数：
    • String workId 工作编号
    • String nodeCode 节点编码
    • String boolean throwWhenCanNotDeal 工作或任务不能办理时抛出异常
    • Boolean ignoreOwner 是否忽略任务所有者，默认非工作参与人无法操作。
  • 返回：TaskBizVo 业务vo

adminWorkState ​

  • 描述：管理员操作：修改工作状态
  • 参数：
    • WfAdminStateDto input 状态dto
  • 返回：无

adminCurrentNode ​

  • 描述：管理员操作：修改工作当前节点
  • 参数：
    • WfAdminNodeDto input 节点dto
  • 返回：无

adminCurrentOperator ​

  • 描述：管理员操作：修改工作操作人
  • 参数：
    • WfAdminOperatorDto input 操作人dto
  • 返回：无