com.yodlee.api.model.derived.DerivedHoldingsSummary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yodlee-api-model Show documentation
Yodlee API Model
There is a newer version: 1.1.31
/**
 * 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.derived;

import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.yodlee.api.model.AbstractModelComponent;
import com.yodlee.api.model.Money;
import io.swagger.annotations.ApiModelProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({"classificationType", "classificationValue", "links", "value", "account", "holding"})
public class DerivedHoldingsSummary extends AbstractModelComponent {

	@ApiModelProperty(readOnly = true,
					  value = "The classification type of the security. The supported asset classification type and the values are provided in the /holdings/assetClassificationList."
							  + "
Required Feature Enablement: Asset classification feature."//
							  + "

"//
							  + "Applicable containers: investment, insurance
"//
	)
	@JsonProperty("classificationType")
	private String classificationType;

	@ApiModelProperty(readOnly = true,
					  value = "The classification value that corresponds to the classification type of the holding. The supported asset classification type and the values are provided in the /holdings/assetClassificationList."
							  + "
Required Feature Enablement: Asset classification feature."//
							  + "

"//
							  + "Applicable containers: investment, insurance
"//
	)
	@JsonProperty("classificationValue")
	private String classificationValue;

	@ApiModelProperty(readOnly = true,
					  value = "Summary value of the securities."
							  + "
Required Feature Enablement: Asset classification feature."//
							  + "

"//
							  + "Applicable containers: investment, insurance
"//
	)
	@JsonProperty("value")
	private Money value;

	@ApiModelProperty(readOnly = true,
					  value = "Accounts that contribute to the classification. "
							  + "
Required Feature Enablement: Asset classification feature."//
							  + "

"//
							  + "Applicable containers: investment, insurance
"//
	)
	@JsonProperty("account")
	private List accounts;

	@ApiModelProperty(readOnly = true,
					  value = "Securities that belong to the asset classification type and contributed to the summary value."
							  + "
Required Feature Enablement: Asset classification feature."//
							  + "

"//
							  + "Applicable containers: investment, insurance
"//
	)
	@JsonProperty("holding")
	private List holdings;

	/**
	 * Accounts that contribute to the classification. 

	 * Required Feature Enablement: Asset classification feature. 

	 * 

	 * Applicable containers: investment, insurance

	 * 
	 * @return account
	 */
	@JsonProperty("account")
	public List getAccount() {
		return accounts == null ? null : Collections.unmodifiableList(accounts);
	}

	/**
	 * Securities that belong to the asset classification type and contributed to the summary value. 

	 * Required Feature Enablement: Asset classification feature. 

	 * 

	 * Applicable containers: investment, insurance

	 * 
	 * @return holding
	 */
	@JsonProperty("holding")
	public List getHolding() {
		return holdings == null ? null : Collections.unmodifiableList(holdings);
	}

	/**
	 * The classification value that corresponds to the classification type of the holding. The supported asset
	 * classification type and the values are provided in the /holdings/assetClassificationList. 

	 * Required Feature Enablement: Asset classification feature. 

	 * 

	 * Applicable containers: investment, insurance

	 * 
	 * @return classificationValue
	 */
	public String getClassificationValue() {
		return classificationValue;
	}

	/**
	 * The classification type of the security. The supported asset classification type and the values are provided in
	 * the /holdings/assetClassificationList. 

	 * Required Feature Enablement: Asset classification feature. 

	 * 

	 * Applicable containers: investment, insurance

	 * 
	 * @return classificationType
	 */
	public String getClassificationType() {
		return classificationType;
	}

	/**
	 * Summary value of the securities. 

	 * Required Feature Enablement: Asset classification feature. 

	 * 

	 * Applicable containers: investment, insurance

	 * 
	 * @return value
	 */
	public Money getValue() {
		return value;
	}

	@Override
	public String toString() {
		return "DerivedHoldingsSummary [classificationType=" + classificationType + ", classificationValue="
				+ classificationValue + ", value=" + value + ", account=" + accounts + ", holding=" + holdings + "]";
	}
}