com.tencentcloudapi.essbasic.v20210526.models.FormField Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Show all versions of tencentcloud-sdk-java-essbasic Show documentation
Tencent Cloud Open API SDK for Java
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.essbasic.v20210526.models;
import com.tencentcloudapi.common.AbstractModel;
import com.tencentcloudapi.common.SSEResponseModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class FormField extends AbstractModel {
/**
* 控件填充值，ComponentType和传入值格式对应关系如下：
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)
- DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
- DISTRICT : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容
控件值约束说明：
特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串
*/
@SerializedName("ComponentValue")
@Expose
private String ComponentValue;
/**
* 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
点击此处查看模板上控件ID的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
@SerializedName("ComponentId")
@Expose
private String ComponentId;
/**
* 控件的名字，跟ComponentId二选一，不能全为空
点击此处查看模板上控件名字的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
@SerializedName("ComponentName")
@Expose
private String ComponentName;
/**
* 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
注意：此字段可能返回 null，表示取不到有效值。
*/
@SerializedName("LockComponentValue")
@Expose
private Boolean LockComponentValue;
/**
* Get 控件填充值，ComponentType和传入值格式对应关系如下：
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)
- DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
- DISTRICT : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容
控件值约束说明：
特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串
* @return ComponentValue 控件填充值，ComponentType和传入值格式对应关系如下：
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)
- DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
- DISTRICT : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容
控件值约束说明：
特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串
*/
public String getComponentValue() {
return this.ComponentValue;
}
/**
* Set 控件填充值，ComponentType和传入值格式对应关系如下：
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)
- DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
- DISTRICT : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容
控件值约束说明：
特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串
* @param ComponentValue 控件填充值，ComponentType和传入值格式对应关系如下：
- TEXT : 文本内容
- MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
- CHECK_BOX : true/false
- FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
- SELECTOR : 选项值
- DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：[数据表格](https://qian.tencent.com/developers/partner/dynamic_table)
- DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
- DISTRICT : 省市区行政区控件，需填写ComponentValue为省市区行政区字符串内容
控件值约束说明：
特殊控件 填写约束 企业全称控件 企业名称中文字符中文括号 统一社会信用代码控件 企业注册的统一社会信用代码 法人名称控件 最大50个字符，2到25个汉字或者1到50个字母 签署意见控件 签署意见最大长度为50字符 签署人手机号控件 国内手机号 13,14,15,16,17,18,19号段长度11位 签署人身份证控件 合法的身份证号码检查 控件名称 控件名称最大长度为20字符，不支持表情 单行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 多行文本控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 勾选框控件 选择填字符串true，不选填字符串false 选择器控件 同单行文本控件约束，填写选择值中的字符串 数字控件 请输入有效的数字(可带小数点) 日期控件 格式：yyyy年mm月dd日 附件控件 JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID 图片控件 JPG或PNG图片，填写上传的图片资源ID 邮箱控件 有效的邮箱地址, w3c标准 地址控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 省市区控件 只允许输入中文，英文，数字，中英文标点符号，不支持表情 性别控件 选择值中的字符串 学历控件 选择值中的字符串
*/
public void setComponentValue(String ComponentValue) {
this.ComponentValue = ComponentValue;
}
/**
* Get 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
点击此处查看模板上控件ID的获取方式
注意：此字段可能返回 null，表示取不到有效值。
* @return ComponentId 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
点击此处查看模板上控件ID的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
public String getComponentId() {
return this.ComponentId;
}
/**
* Set 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
点击此处查看模板上控件ID的获取方式
注意：此字段可能返回 null，表示取不到有效值。
* @param ComponentId 表单域或控件的ID，跟ComponentName二选一，不能全为空；
CreateFlowsByTemplates 接口不使用此字段。
点击此处查看模板上控件ID的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
public void setComponentId(String ComponentId) {
this.ComponentId = ComponentId;
}
/**
* Get 控件的名字，跟ComponentId二选一，不能全为空
点击此处查看模板上控件名字的获取方式
注意：此字段可能返回 null，表示取不到有效值。
* @return ComponentName 控件的名字，跟ComponentId二选一，不能全为空
点击此处查看模板上控件名字的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
public String getComponentName() {
return this.ComponentName;
}
/**
* Set 控件的名字，跟ComponentId二选一，不能全为空
点击此处查看模板上控件名字的获取方式
注意：此字段可能返回 null，表示取不到有效值。
* @param ComponentName 控件的名字，跟ComponentId二选一，不能全为空
点击此处查看模板上控件名字的获取方式
注意：此字段可能返回 null，表示取不到有效值。
*/
public void setComponentName(String ComponentName) {
this.ComponentName = ComponentName;
}
/**
* Get 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
注意：此字段可能返回 null，表示取不到有效值。
* @return LockComponentValue 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
注意：此字段可能返回 null，表示取不到有效值。
*/
public Boolean getLockComponentValue() {
return this.LockComponentValue;
}
/**
* Set 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
注意：此字段可能返回 null，表示取不到有效值。
* @param LockComponentValue 是否锁定模板控件值，锁定后无法修改（用于嵌入式发起合同），true-锁定，false-不锁定
注意：此字段可能返回 null，表示取不到有效值。
*/
public void setLockComponentValue(Boolean LockComponentValue) {
this.LockComponentValue = LockComponentValue;
}
public FormField() {
}
/**
* 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.
*/
public FormField(FormField source) {
if (source.ComponentValue != null) {
this.ComponentValue = new String(source.ComponentValue);
}
if (source.ComponentId != null) {
this.ComponentId = new String(source.ComponentId);
}
if (source.ComponentName != null) {
this.ComponentName = new String(source.ComponentName);
}
if (source.LockComponentValue != null) {
this.LockComponentValue = new Boolean(source.LockComponentValue);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "ComponentValue", this.ComponentValue);
this.setParamSimple(map, prefix + "ComponentId", this.ComponentId);
this.setParamSimple(map, prefix + "ComponentName", this.ComponentName);
this.setParamSimple(map, prefix + "LockComponentValue", this.LockComponentValue);
}
}