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

header, 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 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 null，表示取不到有效值。
String	getComponentName() Get 控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式 注意：此字段可能返回 null，表示取不到有效值。
String	getComponentValue() Get 控件填充值，ComponentType和传入值格式对应关系如下： TEXT - 普通文本控件，需输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串； CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串； FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割； DATE - 日期控件；格式为 xxxx年xx月xx日 字符串； DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；
Boolean	getLockComponentValue() Get 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentId(String ComponentId) Set 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentName(String ComponentName) Set 控件的名字，跟ComponentId二选一，不能全为空 点击此处查看模板上控件名字的获取方式 注意：此字段可能返回 null，表示取不到有效值。
void	setComponentValue(String ComponentValue) Set 控件填充值，ComponentType和传入值格式对应关系如下： TEXT - 普通文本控件，需输入文本字符串； MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串； CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串； FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割； DATE - 日期控件；格式为 xxxx年xx月xx日 字符串； DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；
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, 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

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 控件填充值，ComponentType和传入值格式对应关系如下：

• TEXT - 普通文本控件，需输入文本字符串；
• MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；
• CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；
• FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；
• DYNAMIC_TABLE - 动态表格控件；
• ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；
• DATE - 日期控件；格式为 xxxx年xx月xx日 字符串；
• DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；

Returns:

ComponentValue 控件填充值，ComponentType和传入值格式对应关系如下：

• TEXT - 普通文本控件，需输入文本字符串；
• MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；
• CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；
• FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；
• DYNAMIC_TABLE - 动态表格控件；
• ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；
• DATE - 日期控件；格式为 xxxx年xx月xx日 字符串；
• DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；

setComponentValue

public void setComponentValue(String ComponentValue)

Set 控件填充值，ComponentType和传入值格式对应关系如下：

• TEXT - 普通文本控件，需输入文本字符串；
• MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；
• CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；
• FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；
• DYNAMIC_TABLE - 动态表格控件；
• ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；
• DATE - 日期控件；格式为 xxxx年xx月xx日 字符串；
• DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；

Parameters:

ComponentValue - 控件填充值，ComponentType和传入值格式对应关系如下：

• TEXT - 普通文本控件，需输入文本字符串；
• MULTI_LINE_TEXT - 多行文本控件，需输入文本字符串；
• CHECK_BOX - 勾选框控件，若选中需填写ComponentValue，填写 true或者 false 字符串；
• FILL_IMAGE - 图片控件，需填写ComponentValue为图片的资源 ID；
• DYNAMIC_TABLE - 动态表格控件；
• ATTACHMENT - 附件控件，需填写ComponentValue为附件图片的资源 ID列表，以逗号分割；
• DATE - 日期控件；格式为 xxxx年xx月xx日 字符串；
• DISTRICT - 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容；

getComponentId

public String getComponentId()

Get 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 null，表示取不到有效值。

Returns:

ComponentId 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 null，表示取不到有效值。

setComponentId

public void setComponentId(String ComponentId)

Set 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 null，表示取不到有效值。

Parameters:

ComponentId - 表单域或控件的ID，跟ComponentName二选一，不能全为空； CreateFlowsByTemplates 接口不使用此字段。 点击此处查看模板上控件ID的获取方式 注意：此字段可能返回 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