com.tencentcloudapi.essbasic.v20210526.models

Class FormField

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.essbasic.v20210526.models.FormField

public class FormField
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
FormField()
FormField(FormField 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
String	getComponentId() Get 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。
String	getComponentName() Get 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。
String	getComponentValue() Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
Boolean	getLockComponentValue() Get 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentId(String ComponentId) Set 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentName(String ComponentName) Set 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentValue(String ComponentValue) Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo
void	setLockComponentValue(Boolean LockComponentValue) Set 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。
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, getMultipartRequestParams, getSkipSign, set, 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

FormField

public FormField()

FormField

public FormField(FormField 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

getComponentValue

public String getComponentValue()

Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo

Returns:

ComponentValue 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo

setComponentValue

public void setComponentValue(String ComponentValue)

Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo

Parameters:

ComponentValue - 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo

getComponentId

public String getComponentId()

Get 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ComponentId 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。

setComponentId

public void setComponentId(String ComponentId)

Set 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ComponentId - 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 注意：此字段可能返回 null，表示取不到有效值。

getComponentName

public String getComponentName()

Get 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ComponentName 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。

setComponentName

public void setComponentName(String ComponentName)

Set 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ComponentName - 控件的名字，跟ComponentId二选一，不能全为空 注意：此字段可能返回 null，表示取不到有效值。

getLockComponentValue

public Boolean getLockComponentValue()

Get 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。

Returns:

LockComponentValue 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。

setLockComponentValue

public void setLockComponentValue(Boolean LockComponentValue)

Set 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

LockComponentValue - 是否锁定模版控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel