FormInstance (sjtu-infoplus-atk 1.1-SNAPSHOT API)

java.lang.Object
- edu.sjtu.infoplus.applicationToolkit.model.FormInstance

public class FormInstance
extends Object

构造器概要

构造器
构造器和说明

FormInstance()

构造器
构造器和说明
`FormInstance()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`String`	`getBusinessId()`
`long`	`getCreateTime()` 获取流程实例创建时间，Unix时间戳（秒）。
`InfoPlusUser`	`getCreator()` 获取流程实例创建人。
`long`	`getEntryId()` 获取流程实例流水号。
`Long`	`getEntryIdTop()` 获取主流程实例流水号。
`String`	`getInstanceId()` 获取流程实例guid。
`String`	`getInstanceName()` 获取流程实例名称。
`long`	`getLastUpdate()` 获取流程实例最后更新时间，Unix时间戳（秒）。
`InfoPlusUser`	`getNextUser()` 获取流程实例的首步骤执行人。
`InfoPlusUser`	`getOwner()` 已过时。应使用 `getNextUser()`
`int`	`getState()` 获取流程实例状态。
`String`	`getToken()` 获取流程实例viewToken。
`void`	`setBusinessId(String businessId)`
`void`	`setCreateTime(long createTime)`
`void`	`setCreator(InfoPlusUser creator)`
`void`	`setEntryId(long entryId)`
`void`	`setEntryIdTop(Long entryIdTop)`
`void`	`setInstanceId(String instanceId)`
`void`	`setInstanceName(String instanceName)`
`void`	`setLastUpdate(long lastUpdate)`
`void`	`setNextUser(InfoPlusUser nextUser)`
`void`	`setOwner(InfoPlusUser owner)` 已过时。
`void`	`setState(int state)`
`void`	`setToken(String token)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - FormInstance
```
public FormInstance()
```
- 方法详细资料
  - getInstanceId
```
public String getInstanceId()
```
    获取流程实例guid。
    流程实例guid和流程流水号都是流程实例的唯一标识。流水号是更为常用的标识。
    
    返回:
    
    流程实例guid
    
    另请参阅:
    
    getEntryId()
  - setInstanceId
```
public void setInstanceId(String instanceId)
```
  - getInstanceName
```
public String getInstanceName()
```
    获取流程实例名称。
    
    返回:
    
    流程实例名称
  - setInstanceName
```
public void setInstanceName(String instanceName)
```
  - getBusinessId
```
public String getBusinessId()
```
  - setBusinessId
```
public void setBusinessId(String businessId)
```
  - getEntryId
```
public long getEntryId()
```
    获取流程实例流水号。
    流程实例guid和流程流水号都是流程实例的唯一标识。流水号是更为常用的标识。
    
    返回:
    
    流程实例流水号
  - setEntryId
```
public void setEntryId(long entryId)
```
  - getEntryIdTop
```
public Long getEntryIdTop()
```
    获取主流程实例流水号。
    
    返回:
    
    主流程实例流水号
  - setEntryIdTop
```
public void setEntryIdTop(Long entryIdTop)
```
  - getCreator
```
public InfoPlusUser getCreator()
```
    获取流程实例创建人。
    
    返回:
    
    流程实例创建人
  - setCreator
```
public void setCreator(InfoPlusUser creator)
```
  - getOwner
```
@Deprecated
public InfoPlusUser getOwner()
```
    已过时。应使用 getNextUser()
    
    获取流程实例的首步骤执行人。
    
    返回:
    
    流程实例的首步骤执行人
  - setOwner
```
@Deprecated
public void setOwner(InfoPlusUser owner)
```
    已过时。
  - getNextUser
```
public InfoPlusUser getNextUser()
```
    获取流程实例的首步骤执行人。
    一般情况下流程的创建人和首步执行人相同，但是在API发起的情况下，两者可能不同。
    
    返回:
    
    流程实例的首步骤执行人
  - setNextUser
```
public void setNextUser(InfoPlusUser nextUser)
```
  - getCreateTime
```
public long getCreateTime()
```
    获取流程实例创建时间，Unix时间戳（秒）。
    
    返回:
    
    流程实例创建时间，Unix时间戳（秒）
  - setCreateTime
```
public void setCreateTime(long createTime)
```
  - getLastUpdate
```
public long getLastUpdate()
```
    获取流程实例最后更新时间，Unix时间戳（秒）。
    
    返回:
    
    流程实例最后更新时间，Unix时间戳（秒）
  - setLastUpdate
```
public void setLastUpdate(long lastUpdate)
```
  - getState
```
public int getState()
```
    获取流程实例状态。
    1：进行中、2：挂起、3：已终止、4：已完成
    
    返回:
    
    流程实例状态
  - setState
```
public void setState(int state)
```
  - getToken
```
public String getToken()
```
    获取流程实例viewToken。
    viewToken能够用来构造表单的免登录渲染页面、打印页面或者导出，业务系统可以用来构造脱离流程平台权限控制的表单展示页面。 viewToken每个流程实例不同，在流程发起时由流程平台随机产生，建议业务系统通过Messenger在其自身数据库中记录保存。
    免登录访问页面举例
    永久有效地址：
    渲染页：http(s)://{host}/{context}/form/{流程实例id}/render/{viewToken}
    打印页：http(s)://{host}/{context}/form/{流程实例id}/print/{viewToken}
    导出：http(s)://{host}/{context}/form/{流程实例id}/{viewToken}/export.{format}
    
    指定时间内有效的地址：
    渲染页：http(s)://{host}/{context}/form/{流程实例id}/render/{hash}?expire={timestamp}
    打印页：http(s)://{host}/{context}/form/{流程实例id}/print/{hash}?expire={timestamp}
    导出：http(s)://{host}/{context}/form/{流程实例id}/{hash}/export.{format}?expire={timestamp}
    
    以上地址中：
    host为流程平台访问域名，如form.sjtu.edu.cn；
    context为部署路径，如infoplus；
    流程实例id支持两种方式: e{流水号}（参考 getEntryId()）或GUID形式的流程实例id（参考 getInstanceId()）；
    timestamp为地址有效期结束时间，以秒为单位的unix时间戳；
    hash为md5(流程实例id|viewToken|timestamp)；
    
    返回:
    
    流程实例viewToken
  - setToken
```
public void setToken(String token)
```

类 FormInstance

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

FormInstance

方法详细资料

getInstanceId

setInstanceId

getInstanceName

setInstanceName

getBusinessId

setBusinessId

getEntryId

setEntryId

getEntryIdTop

setEntryIdTop

getCreator

setCreator

getOwner

setOwner

getNextUser

setNextUser

getCreateTime

setCreateTime

getLastUpdate

setLastUpdate

getState

setState

getToken

setToken