• Home
• com.yodlee
• yodlee-api-model
• 1.0.26
• source code
• Field.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.yodlee.api.model.Field Maven / Gradle / Ivy

/**
 * Copyright (c) 2019 Yodlee, Inc. All Rights Reserved.
 *
 * Licensed under the MIT License. See LICENSE file in the project root for license information.
 */
package com.yodlee.api.model;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.hibernate.validator.constraints.NotEmpty;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.enums.FieldType;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"id", "name", "maxLength", "minLength", "type", "isValueProvided", "value", "isOptional",
		"valueEditable", "option", "prefix", "suffix", "validation"})
public class Field extends AbstractModelComponent {

	@ApiModelProperty(value = "Identifier for the field."//
			+ "

"//
			+ "Endpoints:"//
			+ "
"//
			+ "
GET providerAccounts/{providerAccountId}
"//
			+ "
GET providers/{providerId}
"//
			+ "
")
	@NotEmpty(message = "{providerAccounts.param.field.id.required}")
	@JsonProperty("id")
	private String id;

	@ApiModelProperty(readOnly = true,
					  value = "Name of the field."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("name")
	private String name;

	@ApiModelProperty(readOnly = true,
					  value = "The maximum length of the login form field."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("maxLength")
	private Long maxLength;

	@ApiModelProperty(readOnly = true,
					  value = "The minimum length of the login form field."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("minLength")
	private Long minLength;

	@ApiModelProperty(readOnly = true,
					  value = "This indicates the display type of the field. For example, text box, image, etc. "//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
"//
							  + "Applicable Values
"//
	)
	@JsonProperty("type")
	private FieldType type;

	@ApiModelProperty(readOnly = true,
					  value = "Indicates that the answer to the security question already exists in the Yodlee system."
							  + "Persuading the user to provide the answer to the security question again during the edit-credential flow can be avoided.
"
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts?include=questions
"//
							  + "
GET providerAccounts/{providerAccountId}? include=questions
"//
							  + "
")
	@JsonProperty("isValueProvided")
	private Boolean isValueProvided;

	@ApiModelProperty(value = "Value expected from the user for the field. This will be blank and is expected to be filled and sent back when submitting the login or MFA information."//
			+ "

"//
			+ "Endpoints:"//
			+ "
"//
			+ "
GET providerAccounts/{providerAccountId}
"//
			+ "
GET providers/{providerId}
"//
			+ "
")
	@JsonProperty("value")
	private String value;

	@ApiModelProperty(readOnly = true,
					  value = "Indicates if a field is an optional field or a mandatory field."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("isOptional")
	private Boolean isOptional;

	@ApiModelProperty(readOnly = true,
					  value = "Indicates whether the field is editable or not."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("valueEditable")
	private String valueEditable;

	@ApiModelProperty(readOnly = true,
					  value = "Provides the different values that are available for the user to choose. This field is applicable for drop-down or radio field types."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("option")
	private List options;

	@ApiModelProperty(readOnly = true,
					  value = "The prefix string that has to be displayed before the field value."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("prefix")
	private String prefix;

	@ApiModelProperty(readOnly = true,
					  value = "The suffix string that has to be displayed next to the field value."//
							  + "

"//
							  + "Endpoints:"//
							  + "
"//
							  + "
GET providerAccounts/{providerAccountId}
"//
							  + "
GET providers/{providerId}
"//
							  + "
")
	@JsonProperty("suffix")
	private String suffix;

	@ApiModelProperty(value = "Image displayed at the endsite."//
			+ "

"//
			+ "Endpoints:"//
			+ "
"//
			+ "
GET providerAccounts/{providerAccountId}
"//
			+ "
")
	@JsonProperty("image")
	private String image;
	
	/**
	 * Identifier for the field. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return id
	 */
	public String getId() {
		return id;
	}

	public void setId(String id) {
		this.id = id;
	}

	/**
	 * The maximum length of the login form field. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return maxLength
	 */
	public Long getMaxLength() {
		return maxLength;
	}

	public void setMaxLength(Long maxLength) {
		this.maxLength = maxLength;
	}

	/**
	 * The minimum length of the login form field. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return minLength
	 */
	public Long getMinLength() {
		return minLength;
	}

	public void setMinLength(Long minLength) {
		this.minLength = minLength;
	}

	/**
	 * Name of the field. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return name
	 */
	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	/**
	 * Indicates that the answer to the security question already exists in the Yodlee system. Persuading the user to
	 * provide the answer to the security question again during the edit-credential flow can be avoided.

	 * 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts?include=questions
	 * 
GET providerAccounts/{providerAccountId}? include=questions
	 * 
	 * 
	 * @return isValueProvided
	 */
	public Boolean getIsValueProvided() {
		return isValueProvided;
	}

	public void setIsValueProvided(Boolean isValueProvided) {
		this.isValueProvided = isValueProvided;
	}

	/**
	 * Value expected from the user for the field. This will be blank and is expected to be filled and sent back when
	 * submitting the login or MFA information. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return value
	 */
	public String getValue() {
		return value;
	}

	public void setValue(String value) {
		this.value = value;
	}

	/**
	 * Indicates whether the field is editable or not. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return valueEditable
	 */
	public String getValueEditable() {
		return valueEditable;
	}

	public void setValueEditable(String valueEditable) {
		this.valueEditable = valueEditable;
	}

	/**
	 * This indicates the display type of the field. For example, text box, image, etc. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * Applicable Values

	 * 
	 * @return type
	 */
	public FieldType getType() {
		return type;
	}

	public void setType(FieldType type) {
		this.type = type;
	}

	/**
	 * Indicates if a field is an optional field or a mandatory field. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return isOptional
	 */
	public Boolean getIsOptional() {
		return isOptional;
	}

	public void setIsOptional(Boolean isOptional) {
		this.isOptional = isOptional;
	}

	/**
	 * Provides the different values that are available for the user to choose. This field is applicable for drop-down
	 * or radio field types. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return option
	 */
	@JsonProperty("option")
	public List getOption() {
		return options == null ? null : Collections.unmodifiableList(options);
	}

	@JsonProperty("option")
	public void setOption(List option) {
		if (this.options == null) {
			this.options = new ArrayList<>();
		}
		this.options = option;
	}

	public void addOption(Option option) {
		if (this.options == null) {
			this.options = new ArrayList<>();
		}
		this.options.add(option);
	}

	public boolean removeOption(Option option) {
		if (this.options != null) {
			return this.options.remove(option);
		}
		return false;
	}

	public void clearOption() {
		if (this.options != null) {
			this.options.clear();
		}
	}

	/**
	 * The prefix string that has to be displayed before the field value. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return prefix
	 */
	public String getPrefix() {
		return prefix;
	}

	public void setPrefix(String prefix) {
		this.prefix = prefix;
	}

	/**
	 * The suffix string that has to be displayed next to the field value. 

	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
GET providers/{providerId}
	 * 
	 * 
	 * @return suffix
	 */
	public String getSuffix() {
		return suffix;
	}

	public void setSuffix(String suffix) {
		this.suffix = suffix;
	}
	
	/**
	 * Image displayed at the endsite.
	 * 

	 * Endpoints:
	 * 

	 * 
GET providerAccounts/{providerAccountId}
	 * 
	 * 
	 * @return image
	 */
	public String getImage() {
		return image;
	}
	
	public void setImage(String image) {
		this.image = image;
	}

	@Override
	public String toString() {
		return "Field [id=" + id + ", name=" + name + ", maxLength=" + maxLength + ", minLength=" + minLength
				+ ", type=" + type + ", isValueProvided=" + isValueProvided + ", value=" + value + ", isOptional="
				+ isOptional + ", valueEditable=" + valueEditable + ", options=" + options + ", prefix=" + prefix
				+ ", suffix=" + suffix + ", image=" + image + "]";
	}
}