ProcessAPI (Java SDK API Reference for AWS PaaS)

```
public interface ProcessAPI
```
流程实例控制(Process Instance)接口。如果API调用的上下文已提供ProcessInstance这样的实例对象，使用对应的参数方法可减少构建实例对象的不必要开销

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`cancel(ProcessInstance processInst, UserContext userContext)` 取消流程，终止并补偿一个流程实例。
`void`	`cancelByBusinessKey(java.lang.String processBusinessKey, java.lang.String uid)` 通过processBusinessKey取消流程，终止并补偿一个流程实例。
`void`	`cancelById(java.lang.String processInstId, java.lang.String uid)` 通过id取消流程，终止并补偿一个流程实例。
`ProcessInstance`	`createBOProcessInstance(java.lang.String processDefId, java.lang.String uid, java.lang.String title)` 创建一个仅存储实例控制，适用于DW
`ProcessInstance`	`createProcessInstance(java.lang.String processDefId, java.lang.String uid, java.lang.String title)` 创建一个流程实例，支持短流程或人工+系统混编的流程。
`ProcessInstance`	`createProcessInstance(java.lang.String processDefId, java.lang.String uid, java.lang.String createUserDeptId, java.lang.String createUserRoleId, java.lang.String title, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个流程实例，支持短流程或人工+系统混编的流程。
`ProcessInstance`	`createProcessInstance(java.lang.String processDefId, java.lang.String processBusinessKey, java.lang.String uid, java.lang.String createUserDeptId, java.lang.String createUserRoleId, java.lang.String title, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个流程实例，支持短流程或人工+系统混编的流程。
`ProcessInstance`	`createShortProcessInstance(java.lang.String processDefId)` 创建一个流程实例，适用于系统集成类的短流程启动。
`ProcessInstance`	`createShortProcessInstance(java.lang.String processDefId, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个流程实例，适用于系统集成类的短流程启动。
`ProcessInstance`	`createShortProcessInstance(java.lang.String processDefId, java.lang.String processBusinessKey, java.lang.String title, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个流程实例，适用于系统集成类的短流程启动。
`ProcessInstance`	`createSubProcessInstance(java.lang.String createUser, java.lang.String title, java.lang.String callActivityTaskInstId, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个常规子流程实例，支持短流程或人工+系统混编的流程。
`ProcessInstance`	`createSubProcessInstance(java.lang.String processBusinessKey, java.lang.String createUser, java.lang.String title, java.lang.String callActivityTaskInstId, java.util.Map<java.lang.String,java.lang.Object> vars)` 创建一个常规子流程实例，支持短流程或人工+系统混编的流程。
`boolean`	`delete(ProcessInstance processInst, UserContext userContext)` 删除流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
`boolean`	`deleteByBusinessKey(java.lang.String processBusinessKey, java.lang.String uid)` 通过processBusinessKey删除一个流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
`boolean`	`deleteById(java.lang.String processInstId, java.lang.String uid)` 通过id删除流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
`java.util.List<TaskCommentModel>`	`getCommentsByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey获得流程实例的审批留言记录，适用于人工或人工系统混编的流程。
`java.util.List<TaskCommentModel>`	`getCommentsById(java.lang.String processInstId)` 通过Id获得流程实例的审批留言记录，适用于人工或人工系统混编的流程。
`int`	`getCountOfActiveTaskByBusinessKey(java.lang.String processBusinessKey, boolean isSuspend)` 通过processBusinessKey统计流程处于活动状态的任务数量。
`int`	`getCountOfActiveTaskById(java.lang.String processInstId, boolean isSuspend)` 通过id统计流程处于活动状态的任务数量。
`java.lang.String`	`getExecutionWellDescription(java.util.List<ProcessExecutionTrack> trackList)` 给用户友好的引擎处理结果说明，这是一个工具方法
`java.util.List<java.lang.String>`	`getHistoryParticipantsByBusinessKey(java.lang.String processBusinessKey, java.lang.String processDefId, java.lang.String activityDefId, boolean isTransitionTask)` 通过processBusinessKey获得流程实例的历史参与者账户列表，适用于人工或人工系统混编的流程。
`java.util.List<java.lang.String>`	`getHistoryParticipantsById(java.lang.String processInstId, java.lang.String processDefId, java.lang.String activityDefId, boolean isTransitionTask)` 通过Id获得流程实例的历史参与者账户列表，适用于人工或人工系统混编的流程。
`ProcessInstance`	`getInstanceByBusinessKey(java.lang.String processBusinessKey)` 获得一个流程实例对象
`ProcessInstance`	`getInstanceById(java.lang.String processInstId)` 获得一个流程实例对象
`java.lang.Object`	`getVariable(ProcessInstance processInst, java.lang.String varName)` 读取变量值
`java.lang.Object`	`getVariable(java.lang.String processInstId, java.lang.String varName)` 读取变量值
`java.lang.Object`	`getVariableByBusinessKey(java.lang.String processBusinessKey, java.lang.String varName)` 读取变量值
`java.util.Map<java.lang.String,java.lang.Object>`	`getVariables(ProcessInstance processInst)` 读取变量值列表
`java.util.Map<java.lang.String,java.lang.Object>`	`getVariables(ProcessInstance processInst, java.lang.String scope)` 读取流程变量列表，可根据fetchFile控制是否同时读取字节流类型变量值
`java.util.Map<java.lang.String,java.lang.Object>`	`getVariables(java.lang.String processInstId)` 通过id读取变量值列表
`java.util.Map<java.lang.String,java.lang.Object>`	`getVariablesByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey读取变量值列表
`boolean`	`isEndByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey判断流程实例是否已结束。
`boolean`	`isEndById(java.lang.String processInstId)` 通过id判断流程实例是否已结束。
`boolean`	`isRestart(ProcessInstance processInst)` 判断流程实例是否允许撤销重办
`boolean`	`isRestartByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey判断流程实例是否允许撤销重办。
`boolean`	`isRestartById(java.lang.String processInstId)` 通过id判断流程实例是否允许撤销重办。
`boolean`	`isSuspendByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey判断流程实例是否被挂起
`boolean`	`isSuspendById(java.lang.String processInstId)` 通过id判断流程实例是否被挂起。
`boolean`	`isTrash(java.lang.String processInstId)` 判断流程实例是否垃圾数据（绑定表单后无BO数据）
`ProcessQueryAPI`	`query()` 获得一个流程实例查询
`TaskInstance`	`reactivate(ProcessInstance processInst, java.lang.String targetActivityId, boolean isClearHistory, java.lang.String uid, java.lang.String targetUID, java.lang.String reactivateReason)` 流程复活，重新激活已结束的流程实例
`TaskInstance`	`reactivateByBusinessKey(java.lang.String processBusinessKey, java.lang.String targetActivityId, boolean isClearHistory, java.lang.String uid, java.lang.String targetUID, java.lang.String reactivateReason)` 通过processBusinessKey流程复活，重新激活已结束的流程实例。
`TaskInstance`	`reactivateById(java.lang.String processInstId, java.lang.String targetActivityId, boolean isClearHistory, java.lang.String uid, java.lang.String targetUID, java.lang.String reactivateReason)` 通过id流程复活，重新激活已结束的流程实例。
`void`	`remindMail(UserContext sender, ProcessInstance processInst)` 给当前办理者发送催办邮件（有外部邮箱配置的用户，优先发送外部邮件）
`void`	`remindMailByBusinessKey(java.lang.String uid, java.lang.String processBusinessKey)` 通过processBusinessKey给当前办理者发送催办邮件（办理者的AWS账号需要配置互联网邮箱地址）。
`void`	`remindMailById(java.lang.String uid, java.lang.String processInstId)` 通过Id给当前办理者发送催办邮件（办理者的AWS账号需要配置互联网邮箱地址）。
`TaskInstance`	`restart(ProcessInstance processInst, java.lang.String restartReason)` 重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。
`TaskInstance`	`restartByBusinessKey(java.lang.String processBusinessKey, java.lang.String restartReason)` 通过processBusinessKey重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。
`TaskInstance`	`restartById(java.lang.String processInstId, java.lang.String restartReason)` 通过id重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。
`boolean`	`resume(ProcessInstance processInst)` 恢复被挂起的流程实例
`boolean`	`resume(java.lang.String processInstId)` 通过id恢复被挂起的流程实例
`boolean`	`resumeByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey恢复被挂起的流程实例
`boolean`	`setExtParameter(java.lang.String processInstId, java.util.Map<java.lang.String,java.lang.String> extParameters)` 设置流程实例扩展参数值，最多8个
`void`	`setIoX(java.lang.String processInstId, java.lang.String advanceType, java.lang.String valueId)` 设置流程实例关联的高级分类规则。
`void`	`setTitle(java.lang.String processInstId, java.lang.String title)` 设置流程标题
`void`	`setTrash(java.lang.String processInstId, boolean isTrash)` 更新流程实例垃圾数据状态
`void`	`setVariable(ProcessInstance processInst, java.lang.String varName, java.lang.Object varValue)` 为流程变量赋值
`void`	`setVariable(ProcessInstance processInst, java.lang.String varName, java.lang.Object varValue, java.lang.String scope)` 设置具有指定范围的变量
`void`	`setVariable(java.lang.String processInstId, java.lang.String varName, java.lang.Object varValue)` 通过Id为流程变量赋值
`void`	`setVariableByBusinessKey(java.lang.String processBusinessKey, java.lang.String varName, java.lang.Object varValue)` 通过processBusinessKey为流程变量赋值
`void`	`setVariables(ProcessInstance processInst, java.util.Map<java.lang.String,java.lang.Object> vars)` 批量设置流程变量
`void`	`setVariables(ProcessInstance processInst, java.util.Map<java.lang.String,java.lang.Object> vars, java.lang.String scope)` 设置具有指定范围的变量列表
`void`	`setVariables(java.lang.String processInstId, java.util.Map<java.lang.String,java.lang.Object> vars)` 通过Id为批量赋值流程变量
`void`	`setVariablesByBusinessKey(java.lang.String processBusinessKey, java.util.Map<java.lang.String,java.lang.Object> vars)` 通过processBusinessKey为批量赋值流程变量
`java.util.List<ProcessInstance>`	`signalStartEventReceived(java.lang.String signalName)` 将信号发送给信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
`java.util.List<ProcessInstance>`	`signalStartEventReceived(java.lang.String signalName, java.lang.String corelation)` 将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
`java.util.List<ProcessInstance>`	`signalStartEventReceived(java.lang.String signalName, java.lang.String corelation, java.util.Map<java.lang.String,java.lang.Object> payload)` 将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
`java.util.List<ProcessInstance>`	`signalStartEventReceived(java.lang.String signalName, java.lang.String processBusinessKey, java.lang.String uid, java.lang.String createUserDeptId, java.lang.String createUserRoleId, java.lang.String title, java.lang.String corelation, java.util.Map<java.lang.String,java.lang.Object> payload)` 捕获一个信号，将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
`ProcessExecuteQuery`	`start(ProcessInstance processInst)` 启动流程，使用第1个NoneStartEvent来启动该流程。
`ProcessExecuteQuery`	`start(ProcessInstance processInst, java.lang.String startEventDefId)` 启动流程，如果未指定startEvent事件，系统默认使用第1个NoneStartEvent来启动该流程。
`ProcessExecuteQuery`	`startByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey启动流程，使用第1个NoneStartEvent来启动该流程。
`ProcessExecuteQuery`	`startByBusinessKey(java.lang.String processBusinessKey, java.lang.String startEventDefId)` 通过processBusinessKey启动流程。
`ProcessExecuteQuery`	`startById(java.lang.String processInstId)` 通过id启动流程，使用第1个NoneStartEvent来启动该流程。
`ProcessExecuteQuery`	`startById(java.lang.String processInstId, java.lang.String startEventDefId)` 通过id启动流程。
`ProcessInstance`	`startByMessage(java.lang.String messageName)` 消息启动事件
`ProcessInstance`	`startByMessage(java.lang.String messageName, java.lang.String processBusinessKey)` 消息启动事件
`ProcessInstance`	`startByMessage(java.lang.String messageName, java.lang.String processBusinessKey, java.util.Map<java.lang.String,java.lang.Object> payload)` 消息启动事件
`ProcessInstance`	`startByMessage(java.lang.String messageName, java.lang.String processBusinessKey, java.lang.String uid, java.lang.String createUserDeptId, java.lang.String createUserRoleId, java.lang.String title, java.util.Map<java.lang.String,java.lang.Object> payload)` 消息启动事件
`boolean`	`suspend(ProcessInstance processInst)` 挂起流程实例，挂起的流程实例被暂停执行
`boolean`	`suspend(java.lang.String processInstId)` 通过id挂起流程实例，挂起的流程实例被暂停执行
`boolean`	`suspendByBusinessKey(java.lang.String processBusinessKey)` 通过processBusinessKey挂起流程实例，挂起的流程实例被暂停执行。
`void`	`terminate(ProcessInstance processInst, UserContext userContext)` 终止一个流程实例。
`void`	`terminateByBusinessKey(java.lang.String processBusinessKey, java.lang.String uid)` 通过processBusinessKey终止一个流程实例。
`void`	`terminateById(java.lang.String processInstId, java.lang.String uid)` 通过id终止一个流程实例。

- 方法详细资料
  - createShortProcessInstance
```
ProcessInstance createShortProcessInstance(java.lang.String processDefId)
                                    throws AWSAPIException,
                                           BPMNError
```
    创建一个流程实例，适用于系统集成类的短流程启动。短流程是指没有人工节点(UserTask)的系统流程，可能在瞬间执行完毕。
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createShortProcessInstance
```
ProcessInstance createShortProcessInstance(java.lang.String processDefId,
                                           java.util.Map<java.lang.String,java.lang.Object> vars)
                                    throws AWSAPIException,
                                           BPMNError
```
    创建一个流程实例，适用于系统集成类的短流程启动。短流程是指没有人工节点(UserTask)的系统流程，可能在瞬间执行完毕。
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    vars - 流程变量值，可以为null
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createShortProcessInstance
```
ProcessInstance createShortProcessInstance(java.lang.String processDefId,
                                           java.lang.String processBusinessKey,
                                           java.lang.String title,
                                           java.util.Map<java.lang.String,java.lang.Object> vars)
                                    throws AWSAPIException,
                                           BPMNError
```
    创建一个流程实例，适用于系统集成类的短流程启动。短流程是指没有人工节点(UserTask)的系统流程，可能在瞬间执行完毕。
    
    该方法主要用于集成外部表单或为外部系统提供流程API服务，processBusinessKey在工作流引擎实例表中必须是全局不重复的值，比如一个CRM系统的订单编号（如该业务键将执行多个不同的BPM流程，如订单的审批流程、订单的发货流程，则该业务键应该是个组合值，例如2012003 -APPROVAL、 2012003-SHIPMENT）。使用processBusinessKey可避免外部系统建立与BPMS的实例对照字段
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    title - 便于系统维护人员识别的实例短标题名，可以为null
    
    vars - 流程变量值，可以为null
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createProcessInstance
```
ProcessInstance createProcessInstance(java.lang.String processDefId,
                                      java.lang.String uid,
                                      java.lang.String title)
                               throws AWSAPIException,
                                      BPMNError
```
    创建一个流程实例，支持短流程或人工+系统混编的流程。
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    uid - 创建人，一个合法的AWS账户名
    
    title - 流程标题，建议给定一个方便用户识别的扼要信息，长度建议在64位内
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createProcessInstance
```
ProcessInstance createProcessInstance(java.lang.String processDefId,
                                      java.lang.String uid,
                                      java.lang.String createUserDeptId,
                                      java.lang.String createUserRoleId,
                                      java.lang.String title,
                                      java.util.Map<java.lang.String,java.lang.Object> vars)
                               throws AWSAPIException,
                                      BPMNError
```
    创建一个流程实例，支持短流程或人工+系统混编的流程。该方法支持了createUserDeptId参数，如果流程启动者可能含有ORG兼任的身份，该参数用来获得启动者的实际启动身份。
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    uid - 创建人，一个合法的AWS账户名
    
    createUserDeptId - 启动者所在的部门ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    createUserRoleId - 启动者的角色ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内
    
    vars - 流程变量值，可以为null
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createProcessInstance
```
ProcessInstance createProcessInstance(java.lang.String processDefId,
                                      java.lang.String processBusinessKey,
                                      java.lang.String uid,
                                      java.lang.String createUserDeptId,
                                      java.lang.String createUserRoleId,
                                      java.lang.String title,
                                      java.util.Map<java.lang.String,java.lang.Object> vars)
                               throws AWSAPIException,
                                      BPMNError
```
    创建一个流程实例，支持短流程或人工+系统混编的流程。该方法支持了createUserDeptId参数，如果流程启动者可能含有ORG兼任的身份，该参数用来获得启动者的启动身份。
    
    该方法主要用于集成外部表单或为外部系统提供流程API服务，processBusinessKey在工作流引擎实例表中必须是全局不重复的值，比如一个CRM系统的订单编号（如该业务键将执行多个不同的BPM流程，如订单的审批流程、订单的发货流程，则该业务键应该是个组合值，例如2012003 -APPROVAL、 2012003-SHIPMENT）。使用processBusinessKey可避免外部系统建立与BPMS的实例对照字段。
    
    参数:
    
    processDefId - 流程定义ID,如果是versionId则根据版本状态使用"RUN"版本
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    uid - 创建人，一个合法的AWS账户名
    
    createUserDeptId - 启动者所在的部门ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    createUserRoleId - 启动者的角色ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内
    
    vars - 流程变量值，可以为null
    
    返回:
    
    创建的流程实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createBOProcessInstance
```
ProcessInstance createBOProcessInstance(java.lang.String processDefId,
                                        java.lang.String uid,
                                        java.lang.String title)
                                 throws AWSAPIException,
                                        BPMNError
```
    创建一个仅存储实例控制，适用于DW
    
    参数:
    
    processDefId - 定义ID
    
    uid - 创建人，一个合法的AWS账户名
    
    title - 信息标题，建议给定一个方便用户识别的扼要信息
    
    返回:
    
    创建的实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - createSubProcessInstance
```
ProcessInstance createSubProcessInstance(java.lang.String createUser,
                                         java.lang.String title,
                                         java.lang.String callActivityTaskInstId,
                                         java.util.Map<java.lang.String,java.lang.Object> vars)
```
    创建一个常规子流程实例，支持短流程或人工+系统混编的流程。
    
    参数:
    
    createUser - 创建人，一个合法的AWS账户名
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内
    
    callActivityTaskInstId - 调用子流程（Call Activity）节点的任务实例ID
    
    vars - 流程变量值，可以为null
    
    返回:
  - createSubProcessInstance
```
ProcessInstance createSubProcessInstance(java.lang.String processBusinessKey,
                                         java.lang.String createUser,
                                         java.lang.String title,
                                         java.lang.String callActivityTaskInstId,
                                         java.util.Map<java.lang.String,java.lang.Object> vars)
```
    创建一个常规子流程实例，支持短流程或人工+系统混编的流程。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    createUser - 创建人，一个合法的AWS账户名
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内
    
    callActivityTaskInstId - 调用子流程（Call Activity）节点的任务实例ID
    
    vars - 流程变量值，可以为null
    
    返回:
  - start
```
ProcessExecuteQuery start(ProcessInstance processInst)
                   throws AWSAPIException,
                          BPMNError
```
    启动流程，使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processInst - 流程实例结构对象
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - startByBusinessKey
```
ProcessExecuteQuery startByBusinessKey(java.lang.String processBusinessKey)
                                throws AWSAPIException,
                                       BPMNError
```
    通过processBusinessKey启动流程，使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - startById
```
ProcessExecuteQuery startById(java.lang.String processInstId)
                       throws AWSAPIException,
                              BPMNError
```
    通过id启动流程，使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - start
```
ProcessExecuteQuery start(ProcessInstance processInst,
                          java.lang.String startEventDefId)
                   throws AWSAPIException,
                          BPMNError
```
    启动流程，如果未指定startEvent事件，系统默认使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processInst - 流程实例结构对象
    
    startEventDefId - 从哪个StartEvent开始流程,如果是null会查找第一个NoneStartEvnet元素
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - startByBusinessKey
```
ProcessExecuteQuery startByBusinessKey(java.lang.String processBusinessKey,
                                       java.lang.String startEventDefId)
                                throws AWSAPIException,
                                       BPMNError
```
    通过processBusinessKey启动流程。如果未指定startEvent事件，系统默认使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    startEventDefId - 从哪个StartEvent开始流程,如果是null会查找第一个NoneStartEvnet元素
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - startById
```
ProcessExecuteQuery startById(java.lang.String processInstId,
                              java.lang.String startEventDefId)
                       throws AWSAPIException,
                              BPMNError
```
    通过id启动流程。如果未指定startEvent事件，系统默认使用第1个NoneStartEvent来启动该流程。
    
    参数:
    
    processInstId - 流程实例ID
    
    startEventDefId - 从哪个StartEvent开始流程,如果是null会查找第一个NoneStartEvnet元素
    
    返回:
    
    由ProcessExecuteQuery包装的引擎执行结果
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - delete
```
boolean delete(ProcessInstance processInst,
               UserContext userContext)
        throws AWSAPIException,
               BPMNError
```
    删除流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
    
    参数:
    
    processInst - 流程实例对象
    
    userContext - 操作人对象
    
    返回:
    
    成功返回ture或抛出异常。如果返回false，有删除前事件不允许该流程实例的删除
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - deleteById
```
boolean deleteById(java.lang.String processInstId,
                   java.lang.String uid)
            throws AWSAPIException,
                   BPMNError
```
    通过id删除流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
    
    参数:
    
    processInstId - 流程实例ID
    
    uid - 操作人，一个合法的AWS账户名
    
    返回:
    
    成功返回ture或抛出异常。如果返回false，有删除前事件不允许该流程实例的删除。
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - deleteByBusinessKey
```
boolean deleteByBusinessKey(java.lang.String processBusinessKey,
                            java.lang.String uid)
                     throws AWSAPIException,
                            BPMNError
```
    通过processBusinessKey删除一个流程实例，与流程实例(及子流程实例嵌套)相关的业务数据、控制数据、变量等全部删除。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    uid - 操作人，一个合法的AWS账户名
    
    返回:
    
    成功返回ture或抛出异常。如果返回false，有删除前事件不允许该流程实例的删除
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - terminate
```
void terminate(ProcessInstance processInst,
               UserContext userContext)
        throws AWSAPIException,
               BPMNError
```
    终止一个流程实例。不按照预先的流程路径自然完成流程的执行，强行终止流程各分支活动的任务（及子流程活动）和活动令牌，然后执行close操作。若此时有任务未处理完，将终止的任务转换到 H表，其controlstate状态被标记为terminate
    
    参数:
    
    processInst - 流程实例对象
    
    userContext - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - terminateById
```
void terminateById(java.lang.String processInstId,
                   java.lang.String uid)
            throws AWSAPIException,
                   BPMNError
```
    通过id终止一个流程实例。不按照预先的流程路径自然完成流程的执行，强行终止流程各分支活动的任务（及子流程活动）和活动令牌，然后执行close操作。若此时有任务未处理完，将终止的任务转换到 H表，其controlstate状态被标记为terminate。
    
    参数:
    
    processInstId - 流程实例ID
    
    uid - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - terminateByBusinessKey
```
void terminateByBusinessKey(java.lang.String processBusinessKey,
                            java.lang.String uid)
                     throws AWSAPIException,
                            BPMNError
```
    通过processBusinessKey终止一个流程实例。不按照预先的流程路径自然完成流程的执行，强行终止流程各分支活动的任务（及子流程活动）和活动令牌，然后执行close操作。若此时有任务未处理完，将终止的任务转换到 H表，其controlstate状态被标记为terminate。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    uid - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - cancel
```
void cancel(ProcessInstance processInst,
            UserContext userContext)
     throws AWSAPIException,
            BPMNError
```
    取消流程，终止并补偿一个流程实例。强行终止流程各分支活动的任务和活动令牌，然后执行close操作。在终止时，执行任务定义的补偿事件。若此时有任务未处理完，将终止的任务转换到H表，其controlstate状态被标记为cancel
    
    参数:
    
    processInst - 流程实例对象
    
    userContext - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - cancelById
```
void cancelById(java.lang.String processInstId,
                java.lang.String uid)
         throws AWSAPIException,
                BPMNError
```
    通过id取消流程，终止并补偿一个流程实例。强行终止流程各分支活动的任务和活动令牌，然后执行close操作。在终止时，执行任务定义的补偿事件。若此时有任务未处理完，将终止的任务转换到H表，其controlstate状态被标记为cancel。
    
    参数:
    
    processInstId - 流程实例ID
    
    uid - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - cancelByBusinessKey
```
void cancelByBusinessKey(java.lang.String processBusinessKey,
                         java.lang.String uid)
                  throws AWSAPIException,
                         BPMNError
```
    通过processBusinessKey取消流程，终止并补偿一个流程实例。强行终止流程各分支活动的任务和活动令牌，然后执行close操作。在终止时，执行任务定义的补偿事件。若此时有任务未处理完，将终止的任务转换到H表，其controlstate状态被标记为cancel。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    uid - 终止人，可以为null
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - isEndById
```
boolean isEndById(java.lang.String processInstId)
           throws AWSAPIException
```
    通过id判断流程实例是否已结束。
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    结束返回true，否则返回false
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - isEndByBusinessKey
```
boolean isEndByBusinessKey(java.lang.String processBusinessKey)
                    throws AWSAPIException
```
    通过processBusinessKey判断流程实例是否已结束。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    结束返回true，否则返回false
    
    抛出:
    
    AWSAPIException - 系统异常
  - isSuspendById
```
boolean isSuspendById(java.lang.String processInstId)
               throws AWSAPIException
```
    通过id判断流程实例是否被挂起。
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    挂起返回true，否则返回false
    
    抛出:
    
    AWSAPIException
  - isSuspendByBusinessKey
```
boolean isSuspendByBusinessKey(java.lang.String processBusinessKey)
                        throws AWSAPIException
```
    通过processBusinessKey判断流程实例是否被挂起
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    挂起返回true，否则返回false
    
    抛出:
    
    AWSAPIException
  - suspend
```
boolean suspend(ProcessInstance processInst)
         throws AWSAPIException,
                BPMNError
```
    挂起流程实例，挂起的流程实例被暂停执行
    
    参数:
    
    processInst - 流程实例对象
    
    返回:
    
    挂起成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - suspend
```
boolean suspend(java.lang.String processInstId)
         throws AWSAPIException,
                BPMNError
```
    通过id挂起流程实例，挂起的流程实例被暂停执行
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    挂起成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - suspendByBusinessKey
```
boolean suspendByBusinessKey(java.lang.String processBusinessKey)
                      throws AWSAPIException,
                             BPMNError
```
    通过processBusinessKey挂起流程实例，挂起的流程实例被暂停执行。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    挂起成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - resume
```
boolean resume(ProcessInstance processInst)
        throws AWSAPIException,
               BPMNError
```
    恢复被挂起的流程实例
    
    参数:
    
    processInst - 流程实例对象
    
    返回:
    
    激活成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - resume
```
boolean resume(java.lang.String processInstId)
        throws AWSAPIException,
               BPMNError
```
    通过id恢复被挂起的流程实例
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    激活成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - resumeByBusinessKey
```
boolean resumeByBusinessKey(java.lang.String processBusinessKey)
                     throws AWSAPIException,
                            BPMNError
```
    通过processBusinessKey恢复被挂起的流程实例
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    激活成功返回true
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - setTitle
```
void setTitle(java.lang.String processInstId,
              java.lang.String title)
```
    设置流程标题
    
    参数:
    
    processInstId - 任务实例Id
    
    title - 流程标题
  - isTrash
```
boolean isTrash(java.lang.String processInstId)
```
    判断流程实例是否垃圾数据（绑定表单后无BO数据）
    
    参数:
    
    processInstId - 任务实例Id
    
    返回:
    
    流程实例的状态，true：表示为垃圾数据（绑定表单后无BO数据）；false：表示为有效数据
    
    从以下版本开始:
    
    6.2.15
  - setTrash
```
void setTrash(java.lang.String processInstId,
              boolean isTrash)
```
    更新流程实例垃圾数据状态
    
    参数:
    
    processInstId - 任务实例Id
    
    isTrash - true：表示设置为垃圾数据；false：表示设置为有效数据
    
    从以下版本开始:
    
    6.2.15
  - setVariables
```
void setVariables(ProcessInstance processInst,
                  java.util.Map<java.lang.String,java.lang.Object> vars)
           throws AWSAPIException
```
    批量设置流程变量
    
    参数:
    
    processInst - 流程实例对象
    
    vars - key,value列表
    
    抛出:
    
    AWSAPIException
  - setVariables
```
void setVariables(java.lang.String processInstId,
                  java.util.Map<java.lang.String,java.lang.Object> vars)
           throws AWSAPIException
```
    通过Id为批量赋值流程变量
    
    参数:
    
    processInstId - 流程实例ID
    
    vars - key,value列表
    
    抛出:
    
    AWSAPIException
  - setVariables
```
void setVariables(ProcessInstance processInst,
                  java.util.Map<java.lang.String,java.lang.Object> vars,
                  java.lang.String scope)
           throws AWSAPIException
```
    设置具有指定范围的变量列表
    
    参数:
    
    processInst - 流程实例对象
    
    vars - key,value列表
    
    scope - 变量声明范围，如果为null或public表示全流程
    
    抛出:
    
    AWSAPIException
  - setVariablesByBusinessKey
```
void setVariablesByBusinessKey(java.lang.String processBusinessKey,
                               java.util.Map<java.lang.String,java.lang.Object> vars)
                        throws AWSAPIException
```
    通过processBusinessKey为批量赋值流程变量
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    vars - key,value列表
    
    抛出:
    
    AWSAPIException
  - setVariable
```
void setVariable(ProcessInstance processInst,
                 java.lang.String varName,
                 java.lang.Object varValue)
          throws AWSAPIException
```
    为流程变量赋值
    
    参数:
    
    processInst - 流程实例对象
    
    varName - 变量名
    
    varValue - 值
    
    抛出:
    
    AWSAPIException
  - setVariable
```
void setVariable(java.lang.String processInstId,
                 java.lang.String varName,
                 java.lang.Object varValue)
          throws AWSAPIException
```
    通过Id为流程变量赋值
    
    参数:
    
    processInstId - 流程实例ID
    
    varName - 变量名
    
    varValue - 值
    
    抛出:
    
    AWSAPIException
  - setVariable
```
void setVariable(ProcessInstance processInst,
                 java.lang.String varName,
                 java.lang.Object varValue,
                 java.lang.String scope)
          throws AWSAPIException
```
    设置具有指定范围的变量
    
    参数:
    
    processInst - 流程实例
    
    varName - 变量名
    
    varValue - 值
    
    scope - 变量声明范围，如果为null或public表示全流程
    
    抛出:
    
    AWSAPIException
  - setVariableByBusinessKey
```
void setVariableByBusinessKey(java.lang.String processBusinessKey,
                              java.lang.String varName,
                              java.lang.Object varValue)
                       throws AWSAPIException
```
    通过processBusinessKey为流程变量赋值
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    varName - 变量名
    
    varValue - 值
    
    抛出:
    
    AWSAPIException
  - getVariables
```
java.util.Map<java.lang.String,java.lang.Object> getVariables(ProcessInstance processInst)
```
    读取变量值列表
    
    参数:
    
    processInst - 流程实例对象
    
    返回:
    
    一个Key/Value结构，如果该变量尚未赋值，返回null或默认值
  - getVariables
```
java.util.Map<java.lang.String,java.lang.Object> getVariables(java.lang.String processInstId)
```
    通过id读取变量值列表
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    一个Key/Value结构
    
    抛出:
    
    AWSAPIException
  - getVariables
```
java.util.Map<java.lang.String,java.lang.Object> getVariables(ProcessInstance processInst,
                                                              java.lang.String scope)
```
    读取流程变量列表，可根据fetchFile控制是否同时读取字节流类型变量值
    
    参数:
    
    processInst - 流程实例ID
    
    scope - 变量声明范围，如果为null或public表示全流程
  - getVariablesByBusinessKey
```
java.util.Map<java.lang.String,java.lang.Object> getVariablesByBusinessKey(java.lang.String processBusinessKey)
```
    通过processBusinessKey读取变量值列表
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    一个Key/Value结构
    
    抛出:
    
    AWSAPIException
  - getVariable
```
java.lang.Object getVariable(ProcessInstance processInst,
                             java.lang.String varName)
```
    读取变量值
    
    参数:
    
    processInst - 流程实例对象
    
    varName - 流程变量名
    
    返回:
    
    一个Object，如果该变量尚未赋值，返回null或默认值
  - getVariable
```
java.lang.Object getVariable(java.lang.String processInstId,
                             java.lang.String varName)
```
    读取变量值
    
    参数:
    
    processInstId - 流程实例ID
    
    varName - 流程变量名
    
    返回:
    
    一个Object，如果该变量尚未赋值，返回null或默认值
  - getVariableByBusinessKey
```
java.lang.Object getVariableByBusinessKey(java.lang.String processBusinessKey,
                                          java.lang.String varName)
```
    读取变量值
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    varName - 流程变量名
    
    返回:
    
    一个Object，如果该变量尚未赋值，返回null或默认值
  - setIoX
```
void setIoX(java.lang.String processInstId,
            java.lang.String advanceType,
            java.lang.String valueId)
```
    设置流程实例关联的高级分类规则。IoX(Instance Of XXX)，实例属于...
    
    参数:
    
    processInstId - 流程实例Id
    
    advanceType - 类型，见InstanceAdvanceExtendConst常量定义
    
    valueId - 细类定义Id，一个36位的串
    
    另请参阅:
    
    InstanceAdvanceExtendConst
  - setExtParameter
```
boolean setExtParameter(java.lang.String processInstId,
                        java.util.Map<java.lang.String,java.lang.String> extParameters)
```
    设置流程实例扩展参数值，最多8个
    
    参数:
    
    processInstId - 流程实例Id
    
    extParameters - 系统预留的8个扩展字段，Key为字段名(EXT1...EXT8)注意大写，Value为值。EXT1(字符串64)/EXT2(字符串128)/EXT3(字符串255)/EXT4(字符串255)/EXT5(字符串128)/EXT6(字符串128)/EXT7(数值12)/EXT8(数值14,2)
    
    返回:
    
    成功返回true
  - signalStartEventReceived
```
java.util.List<ProcessInstance> signalStartEventReceived(java.lang.String signalName)
```
    将信号发送给信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
    
    参数:
    
    signalName - 信号开始事件绑定的信号变量名，区分大小写。由信号开始事件（Signal Start Event）建模配置时给定
    
    返回:
    
    由信号开始事件启动的流程实例
  - signalStartEventReceived
```
java.util.List<ProcessInstance> signalStartEventReceived(java.lang.String signalName,
                                                         java.lang.String corelation)
```
    将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
    
    参数:
    
    signalName - 信号开始事件绑定的信号变量名，区分大小写。由信号开始事件（Signal Start Event）建模配置时给定
    
    corelation - 与捕获规则指定的@公式进行值匹配。如果信号开始事件未定义@公式，此项匹配被忽略
    
    返回:
    
    由信号开始事件启动的流程实例
  - signalStartEventReceived
```
java.util.List<ProcessInstance> signalStartEventReceived(java.lang.String signalName,
                                                         java.lang.String corelation,
                                                         java.util.Map<java.lang.String,java.lang.Object> payload)
```
    将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
    
    参数:
    
    signalName - 信号开始事件绑定的信号变量名，区分大小写。由信号开始事件（Signal Start Event）建模配置时给定
    
    corelation - 与捕获规则指定的@公式进行值匹配。如果信号开始事件未定义@公式，此项匹配被忽略
    
    payload - 初始化信号捕获事件绑定的数据结构对象（BO Structure）、流程变量
    
    返回:
    
    由信号开始事件启动的流程实例
  - signalStartEventReceived
```
java.util.List<ProcessInstance> signalStartEventReceived(java.lang.String signalName,
                                                         java.lang.String processBusinessKey,
                                                         java.lang.String uid,
                                                         java.lang.String createUserDeptId,
                                                         java.lang.String createUserRoleId,
                                                         java.lang.String title,
                                                         java.lang.String corelation,
                                                         java.util.Map<java.lang.String,java.lang.Object> payload)
```
    捕获一个信号，将信号发送给订阅的信号开始事件（Signal Start Event）进行匹配，匹配成功启动对应流程
    
    参数:
    
    signalName - 信号开始事件绑定的信号变量名，区分大小写。由信号开始事件（Signal Start Event）建模配置时给定
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    uid - 创建人，一个合法的AWS账户名。可以为null
    
    createUserDeptId - 启动者所在的部门ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    createUserRoleId - 启动者的角色ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内，可以为null
    
    corelation - 与捕获规则指定的@公式进行值匹配。如果信号开始事件未定义@公式，此项匹配被忽略
    
    payload - 初始化信号捕获事件绑定的数据结构对象（BO Structure）、流程变量
    
    返回:
    
    由信号开始事件启动的流程实例
  - startByMessage
```
ProcessInstance startByMessage(java.lang.String messageName)
```
    消息启动事件
    
    参数:
    
    messageName - 消息名称，区分大小写。由消息开始事件（Message Start Event）建模配置时给定
    
    返回:
    
    消息启动事件启动的流程实例
  - startByMessage
```
ProcessInstance startByMessage(java.lang.String messageName,
                               java.lang.String processBusinessKey)
```
    消息启动事件
    
    参数:
    
    messageName - 消息名称，区分大小写。由消息开始事件（Message Start Event）建模配置时给定
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    返回:
    
    消息启动事件启动的流程实例
  - startByMessage
```
ProcessInstance startByMessage(java.lang.String messageName,
                               java.lang.String processBusinessKey,
                               java.util.Map<java.lang.String,java.lang.Object> payload)
```
    消息启动事件
    
    参数:
    
    messageName - 消息名称，区分大小写。由消息开始事件（Message Start Event）建模配置时给定
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    payload - 初始化流程变量
    
    返回:
    
    消息启动事件启动的流程实例
  - startByMessage
```
ProcessInstance startByMessage(java.lang.String messageName,
                               java.lang.String processBusinessKey,
                               java.lang.String uid,
                               java.lang.String createUserDeptId,
                               java.lang.String createUserRoleId,
                               java.lang.String title,
                               java.util.Map<java.lang.String,java.lang.Object> payload)
```
    消息启动事件
    
    参数:
    
    messageName - 消息名称，区分大小写。由消息开始事件（Message Start Event）建模配置时给定
    
    uid - 创建人，一个合法的AWS账户名。可以为null
    
    createUserDeptId - 启动者所在的部门ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    createUserRoleId - 启动者的角色ID（这个参数用于使用兼任身份启动流程，可以为null）
    
    title - 流程标题，给定一个方便用户识别的扼要信息，长度建议在64位内，可以为null
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复，可以为null
    
    payload - 初始化流程变量
    
    返回:
    
    消息启动事件启动的流程实例
  - restart
```
TaskInstance restart(ProcessInstance processInst,
                     java.lang.String restartReason)
              throws AWSAPIException,
                     BPMNError
```
    重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。撤销操作将删除令牌、所有待办已办任务等流程数据，如果给定了reStartReason值，将撤销原因初始化成审批记录。如果该流程启动了子流程一并将子流程删除。
    
    参数:
    
    processInst - 流程实例对象
    
    restartReason - 撤销原因
    
    返回:
    
    撤销到首个节点的任务模型对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - restartById
```
TaskInstance restartById(java.lang.String processInstId,
                         java.lang.String restartReason)
                  throws AWSAPIException,
                         BPMNError
```
    通过id重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。撤销操作将删除令牌、所有待办已办任务等流程数据，如果给定了reStartReason值，将撤销原因初始化成审批记录。如果该流程启动了子流程一并将子流程删除。
    
    参数:
    
    processInstId - 流程实例ID
    
    restartReason - 撤销原因
    
    返回:
    
    撤销到首个节点的任务模型对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - restartByBusinessKey
```
TaskInstance restartByBusinessKey(java.lang.String processBusinessKey,
                                  java.lang.String restartReason)
                           throws AWSAPIException,
                                  BPMNError
```
    通过processBusinessKey重置流程到第一个节点，将任务创建给流程启动者，等同于由启动者撤销重办业务（适用于开始事件后是UserTask的人工流程）。撤销操作将删除令牌、所有待办已办任务等流程数据，如果给定了reStartReason值，将撤销原因初始化成审批记录。如果该流程启动了子流程一并将子流程删除。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    restartReason - 撤销原因
    
    返回:
    
    撤销到首个节点的任务模型对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
  - reactivate
```
TaskInstance reactivate(ProcessInstance processInst,
                        java.lang.String targetActivityId,
                        boolean isClearHistory,
                        java.lang.String uid,
                        java.lang.String targetUID,
                        java.lang.String reactivateReason)
                 throws AWSAPIException,
                        BPMNError
```
    流程复活，重新激活已结束的流程实例
    
    参数:
    
    processInst - 流程实例对象
    
    targetActivityId - 激活的目标节点，如果指定为null或空串，流程重新执行
    
    isClearHistory - 是否清空历史处理过程
    
    uid - 操作者，一个合法的AWS账户名
    
    targetUID - 如果目标节点是人工任务，需指定任务的参与者
    
    reactivateReason - 激活流程的原因
    
    返回:
    
    复活的任务实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
    
    另请参阅:
    
    ProcessReactivateCompensationListener
  - reactivateById
```
TaskInstance reactivateById(java.lang.String processInstId,
                            java.lang.String targetActivityId,
                            boolean isClearHistory,
                            java.lang.String uid,
                            java.lang.String targetUID,
                            java.lang.String reactivateReason)
                     throws AWSAPIException,
                            BPMNError
```
    通过id流程复活，重新激活已结束的流程实例。
    
    参数:
    
    processInstId - 流程实例ID
    
    targetActivityId - 激活的目标节点，如果指定为null或空串，流程重新执行
    
    isClearHistory - 是否清空历史处理过程
    
    uid - 操作者，一个合法的AWS账户名
    
    targetUID - 如果目标节点是人工任务，需指定任务的参与者
    
    reactivateReason - 激活流程的原因
    
    返回:
    
    复活的任务实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
    
    另请参阅:
    
    ProcessReactivateCompensationListener
  - reactivateByBusinessKey
```
TaskInstance reactivateByBusinessKey(java.lang.String processBusinessKey,
                                     java.lang.String targetActivityId,
                                     boolean isClearHistory,
                                     java.lang.String uid,
                                     java.lang.String targetUID,
                                     java.lang.String reactivateReason)
                              throws AWSAPIException,
                                     BPMNError
```
    通过processBusinessKey流程复活，重新激活已结束的流程实例。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    targetActivityId - 激活的目标节点，如果指定为null或空串，流程重新执行
    
    isClearHistory - 是否清空历史处理过程
    
    uid - 操作者，一个合法的AWS账户名
    
    targetUID - 如果目标节点是人工任务，需指定任务的参与者
    
    reactivateReason - 激活流程的原因
    
    返回:
    
    复活的任务实例对象
    
    抛出:
    
    AWSAPIException - 系统异常
    
    BPMNError - 业务异常
    
    另请参阅:
    
    ProcessReactivateCompensationListener
  - isRestart
```
boolean isRestart(ProcessInstance processInst)
```
    判断流程实例是否允许撤销重办
    
    参数:
    
    processInst - 流程实例对象
    
    返回:
    
    允许撤销重办返回true
  - isRestartById
```
boolean isRestartById(java.lang.String processInstId)
               throws AWSAPIException
```
    通过id判断流程实例是否允许撤销重办。
    
    参数:
    
    processInstId - 流程实例Id
    
    返回:
    
    允许撤销重办返回true
    
    抛出:
    
    AWSAPIException
  - isRestartByBusinessKey
```
boolean isRestartByBusinessKey(java.lang.String processBusinessKey)
                        throws AWSAPIException
```
    通过processBusinessKey判断流程实例是否允许撤销重办。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    允许撤销重办返回true
    
    抛出:
    
    AWSAPIException
  - getCountOfActiveTaskById
```
int getCountOfActiveTaskById(java.lang.String processInstId,
                             boolean isSuspend)
```
    通过id统计流程处于活动状态的任务数量。
    
    参数:
    
    processInstId - 流程实例ID
    
    isSuspend - 是否包含挂起的任务
    
    返回:
    
    数量
  - getCountOfActiveTaskByBusinessKey
```
int getCountOfActiveTaskByBusinessKey(java.lang.String processBusinessKey,
                                      boolean isSuspend)
                               throws AWSAPIException
```
    通过processBusinessKey统计流程处于活动状态的任务数量。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    isSuspend - 是否包含挂起的任务
    
    返回:
    
    数量
    
    抛出:
    
    AWSAPIException
  - remindMail
```
void remindMail(UserContext sender,
                ProcessInstance processInst)
         throws AWSAPIException
```
    给当前办理者发送催办邮件（有外部邮箱配置的用户，优先发送外部邮件）
    
    参数:
    
    sender - 操作者
    
    processInst - 流程实例对象
    
    抛出:
    
    AWSAPIException
  - remindMailById
```
void remindMailById(java.lang.String uid,
                    java.lang.String processInstId)
             throws AWSAPIException
```
    通过Id给当前办理者发送催办邮件（办理者的AWS账号需要配置互联网邮箱地址）。若支持该功能，需要平台安装"com.actionsoft.apps.addons.mail"应用
    
    参数:
    
    uid - 操作者，一个合法的AWS账户名
    
    processInstId - 流程实例Id
    
    抛出:
    
    AWSAPIException
  - remindMailByBusinessKey
```
void remindMailByBusinessKey(java.lang.String uid,
                             java.lang.String processBusinessKey)
                      throws AWSAPIException
```
    通过processBusinessKey给当前办理者发送催办邮件（办理者的AWS账号需要配置互联网邮箱地址）。若支持该功能，需要平台安装"com.actionsoft.apps.addons.mail"应用
    
    参数:
    
    uid - 操作者，一个合法的AWS账户名
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    抛出:
    
    AWSAPIException
  - getCommentsById
```
java.util.List<TaskCommentModel> getCommentsById(java.lang.String processInstId)
```
    通过Id获得流程实例的审批留言记录，适用于人工或人工系统混编的流程。
    
    参数:
    
    processInstId - 流程实例ID
    
    返回:
    
    TaskCommentModel列表
  - getCommentsByBusinessKey
```
java.util.List<TaskCommentModel> getCommentsByBusinessKey(java.lang.String processBusinessKey)
                                                   throws AWSAPIException
```
    通过processBusinessKey获得流程实例的审批留言记录，适用于人工或人工系统混编的流程。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    TaskCommentModel列表
    
    抛出:
    
    AWSAPIException
  - getHistoryParticipantsById
```
java.util.List<java.lang.String> getHistoryParticipantsById(java.lang.String processInstId,
                                                            java.lang.String processDefId,
                                                            java.lang.String activityDefId,
                                                            boolean isTransitionTask)
```
    通过Id获得流程实例的历史参与者账户列表，适用于人工或人工系统混编的流程。
    
    参数:
    
    processInstId - 流程实例ID，可以为null
    
    processDefId - 流程定义ID，可以为null
    
    activityDefId - 节点定义ID，可以为null
    
    isTransitionTask - 是否只获取参与办理任务的账户，而不包括传阅、通知类的人员账户
    
    返回:
    
    账户名列表
  - getHistoryParticipantsByBusinessKey
```
java.util.List<java.lang.String> getHistoryParticipantsByBusinessKey(java.lang.String processBusinessKey,
                                                                     java.lang.String processDefId,
                                                                     java.lang.String activityDefId,
                                                                     boolean isTransitionTask)
                                                              throws AWSAPIException
```
    通过processBusinessKey获得流程实例的历史参与者账户列表，适用于人工或人工系统混编的流程。
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    processDefId - 流程定义ID，可以为null
    
    activityDefId - 节点定义ID，可以为null
    
    isTransitionTask - 是否只获取参与办理任务的账户，而不包括传阅、通知类的人员账户
    
    返回:
    
    账户名列表
    
    抛出:
    
    AWSAPIException
  - getInstanceById
```
ProcessInstance getInstanceById(java.lang.String processInstId)
```
    获得一个流程实例对象
    
    参数:
    
    processInstId - 流程实例Id
    
    返回:
    
    实例对象
  - getInstanceByBusinessKey
```
ProcessInstance getInstanceByBusinessKey(java.lang.String processBusinessKey)
```
    获得一个流程实例对象
    
    参数:
    
    processBusinessKey - 外部业务系统数据主键标识值或一个组合值，在工作流引擎实例表中全局不能重复
    
    返回:
    
    实例对象
  - getExecutionWellDescription
```
java.lang.String getExecutionWellDescription(java.util.List<ProcessExecutionTrack> trackList)
```
    给用户友好的引擎处理结果说明，这是一个工具方法
    
    参数:
    
    trackList - 引擎执行后的堆栈队列
  - query
```
ProcessQueryAPI query()
```
    获得一个流程实例查询
    
    返回:
    
    实例查询接口

接口 ProcessAPI

方法概要

方法详细资料

createShortProcessInstance

createShortProcessInstance

createShortProcessInstance

createProcessInstance

createProcessInstance

createProcessInstance

createBOProcessInstance

createSubProcessInstance

createSubProcessInstance

start

startByBusinessKey

startById

start

startByBusinessKey

startById

delete

deleteById

deleteByBusinessKey

terminate

terminateById

terminateByBusinessKey

cancel

cancelById

cancelByBusinessKey

isEndById

isEndByBusinessKey

isSuspendById

isSuspendByBusinessKey

suspend

suspend

suspendByBusinessKey

resume

resume

resumeByBusinessKey

setTitle

isTrash

setTrash

setVariables

setVariables

setVariables

setVariablesByBusinessKey

setVariable

setVariable

setVariable

setVariableByBusinessKey

getVariables

getVariables

getVariables

getVariablesByBusinessKey

getVariable

getVariable

getVariableByBusinessKey

setIoX

setExtParameter

signalStartEventReceived

signalStartEventReceived

signalStartEventReceived

signalStartEventReceived

startByMessage

startByMessage

startByMessage

startByMessage

restart

restartById

restartByBusinessKey

reactivate

reactivateById

reactivateByBusinessKey

isRestart

isRestartById

isRestartByBusinessKey

getCountOfActiveTaskById

getCountOfActiveTaskByBusinessKey

remindMail

remindMailById

remindMailByBusinessKey

getCommentsById