ProcessInstance (Java SDK API Reference for AWS PaaS)

```
public interface ProcessInstance
```
流程实例对象

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`java.lang.String`	`getAppId()` 应用Id
`java.lang.String`	`getControlState()` 流程实例控制状态，参见ProcessRuntimeConst
`java.sql.Timestamp`	`getCreateTime()` 创建时间
`java.lang.String`	`getCreateUser()` 创建人账户
`java.lang.String`	`getCreateUserDeptId()` 创建人的部门Id
`java.lang.String`	`getCreateUserLocation()` 创建人身份信息，仅用于历史审计
`java.lang.String`	`getCreateUserOrgId()` 流程创建人单位Id
`java.lang.String`	`getCreateUserRoleId()` 创建人角色Id
`java.lang.String`	`getEndActivityId()` 流程结束在哪个节点
`java.sql.Timestamp`	`getEndTime()` 流程结束时间
`long`	`getExecuteCostTime()` 流程从创建到结束的执行时间
`long`	`getExecuteExpireTime()` 流程从创建到结束的逾期时间，该值与流程模型设置的KPI有关
`java.lang.String`	`getExt1()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getExt2()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getExt3()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getExt4()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getExt5()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getExt6()` 扩展属性，可供开发人员自行使用。
`long`	`getExt7()` 扩展属性，可供开发人员自行使用。
`double`	`getExt8()` 扩展属性，可供开发人员自行使用。
`java.lang.String`	`getId()` 流程实例Id
`java.lang.String`	`getIOBD()` 业务域ID，该实例属于某类业务域，如电信的OSS、BSS、MSS。
`java.lang.String`	`getIOC()` 自定义ID，这是一个开放的自定义项，可根据管理需要定义规则名称和规则项。
`java.lang.String`	`getIOR()` 组织区域ID，该实例属于某组织区域的业务数据，如中国大陆、东南亚、北美。
`java.lang.String`	`getIOS()` 系统ID，该实例属于某类系统依赖的流程，如营销系统、生产系统、OA系统。
`java.lang.String`	`getParentProcessInstId()` 父流程实例Id
`java.lang.String`	`getParentTaskInstId()` 父流程创建该子流程的任务实例Id，如该任务节点类型是一个CallActivity
`java.lang.String`	`getProcessBusinessKey()` 外部业务系统主键，注意该值应保持全局实例的唯一，如果不给定系统将默认一个36位长度的uuid
`java.lang.String`	`getProcessDefId()` 流程定义Id
`java.lang.String`	`getProcessDefVerId()` 流程主版本定义Id
`java.lang.String`	`getProcessGroupId()` 流程组Id，一个流程组可以包含多个流程主版本
`java.lang.String`	`getProcessProfileId()` 如果是子流程，控制该流程实例行为的策略定义Id
`java.lang.String`	`getRemark()` 备注信息
`int`	`getRemindTimes()` 流程被催办的次数，来自该实例产生任务发生催办次数的合计
`int`	`getSecurityLayer()` 流程数据的密级等级
`java.lang.String`	`getStartActivityId()` 流程启动时产生首个任务的节点定义Id
`java.lang.String`	`getStartTaskInstId()` 流程启动时首个任务实例Id
`java.sql.Timestamp`	`getStartTime()` 启动时间
`int`	`getSubInstType()` 子流程实例类型，当前无用
`java.lang.String`	`getTitle()` 标题
`boolean`	`isAsync()` 是否异步执行
`boolean`	`isEnd()` 是否已结束
`boolean`	`isException()` 是否发生过异常，如果该实例在执行过程中有系统异常或声明的BPMNException被抛出，被标记为true
`boolean`	`isExistSubProcess()` 该实例是否存在子流程
`boolean`	`isOvertime()` 是否逾期，如果该实例在执行过程中流程或节点耗时超过KPI定义的范围，被标记为true
`boolean`	`isProcess()` 是否流程类控制数据
`boolean`	`isStart()` 是否已启动
`boolean`	`isSubProcess()` 是否子流程
`boolean`	`isTrash()` 是否垃圾数据状态

- 方法详细资料
  - getId
```
java.lang.String getId()
```
    流程实例Id
    
    返回:
    
    一个36位长度的Id
  - getAppId
```
java.lang.String getAppId()
```
    应用Id
    
    返回:
    
    一个36位长度的Id
  - getProcessBusinessKey
```
java.lang.String getProcessBusinessKey()
```
    外部业务系统主键，注意该值应保持全局实例的唯一，如果不给定系统将默认一个36位长度的uuid
    
    返回:
    
    外部系统主键值
  - getProcessDefId
```
java.lang.String getProcessDefId()
```
    流程定义Id
    
    返回:
    
    一个36位长度的Id
  - getProcessDefVerId
```
java.lang.String getProcessDefVerId()
```
    流程主版本定义Id
    
    返回:
    
    一个36位长度的Id
  - getProcessGroupId
```
java.lang.String getProcessGroupId()
```
    流程组Id，一个流程组可以包含多个流程主版本
    
    返回:
    
    一个36位长度的Id
  - getStartTime
```
java.sql.Timestamp getStartTime()
```
    启动时间
    
    返回:
    
    如果未启动，返回null
  - getTitle
```
java.lang.String getTitle()
```
    标题
    
    返回:
    
    实例标题名
  - isProcess
```
boolean isProcess()
```
    是否流程类控制数据
    
    返回:
    
    如果返回fales表示仅存储的控制记录
  - isSubProcess
```
boolean isSubProcess()
```
    是否子流程
  - isExistSubProcess
```
boolean isExistSubProcess()
```
    该实例是否存在子流程
  - getSubInstType
```
int getSubInstType()
```
    子流程实例类型，当前无用
  - getCreateUser
```
java.lang.String getCreateUser()
```
    创建人账户
    
    返回:
    
    如果该流程实例为非人工流程，返回空串
  - getCreateUserLocation
```
java.lang.String getCreateUserLocation()
```
    创建人身份信息，仅用于历史审计
    
    返回:
    
    如果该流程实例为非人工流程，返回空串
  - getCreateUserOrgId
```
java.lang.String getCreateUserOrgId()
```
    流程创建人单位Id
    
    返回:
    
    如果该流程实例为非人工流程，返回空串
  - getCreateUserDeptId
```
java.lang.String getCreateUserDeptId()
```
    创建人的部门Id
    
    返回:
    
    如果该流程实例为非人工流程，返回空串
  - getCreateUserRoleId
```
java.lang.String getCreateUserRoleId()
```
    创建人角色Id
    
    返回:
    
    如果该流程实例为非人工流程，返回空串
  - getCreateTime
```
java.sql.Timestamp getCreateTime()
```
    创建时间
  - getStartTaskInstId
```
java.lang.String getStartTaskInstId()
```
    流程启动时首个任务实例Id
    
    返回:
    
    一个36位长度的Id
  - getStartActivityId
```
java.lang.String getStartActivityId()
```
    流程启动时产生首个任务的节点定义Id
    
    返回:
    
    一个36位长度的Id
  - getParentProcessInstId
```
java.lang.String getParentProcessInstId()
```
    父流程实例Id
    
    返回:
    
    如果是一个独立的流程实例或根流程实例，返回空串
  - getParentTaskInstId
```
java.lang.String getParentTaskInstId()
```
    父流程创建该子流程的任务实例Id，如该任务节点类型是一个CallActivity
    
    返回:
    
    如果是一个独立的流程实例或根流程实例，返回空串
  - getExecuteCostTime
```
long getExecuteCostTime()
```
    流程从创建到结束的执行时间
    
    返回:
    
    单位毫秒
  - getExecuteExpireTime
```
long getExecuteExpireTime()
```
    流程从创建到结束的逾期时间，该值与流程模型设置的KPI有关
    
    返回:
    
    单位毫秒
  - getControlState
```
java.lang.String getControlState()
```
    流程实例控制状态，参见ProcessRuntimeConst
    
    返回:
    
    当前流程实例的控制状态值
    
    另请参阅:
    
    ProcessRuntimeConst
  - getEndTime
```
java.sql.Timestamp getEndTime()
```
    流程结束时间
    
    返回:
    
    如果未结束，返回null
  - getEndActivityId
```
java.lang.String getEndActivityId()
```
    流程结束在哪个节点
    
    返回:
    
    节点定义Id，如果流程未结束返回空串
  - isStart
```
boolean isStart()
```
    是否已启动
  - isEnd
```
boolean isEnd()
```
    是否已结束
  - isAsync
```
boolean isAsync()
```
    是否异步执行
    
    返回:
    
    异步执行返回true
  - getProcessProfileId
```
java.lang.String getProcessProfileId()
```
    如果是子流程，控制该流程实例行为的策略定义Id
    
    返回:
    
    一个36位长度的Id
  - getRemark
```
java.lang.String getRemark()
```
    备注信息
  - getSecurityLayer
```
int getSecurityLayer()
```
    流程数据的密级等级
    
    返回:
    
    0-普通；1-秘密；2-机密
    
    另请参阅:
    
    SecurityLevelConst
  - isException
```
boolean isException()
```
    是否发生过异常，如果该实例在执行过程中有系统异常或声明的BPMNException被抛出，被标记为true
  - isOvertime
```
boolean isOvertime()
```
    是否逾期，如果该实例在执行过程中流程或节点耗时超过KPI定义的范围，被标记为true
  - getIOBD
```
java.lang.String getIOBD()
```
    业务域ID，该实例属于某类业务域，如电信的OSS、BSS、MSS。当平台启用“实例高级分类管理”平台附加工具时，该选项可用
    
    返回:
    
    对应高级分类管理规则中的key值，一个36位的串
  - getIOR
```
java.lang.String getIOR()
```
    组织区域ID，该实例属于某组织区域的业务数据，如中国大陆、东南亚、北美。当平台启用“实例高级分类管理”平台附加工具时，该选项可用
    
    返回:
    
    对应高级分类管理规则中的key值，一个36位的串
  - getIOS
```
java.lang.String getIOS()
```
    系统ID，该实例属于某类系统依赖的流程，如营销系统、生产系统、OA系统。当平台启用“实例高级分类管理”平台附加工具时，该选项可用
    
    返回:
    
    对应高级分类管理规则中的key值，一个36位的串
  - getIOC
```
java.lang.String getIOC()
```
    自定义ID，这是一个开放的自定义项，可根据管理需要定义规则名称和规则项。当平台启用“实例高级分类管理”平台附加工具时，该选项可用
    
    返回:
    
    对应高级分类管理规则中的key值，一个36位的串
  - getExt1
```
java.lang.String getExt1()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过64个字符串长度
    
    返回:
    
    扩展值
  - getExt2
```
java.lang.String getExt2()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过128个字符串长度
    
    返回:
    
    扩展值
  - getExt3
```
java.lang.String getExt3()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过255个字符串长度
    
    返回:
    
    扩展值
  - getExt4
```
java.lang.String getExt4()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过255个字符串长度
    
    返回:
    
    扩展值
  - getExt5
```
java.lang.String getExt5()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过128个字符串长度
    
    返回:
    
    扩展值
  - getExt6
```
java.lang.String getExt6()
```
    扩展属性，可供开发人员自行使用。注意，双字节为1个长度，总不超过128个字符串长度
    
    返回:
    
    扩展值
  - getExt7
```
long getExt7()
```
    扩展属性，可供开发人员自行使用。注意，最大长度12位的数值
    
    返回:
    
    扩展值
  - getExt8
```
double getExt8()
```
    扩展属性，可供开发人员自行使用。注意，最大长度14位的双精度（含2位小数）
    
    返回:
    
    扩展值
  - getRemindTimes
```
int getRemindTimes()
```
    流程被催办的次数，来自该实例产生任务发生催办次数的合计
  - isTrash
```
boolean isTrash()
```
    是否垃圾数据状态

接口 ProcessInstance

方法概要

方法详细资料

getId

getAppId

getProcessBusinessKey

getProcessDefId

getProcessDefVerId

getProcessGroupId

getStartTime

getTitle

isProcess

isSubProcess

isExistSubProcess

getSubInstType

getCreateUser

getCreateUserLocation

getCreateUserOrgId

getCreateUserDeptId

getCreateUserRoleId

getCreateTime

getStartTaskInstId

getStartActivityId

getParentProcessInstId

getParentTaskInstId

getExecuteCostTime

getExecuteExpireTime

getControlState

getEndTime

getEndActivityId

isStart

isEnd

isAsync

getProcessProfileId

getRemark

getSecurityLayer

isException

isOvertime

getIOBD

getIOR

getIOS

getIOC

getExt1

getExt2

getExt3

getExt4

getExt5

getExt6

getExt7

getExt8

getRemindTimes

isTrash