FlowBrief (tencentcloud-sdk-java 3.1.1355 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.ess.v20201111.models.FlowBrief

public class FlowBrief
extends AbstractModel

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractModel
  header, skipSign

Constructor Summary

Constructors
Constructor and Description
`FlowBrief()`
`FlowBrief(FlowBrief source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getCreatedOn()` Get 合同流程创建时间，格式为Unix标准时间戳（秒）。
`String`	`getCreator()` Get 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
`Long`	`getDeadline()` Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
`String`	`getFlowDescription()` Get 合同流程描述信息。
`String`	`getFlowId()` Get 合同流程ID，为32位字符串。
`String`	`getFlowMessage()` Get 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
`String`	`getFlowName()` Get 合同流程的名称。
`Long`	`getFlowStatus()` Get 合同流程当前的签署状态, 会存在下列的状态值 0 : 未开启流程(合同中不存在填写环节) 1 : 待签署 2 : 部分签署 3 : 已拒签 4 : 已签署 5 : 已过期 6 : 已撤销 7 : 未开启流程(合同中存在填写环节) 8 : 等待填写 9 : 部分填写 10 : 已拒填 21 : 已解除
`String`	`getFlowType()` Get 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
`String`	`getTemplateId()` Get 发起模板时,使用的模板Id
`UserFlowType`	`getUserFlowType()` Get 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
`void`	`setCreatedOn(Long CreatedOn)` Set 合同流程创建时间，格式为Unix标准时间戳（秒）。
`void`	`setCreator(String Creator)` Set 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
`void`	`setDeadline(Long Deadline)` Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
`void`	`setFlowDescription(String FlowDescription)` Set 合同流程描述信息。
`void`	`setFlowId(String FlowId)` Set 合同流程ID，为32位字符串。
`void`	`setFlowMessage(String FlowMessage)` Set 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
`void`	`setFlowName(String FlowName)` Set 合同流程的名称。
`void`	`setFlowStatus(Long FlowStatus)` Set 合同流程当前的签署状态, 会存在下列的状态值 0 : 未开启流程(合同中不存在填写环节) 1 : 待签署 2 : 部分签署 3 : 已拒签 4 : 已签署 5 : 已过期 6 : 已撤销 7 : 未开启流程(合同中存在填写环节) 8 : 等待填写 9 : 部分填写 10 : 已拒填 21 : 已解除
`void`	`setFlowType(String FlowType)` Set 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
`void`	`setTemplateId(String TemplateId)` Set 发起模板时,使用的模板Id
`void`	`setUserFlowType(UserFlowType UserFlowType)` Set 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlowBrief
```
public FlowBrief()
```
  - FlowBrief
```
public FlowBrief(FlowBrief source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getFlowId
```
public String getFlowId()
```
    Get 合同流程ID，为32位字符串。
    
    Returns:
    
    FlowId 合同流程ID，为32位字符串。
  - setFlowId
```
public void setFlowId(String FlowId)
```
    Set 合同流程ID，为32位字符串。
    
    Parameters:
    
    FlowId - 合同流程ID，为32位字符串。
  - getFlowName
```
public String getFlowName()
```
    Get 合同流程的名称。
    
    Returns:
    
    FlowName 合同流程的名称。
  - setFlowName
```
public void setFlowName(String FlowName)
```
    Set 合同流程的名称。
    
    Parameters:
    
    FlowName - 合同流程的名称。
  - getFlowDescription
```
public String getFlowDescription()
```
    Get 合同流程描述信息。
    
    Returns:
    
    FlowDescription 合同流程描述信息。
  - setFlowDescription
```
public void setFlowDescription(String FlowDescription)
```
    Set 合同流程描述信息。
    
    Parameters:
    
    FlowDescription - 合同流程描述信息。
  - getFlowType
```
public String getFlowType()
```
    Get 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
    
    Returns:
    
    FlowType 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
  - setFlowType
```
public void setFlowType(String FlowType)
```
    Set 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
    
    Parameters:
    
    FlowType - 合同流程的类别分类（如销售合同/入职合同等）。该字段将被废弃，不建议使用。请使用 UserFlowType。
  - getFlowStatus
```
public Long getFlowStatus()
```
    Get 合同流程当前的签署状态, 会存在下列的状态值
    - **0** : 未开启流程(合同中不存在填写环节)
    - **1** : 待签署
    - **2** : 部分签署
    - **3** : 已拒签
    - **4** : 已签署
    - **5** : 已过期
    - **6** : 已撤销
    - **7** : 未开启流程(合同中存在填写环节)
    - **8** : 等待填写
    - **9** : 部分填写
    - **10** : 已拒填
    - **21** : 已解除
    Returns:
    FlowStatus 合同流程当前的签署状态, 会存在下列的状态值
    **0** : 未开启流程(合同中不存在填写环节)
    
    **1** : 待签署
    
    **2** : 部分签署
    
    **3** : 已拒签
    
    **4** : 已签署
    
    **5** : 已过期
    
    **6** : 已撤销
    
    **7** : 未开启流程(合同中存在填写环节)
    
    **8** : 等待填写
    
    **9** : 部分填写
    
    **10** : 已拒填
    
    **21** : 已解除
  - setFlowStatus
```
public void setFlowStatus(Long FlowStatus)
```
    Set 合同流程当前的签署状态, 会存在下列的状态值
    - **0** : 未开启流程(合同中不存在填写环节)
    - **1** : 待签署
    - **2** : 部分签署
    - **3** : 已拒签
    - **4** : 已签署
    - **5** : 已过期
    - **6** : 已撤销
    - **7** : 未开启流程(合同中存在填写环节)
    - **8** : 等待填写
    - **9** : 部分填写
    - **10** : 已拒填
    - **21** : 已解除
    Parameters:
    FlowStatus - 合同流程当前的签署状态, 会存在下列的状态值
    **0** : 未开启流程(合同中不存在填写环节)
    
    **1** : 待签署
    
    **2** : 部分签署
    
    **3** : 已拒签
    
    **4** : 已签署
    
    **5** : 已过期
    
    **6** : 已撤销
    
    **7** : 未开启流程(合同中存在填写环节)
    
    **8** : 等待填写
    
    **9** : 部分填写
    
    **10** : 已拒填
    
    **21** : 已解除
  - getCreatedOn
```
public Long getCreatedOn()
```
    Get 合同流程创建时间，格式为Unix标准时间戳（秒）。
    
    Returns:
    
    CreatedOn 合同流程创建时间，格式为Unix标准时间戳（秒）。
  - setCreatedOn
```
public void setCreatedOn(Long CreatedOn)
```
    Set 合同流程创建时间，格式为Unix标准时间戳（秒）。
    
    Parameters:
    
    CreatedOn - 合同流程创建时间，格式为Unix标准时间戳（秒）。
  - getFlowMessage
```
public String getFlowMessage()
```
    Get 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
    
    Returns:
    
    FlowMessage 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
  - setFlowMessage
```
public void setFlowMessage(String FlowMessage)
```
    Set 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
    
    Parameters:
    
    FlowMessage - 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
  - getCreator
```
public String getCreator()
```
    Get 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
    
    Returns:
    
    Creator 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
  - setCreator
```
public void setCreator(String Creator)
```
    Set 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
    
    Parameters:
    
    Creator - 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
  - getDeadline
```
public Long getDeadline()
```
    Get 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
    
    Returns:
    
    Deadline 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
  - setDeadline
```
public void setDeadline(Long Deadline)
```
    Set 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
    
    Parameters:
    
    Deadline - 合同流程的签署截止时间，格式为Unix标准时间戳（秒）。
  - getUserFlowType
```
public UserFlowType getUserFlowType()
```
    Get 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
    
    Returns:
    
    UserFlowType 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
  - setUserFlowType
```
public void setUserFlowType(UserFlowType UserFlowType)
```
    Set 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
    
    Parameters:
    
    UserFlowType - 用户合同的自定义分类。自定义合同类型的位置，在下图所示地方: ![image](https://qcloudimg.tencent-cloud.cn/raw/00d72934c31bd49115a566e4e1a4530d.png)
  - getTemplateId
```
public String getTemplateId()
```
    Get 发起模板时,使用的模板Id
    
    Returns:
    
    TemplateId 发起模板时,使用的模板Id
  - setTemplateId
```
public void setTemplateId(String TemplateId)
```
    Set 发起模板时,使用的模板Id
    
    Parameters:
    
    TemplateId - 发起模板时,使用的模板Id
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel
    
    Parameters:
    
    map - The map to populate with the model's parameters.
    
    prefix - A string prefix for the keys.

Class FlowBrief

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

FlowBrief

FlowBrief

Method Detail

getFlowId

setFlowId

getFlowName

setFlowName

getFlowDescription

setFlowDescription

getFlowType

setFlowType

getFlowStatus

setFlowStatus

getCreatedOn

setCreatedOn

getFlowMessage

setFlowMessage

getCreator

setCreator

getDeadline

setDeadline

getUserFlowType

setUserFlowType

getTemplateId

setTemplateId

toMap