com.tencentcloudapi.ess.v20201111.models

Class FlowDetailInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.FlowDetailInfo

public class FlowDetailInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
FlowDetailInfo()
FlowDetailInfo(FlowDetailInfo 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

Modifier and Type	Method and Description
FlowApproverDetail[]	getCcInfos() Get 合同流程的关注方信息数组
Long	getCreatedOn() Get 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
String	getCreator() Get 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
FlowApproverDetail[]	getFlowApproverInfos() Get 合同流程的签署方数组
String	getFlowDescription() Get 合同流程描述信息。
String	getFlowId() Get 合同流程ID，为32位字符串。
String	getFlowMessage() Get 当合同流程状态为已拒签（即 FlowStatus=3）或已撤销（即 FlowStatus=6）时，此字段 FlowMessage 为拒签或撤销原因。
String	getFlowName() Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
Long	getFlowStatus() Get 合同流程当前的签署状态, 会存在下列的状态值 **0** : 未开启流程(合同中不存在填写环节) **1** : 待签署 **2** : 部分签署 **3** : 已拒签 **4** : 已签署 **5** : 已过期 **6** : 已撤销 **7** : 未开启流程(合同中存在填写环节) **8** : 等待填写 **9** : 部分填写 **10** : 已拒填 **16** : 已失效（可能因为参与方修改姓名等原因） **21** : 已解除
String	getFlowType() Get 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。
String	getTemplateId() Get 发起模板时,使用的模板Id
UserFlowType	getUserFlowType() Get 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 
void	setCcInfos(FlowApproverDetail[] CcInfos) Set 合同流程的关注方信息数组
void	setCreatedOn(Long CreatedOn) Set 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。
void	setCreator(String Creator) Set 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
void	setFlowApproverInfos(FlowApproverDetail[] FlowApproverInfos) Set 合同流程的签署方数组
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 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
void	setFlowStatus(Long FlowStatus) Set 合同流程当前的签署状态, 会存在下列的状态值 **0** : 未开启流程(合同中不存在填写环节) **1** : 待签署 **2** : 部分签署 **3** : 已拒签 **4** : 已签署 **5** : 已过期 **6** : 已撤销 **7** : 未开启流程(合同中存在填写环节) **8** : 等待填写 **9** : 部分填写 **10** : 已拒填 **16** : 已失效（可能因为参与方修改姓名等原因） **21** : 已解除
void	setFlowType(String FlowType) Set 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。
void	setTemplateId(String TemplateId) Set 发起模板时,使用的模板Id
void	setUserFlowType(UserFlowType UserFlowType) Set 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 
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

FlowDetailInfo

public FlowDetailInfo()

FlowDetailInfo

public FlowDetailInfo(FlowDetailInfo 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 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

Returns:

FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

setFlowName

public void setFlowName(String FlowName)

Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

Parameters:

FlowName - 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。

getFlowType

public String getFlowType()

Get 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。

Returns:

FlowType 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。

setFlowType

public void setFlowType(String FlowType)

Set 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。

Parameters:

FlowType - 合同流程的类别分类（如销售合同/入职合同等）。 该字段将被废弃，不建议使用。

getFlowStatus

public Long getFlowStatus()

Get 合同流程当前的签署状态, 会存在下列的状态值

• **0** : 未开启流程(合同中不存在填写环节)
• **1** : 待签署
• **2** : 部分签署
• **3** : 已拒签
• **4** : 已签署
• **5** : 已过期
• **6** : 已撤销
• **7** : 未开启流程(合同中存在填写环节)
• **8** : 等待填写
• **9** : 部分填写
• **10** : 已拒填
• **16** : 已失效（可能因为参与方修改姓名等原因）
• **21** : 已解除

Returns:

FlowStatus 合同流程当前的签署状态, 会存在下列的状态值

• **0** : 未开启流程(合同中不存在填写环节)
• **1** : 待签署
• **2** : 部分签署
• **3** : 已拒签
• **4** : 已签署
• **5** : 已过期
• **6** : 已撤销
• **7** : 未开启流程(合同中存在填写环节)
• **8** : 等待填写
• **9** : 部分填写
• **10** : 已拒填
• **16** : 已失效（可能因为参与方修改姓名等原因）
• **21** : 已解除

setFlowStatus

public void setFlowStatus(Long FlowStatus)

Set 合同流程当前的签署状态, 会存在下列的状态值

• **0** : 未开启流程(合同中不存在填写环节)
• **1** : 待签署
• **2** : 部分签署
• **3** : 已拒签
• **4** : 已签署
• **5** : 已过期
• **6** : 已撤销
• **7** : 未开启流程(合同中存在填写环节)
• **8** : 等待填写
• **9** : 部分填写
• **10** : 已拒填
• **16** : 已失效（可能因为参与方修改姓名等原因）
• **21** : 已解除

Parameters:

FlowStatus - 合同流程当前的签署状态, 会存在下列的状态值

• **0** : 未开启流程(合同中不存在填写环节)
• **1** : 待签署
• **2** : 部分签署
• **3** : 已拒签
• **4** : 已签署
• **5** : 已过期
• **6** : 已撤销
• **7** : 未开启流程(合同中存在填写环节)
• **8** : 等待填写
• **9** : 部分填写
• **10** : 已拒填
• **16** : 已失效（可能因为参与方修改姓名等原因）
• **21** : 已解除

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 为拒签或撤销原因。

getFlowDescription

public String getFlowDescription()

Get 合同流程描述信息。

Returns:

FlowDescription 合同流程描述信息。

setFlowDescription

public void setFlowDescription(String FlowDescription)

Set 合同流程描述信息。

Parameters:

FlowDescription - 合同流程描述信息。

getCreatedOn

public Long getCreatedOn()

Get 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。

Returns:

CreatedOn 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。

setCreatedOn

public void setCreatedOn(Long CreatedOn)

Set 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。

Parameters:

CreatedOn - 合同流程的创建时间戳，格式为Unix标准时间戳（秒）。

getFlowApproverInfos

public FlowApproverDetail[] getFlowApproverInfos()

Get 合同流程的签署方数组

Returns:

FlowApproverInfos 合同流程的签署方数组

setFlowApproverInfos

public void setFlowApproverInfos(FlowApproverDetail[] FlowApproverInfos)

Set 合同流程的签署方数组

Parameters:

FlowApproverInfos - 合同流程的签署方数组

getCcInfos

public FlowApproverDetail[] getCcInfos()

Get 合同流程的关注方信息数组

Returns:

CcInfos 合同流程的关注方信息数组

setCcInfos

public void setCcInfos(FlowApproverDetail[] CcInfos)

Set 合同流程的关注方信息数组

Parameters:

CcInfos - 合同流程的关注方信息数组

getCreator

public String getCreator()

Get 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。

Returns:

Creator 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。

setCreator

public void setCreator(String Creator)

Set 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。

Parameters:

Creator - 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。

getUserFlowType

public UserFlowType getUserFlowType()

Get 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 

Returns:

UserFlowType 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 

setUserFlowType

public void setUserFlowType(UserFlowType UserFlowType)

Set 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 

Parameters:

UserFlowType - 用户合同的自定义分类。 自定义合同类型的位置，在下图所示地方: 

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.