com.tencentcloudapi.essbasic.v20210526.models.FlowInfo 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.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class FlowInfo extends AbstractModel{
/**
* 合同名字，最大长度200个字符
*/
@SerializedName("FlowName")
@Expose
private String FlowName;
/**
* 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
*/
@SerializedName("Deadline")
@Expose
private Long Deadline;
/**
* 模板ID
*/
@SerializedName("TemplateId")
@Expose
private String TemplateId;
/**
* 多个签署人信息，最大支持50个签署方
*/
@SerializedName("FlowApprovers")
@Expose
private FlowApproverInfo [] FlowApprovers;
/**
* 表单K-V对列表
*/
@SerializedName("FormFields")
@Expose
private FormField [] FormFields;
/**
* 回调地址，最大长度1000个字符
*/
@SerializedName("CallbackUrl")
@Expose
private String CallbackUrl;
/**
* 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
*/
@SerializedName("FlowType")
@Expose
private String FlowType;
/**
* 合同描述，最大长度1000个字符
*/
@SerializedName("FlowDescription")
@Expose
private String FlowDescription;
/**
* 第三方应用平台的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
*/
@SerializedName("CustomerData")
@Expose
private String CustomerData;
/**
* 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
@SerializedName("CustomShowMap")
@Expose
private String CustomShowMap;
/**
* 被抄送人的信息列表，抄送功能暂不开放
*/
@SerializedName("CcInfos")
@Expose
private CcInfo [] CcInfos;
/**
* 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
@SerializedName("NeedSignReview")
@Expose
private Boolean NeedSignReview;
/**
* 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
*/
@SerializedName("CcNotifyType")
@Expose
private Long CcNotifyType;
/**
* 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 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
* @return Deadline 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
*/
public Long getDeadline() {
return this.Deadline;
}
/**
* Set 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
* @param Deadline 签署截止时间戳，超过有效签署时间则该签署流程失败，默认一年
*/
public void setDeadline(Long Deadline) {
this.Deadline = Deadline;
}
/**
* Get 模板ID
* @return TemplateId 模板ID
*/
public String getTemplateId() {
return this.TemplateId;
}
/**
* Set 模板ID
* @param TemplateId 模板ID
*/
public void setTemplateId(String TemplateId) {
this.TemplateId = TemplateId;
}
/**
* Get 多个签署人信息，最大支持50个签署方
* @return FlowApprovers 多个签署人信息，最大支持50个签署方
*/
public FlowApproverInfo [] getFlowApprovers() {
return this.FlowApprovers;
}
/**
* Set 多个签署人信息，最大支持50个签署方
* @param FlowApprovers 多个签署人信息，最大支持50个签署方
*/
public void setFlowApprovers(FlowApproverInfo [] FlowApprovers) {
this.FlowApprovers = FlowApprovers;
}
/**
* Get 表单K-V对列表
* @return FormFields 表单K-V对列表
*/
public FormField [] getFormFields() {
return this.FormFields;
}
/**
* Set 表单K-V对列表
* @param FormFields 表单K-V对列表
*/
public void setFormFields(FormField [] FormFields) {
this.FormFields = FormFields;
}
/**
* Get 回调地址，最大长度1000个字符
* @return CallbackUrl 回调地址，最大长度1000个字符
*/
public String getCallbackUrl() {
return this.CallbackUrl;
}
/**
* Set 回调地址，最大长度1000个字符
* @param CallbackUrl 回调地址，最大长度1000个字符
*/
public void setCallbackUrl(String CallbackUrl) {
this.CallbackUrl = CallbackUrl;
}
/**
* Get 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
* @return FlowType 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
*/
public String getFlowType() {
return this.FlowType;
}
/**
* Set 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度200个字符
* @param FlowType 合同类型，如：1. “劳务”；2. “销售”；3. “租赁”；4. “其他”，最大长度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 第三方应用平台的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
* @return CustomerData 第三方应用平台的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
*/
public String getCustomerData() {
return this.CustomerData;
}
/**
* Set 第三方应用平台的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
* @param CustomerData 第三方应用平台的业务信息，最大长度1000个字符。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
*/
public void setCustomerData(String CustomerData) {
this.CustomerData = CustomerData;
}
/**
* Get 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
* @return CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
public String getCustomShowMap() {
return this.CustomShowMap;
}
/**
* Set 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
* @param CustomShowMap 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
*/
public void setCustomShowMap(String CustomShowMap) {
this.CustomShowMap = CustomShowMap;
}
/**
* Get 被抄送人的信息列表，抄送功能暂不开放
* @return CcInfos 被抄送人的信息列表，抄送功能暂不开放
*/
public CcInfo [] getCcInfos() {
return this.CcInfos;
}
/**
* Set 被抄送人的信息列表，抄送功能暂不开放
* @param CcInfos 被抄送人的信息列表，抄送功能暂不开放
*/
public void setCcInfos(CcInfo [] CcInfos) {
this.CcInfos = CcInfos;
}
/**
* Get 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
* @return NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
public Boolean getNeedSignReview() {
return this.NeedSignReview;
}
/**
* Set 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
* @param NeedSignReview 发起方企业的签署人进行签署操作是否需要企业内部审批。
若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
*/
public void setNeedSignReview(Boolean NeedSignReview) {
this.NeedSignReview = NeedSignReview;
}
/**
* Get 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
* @return CcNotifyType 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
*/
public Long getCcNotifyType() {
return this.CcNotifyType;
}
/**
* Set 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
* @param CcNotifyType 给关注人发送短信通知的类型，0-合同发起时通知 1-签署完成后通知
*/
public void setCcNotifyType(Long CcNotifyType) {
this.CcNotifyType = CcNotifyType;
}
public FlowInfo() {
}
/**
* 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 FlowInfo(FlowInfo source) {
if (source.FlowName != null) {
this.FlowName = new String(source.FlowName);
}
if (source.Deadline != null) {
this.Deadline = new Long(source.Deadline);
}
if (source.TemplateId != null) {
this.TemplateId = new String(source.TemplateId);
}
if (source.FlowApprovers != null) {
this.FlowApprovers = new FlowApproverInfo[source.FlowApprovers.length];
for (int i = 0; i < source.FlowApprovers.length; i++) {
this.FlowApprovers[i] = new FlowApproverInfo(source.FlowApprovers[i]);
}
}
if (source.FormFields != null) {
this.FormFields = new FormField[source.FormFields.length];
for (int i = 0; i < source.FormFields.length; i++) {
this.FormFields[i] = new FormField(source.FormFields[i]);
}
}
if (source.CallbackUrl != null) {
this.CallbackUrl = new String(source.CallbackUrl);
}
if (source.FlowType != null) {
this.FlowType = new String(source.FlowType);
}
if (source.FlowDescription != null) {
this.FlowDescription = new String(source.FlowDescription);
}
if (source.CustomerData != null) {
this.CustomerData = new String(source.CustomerData);
}
if (source.CustomShowMap != null) {
this.CustomShowMap = new String(source.CustomShowMap);
}
if (source.CcInfos != null) {
this.CcInfos = new CcInfo[source.CcInfos.length];
for (int i = 0; i < source.CcInfos.length; i++) {
this.CcInfos[i] = new CcInfo(source.CcInfos[i]);
}
}
if (source.NeedSignReview != null) {
this.NeedSignReview = new Boolean(source.NeedSignReview);
}
if (source.CcNotifyType != null) {
this.CcNotifyType = new Long(source.CcNotifyType);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "FlowName", this.FlowName);
this.setParamSimple(map, prefix + "Deadline", this.Deadline);
this.setParamSimple(map, prefix + "TemplateId", this.TemplateId);
this.setParamArrayObj(map, prefix + "FlowApprovers.", this.FlowApprovers);
this.setParamArrayObj(map, prefix + "FormFields.", this.FormFields);
this.setParamSimple(map, prefix + "CallbackUrl", this.CallbackUrl);
this.setParamSimple(map, prefix + "FlowType", this.FlowType);
this.setParamSimple(map, prefix + "FlowDescription", this.FlowDescription);
this.setParamSimple(map, prefix + "CustomerData", this.CustomerData);
this.setParamSimple(map, prefix + "CustomShowMap", this.CustomShowMap);
this.setParamArrayObj(map, prefix + "CcInfos.", this.CcInfos);
this.setParamSimple(map, prefix + "NeedSignReview", this.NeedSignReview);
this.setParamSimple(map, prefix + "CcNotifyType", this.CcNotifyType);
}
}