com.tencentcloudapi.ess.v20201111.models.FlowGroupInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tencentcloud-sdk-java-ess Show documentation
Show all versions of tencentcloud-sdk-java-ess 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.ess.v20201111.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 FlowGroupInfo extends AbstractModel {
/**
* 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
*/
@SerializedName("Approvers")
@Expose
private ApproverInfo [] Approvers;
/**
* 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
*/
@SerializedName("FileIds")
@Expose
private String [] FileIds;
/**
* 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
@SerializedName("TemplateId")
@Expose
private String TemplateId;
/**
* 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 签署流程描述,最大长度1000个字符
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 合同（流程）的回调地址
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
@SerializedName("UserData")
@Expose
private String UserData;
/**
* 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
*/
@SerializedName("Unordered")
@Expose
private Boolean Unordered;
/**
* 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
*/
@SerializedName("Components")
@Expose
private Component [] Components;
/**
* 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
*/
@SerializedName("AutoSignScene")
@Expose
private String AutoSignScene;
/**
* 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
@SerializedName("FlowDisplayType")
@Expose
private Long FlowDisplayType;
/**
* Get 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
* @return FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
public String getFlowName() {
return this.FlowName;
}
/**
* Set 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
* @param FlowName 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
该名称还将用于合同签署完成后的下载文件名。
*/
public void setFlowName(String FlowName) {
this.FlowName = FlowName;
}
/**
* Get 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
* @return Approvers 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
*/
public ApproverInfo [] getApprovers() {
return this.Approvers;
}
/**
* Set 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
* @param Approvers 签署流程参与者信息，最大限制50方
注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
*/
public void setApprovers(ApproverInfo [] Approvers) {
this.Approvers = Approvers;
}
/**
* Get 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
* @return FileIds 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
*/
public String [] getFileIds() {
return this.FileIds;
}
/**
* Set 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
* @param FileIds 文件资源ID，通过多文件上传[UploadFiles](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口获得，为32位字符串。
建议开发者保存此资源ID，后续创建合同或创建合同流程需此资源ID。
*/
public void setFileIds(String [] FileIds) {
this.FileIds = FileIds;
}
/**
* Get 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
* @return TemplateId 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
public String getTemplateId() {
return this.TemplateId;
}
/**
* Set 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
* @param TemplateId 合同模板ID，为32位字符串。
建议开发者保存此模板ID，后续用此模板发起合同流程需要此参数。
可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
*/
public void setTemplateId(String TemplateId) {
this.TemplateId = TemplateId;
}
/**
* Get 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
* @return FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
* @param FlowType 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
示例值：劳务合同
*/
public void setFlowType(String FlowType) {
this.FlowType = FlowType;
}
/**
* Get 签署流程描述,最大长度1000个字符
* @return FlowDescription 签署流程描述,最大长度1000个字符
*/
public String getFlowDescription() {
return this.FlowDescription;
}
/**
* Set 签署流程描述,最大长度1000个字符
* @param FlowDescription 签署流程描述,最大长度1000个字符
*/
public void setFlowDescription(String FlowDescription) {
this.FlowDescription = FlowDescription;
}
/**
* Get 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
* @return Deadline 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
* @param Deadline 签署流程的签署截止时间。
值为unix时间戳,精确到秒,不传默认为当前时间一年后
示例值：1604912664
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 合同（流程）的回调地址
* @return CallbackUrl 合同（流程）的回调地址
* @deprecated
*/
@Deprecated
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 合同（流程）的回调地址
* @param CallbackUrl 合同（流程）的回调地址
* @deprecated
*/
@Deprecated
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* Get 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @return UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public String getUserData() {
return this.UserData;
}
/**
* Set 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
* @param UserData 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
回调的相关说明可参考开发者中心的回调通知模块。
*/
public void setUserData(String UserData) {
this.UserData = UserData;
}
/**
* Get 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
* @return Unordered 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
*/
public Boolean getUnordered() {
return this.Unordered;
}
/**
* Set 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
* @param Unordered 发送类型：
true：无序签
false：有序签
注：默认为false（有序签），请和模板中的配置保持一致
示例值：true
*/
public void setUnordered(Boolean Unordered) {
this.Unordered = Unordered;
}
/**
* Get 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
* @return Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
*/
public Component [] getComponents() {
return this.Components;
}
/**
* Set 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
* @param Components 模板或者合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
- 单行文本控件
- 多行文本控件
- 勾选框控件
- 数字控件
- 图片控件
- 动态表格等填写控件
*/
public void setComponents(Component [] Components) {
this.Components = Components;
}
/**
* Get 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
* @return NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
* @param NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
若设置为true，审核结果需通过接口 [CreateFlowSignReview](https://qian.tencent.com/developers/companyApis/operateFlows/CreateFlowSignReview) 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
示例值：true
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* Get 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
* @return AutoSignScene 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
*/
public String getAutoSignScene() {
return this.AutoSignScene;
}
/**
* Set 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
* @param AutoSignScene 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
示例值：E_PRESCRIPTION_AUTO_SIGN
*/
public void setAutoSignScene(String AutoSignScene) {
this.AutoSignScene = AutoSignScene;
}
/**
* Get 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
* @return FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
public Long getFlowDisplayType() {
return this.FlowDisplayType;
}
/**
* Set 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
* @param FlowDisplayType 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： - 0 :合同（默认值）
- 1 :文件
- 2 :协议
效果如下:
*/
public void setFlowDisplayType(Long FlowDisplayType) {
this.FlowDisplayType = FlowDisplayType;
}
public FlowGroupInfo() {
}
/**
* 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 FlowGroupInfo(FlowGroupInfo source) {
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.Approvers != null) {
this.Approvers = new ApproverInfo[source.Approvers.length];
for (int i = 0; i < source.Approvers.length; i++) {
this.Approvers[i] = new ApproverInfo(source.Approvers[i]);
}
}
if (source.FileIds != null) {
this.FileIds = new String[source.FileIds.length];
for (int i = 0; i < source.FileIds.length; i++) {
this.FileIds[i] = new String(source.FileIds[i]);
}
}
if (source.TemplateId != null) {
this.TemplateId = new String(source.TemplateId);
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.UserData != null) {
this.UserData = new String(source.UserData);
}
if (source.Unordered != null) {
this.Unordered = new Boolean(source.Unordered);
}
if (source.Components != null) {
this.Components = new Component[source.Components.length];
for (int i = 0; i < source.Components.length; i++) {
this.Components[i] = new Component(source.Components[i]);
}
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.AutoSignScene != null) {
this.AutoSignScene = new String(source.AutoSignScene);
}
if (source.FlowDisplayType != null) {
this.FlowDisplayType = new Long(source.FlowDisplayType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamArrayObj(map, prefix + "Approvers.", this.Approvers);
this.setParamArraySimple(map, prefix + "FileIds.", this.FileIds);
this.setParamSimple(map, prefix + "TemplateId", this.TemplateId);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamSimple(map, prefix + "FlowDescription", this.FlowDescription);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamSimple(map, prefix + "UserData", this.UserData);
this.setParamSimple(map, prefix + "Unordered", this.Unordered);
this.setParamArrayObj(map, prefix + "Components.", this.Components);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "AutoSignScene", this.AutoSignScene);
this.setParamSimple(map, prefix + "FlowDisplayType", this.FlowDisplayType);
}
}