com.factset.sdk.FactSetFunds.models.Summaries Maven / Gradle / Ivy
Show all versions of factsetfunds Show documentation
/*
* FactSet Funds API
* FactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage * Fund descriptions * A seven-tier classification system * Leverage information * Fees and expenses * Portfolio managers FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage * Net asset value * Fund flows * Assets under management * Total return
*
* The version of the OpenAPI document: 1.0.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.factset.sdk.FactSetFunds.models;
import java.util.Objects;
import java.util.Arrays;
import java.util.Map;
import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetFunds.JSON;
/**
* Summaries
*/
@JsonPropertyOrder({
Summaries.JSON_PROPERTY_FSYM_ID,
Summaries.JSON_PROPERTY_FSYM_ENTITY_ID,
Summaries.JSON_PROPERTY_FSYM_REGIONAL_ID,
Summaries.JSON_PROPERTY_FSYM_TICKER_REGION,
Summaries.JSON_PROPERTY_FSYM_ULTIMATE_PARENT_ID,
Summaries.JSON_PROPERTY_REQUEST_ID,
Summaries.JSON_PROPERTY_ACTIVE_FLAG,
Summaries.JSON_PROPERTY_ACTIVELY_MANAGED_FLAG,
Summaries.JSON_PROPERTY_BRAND,
Summaries.JSON_PROPERTY_COUNTRY_DOMICILE,
Summaries.JSON_PROPERTY_CURRENCY,
Summaries.JSON_PROPERTY_DESC_INFO,
Summaries.JSON_PROPERTY_FUND_OF_FUNDS_ID,
Summaries.JSON_PROPERTY_INCEPTION_DATE,
Summaries.JSON_PROPERTY_INSIGHT,
Summaries.JSON_PROPERTY_ISSUER_ID,
Summaries.JSON_PROPERTY_ISSUER_NAME,
Summaries.JSON_PROPERTY_LEGAL_STRUCTURE,
Summaries.JSON_PROPERTY_LEVERAGE_FACTOR,
Summaries.JSON_PROPERTY_LEVERAGE_INVERSE,
Summaries.JSON_PROPERTY_NAME,
Summaries.JSON_PROPERTY_NAV_CURRENCY,
Summaries.JSON_PROPERTY_OBJECTIVE,
Summaries.JSON_PROPERTY_PRICE_FIRST_DATE,
Summaries.JSON_PROPERTY_PRICE_RECENT_DATE,
Summaries.JSON_PROPERTY_SHR_CLASS,
Summaries.JSON_PROPERTY_SHR_CLASS_ACTIVE_FLAG,
Summaries.JSON_PROPERTY_SHR_CLS_CURRENCY,
Summaries.JSON_PROPERTY_SHR_CLS_INCEPT_DATE,
Summaries.JSON_PROPERTY_SHR_CLS_NAME,
Summaries.JSON_PROPERTY_SHR_CLS_TERM_DATE,
Summaries.JSON_PROPERTY_TERMINATION_DATE,
Summaries.JSON_PROPERTY_TYPE,
Summaries.JSON_PROPERTY_WEB_SITE
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class Summaries implements Serializable {
private static final long serialVersionUID = 1L;
public static final String JSON_PROPERTY_FSYM_ID = "fsymId";
private String fsymId;
public static final String JSON_PROPERTY_FSYM_ENTITY_ID = "fsymEntityId";
private String fsymEntityId;
public static final String JSON_PROPERTY_FSYM_REGIONAL_ID = "fsymRegionalId";
private String fsymRegionalId;
public static final String JSON_PROPERTY_FSYM_TICKER_REGION = "fsymTickerRegion";
private String fsymTickerRegion;
public static final String JSON_PROPERTY_FSYM_ULTIMATE_PARENT_ID = "fsymUltimateParentId";
private String fsymUltimateParentId;
public static final String JSON_PROPERTY_REQUEST_ID = "requestId";
private String requestId;
public static final String JSON_PROPERTY_ACTIVE_FLAG = "activeFlag";
private Integer activeFlag;
public static final String JSON_PROPERTY_ACTIVELY_MANAGED_FLAG = "activelyManagedFlag";
private Integer activelyManagedFlag;
public static final String JSON_PROPERTY_BRAND = "brand";
private String brand;
public static final String JSON_PROPERTY_COUNTRY_DOMICILE = "countryDomicile";
private String countryDomicile;
public static final String JSON_PROPERTY_CURRENCY = "currency";
private String currency;
public static final String JSON_PROPERTY_DESC_INFO = "descInfo";
private String descInfo;
public static final String JSON_PROPERTY_FUND_OF_FUNDS_ID = "fundOfFundsId";
private String fundOfFundsId;
public static final String JSON_PROPERTY_INCEPTION_DATE = "inceptionDate";
private String inceptionDate;
public static final String JSON_PROPERTY_INSIGHT = "insight";
private String insight;
public static final String JSON_PROPERTY_ISSUER_ID = "issuerId";
private String issuerId;
public static final String JSON_PROPERTY_ISSUER_NAME = "issuerName";
private String issuerName;
public static final String JSON_PROPERTY_LEGAL_STRUCTURE = "legalStructure";
private String legalStructure;
public static final String JSON_PROPERTY_LEVERAGE_FACTOR = "leverageFactor";
private Double leverageFactor;
public static final String JSON_PROPERTY_LEVERAGE_INVERSE = "leverageInverse";
private String leverageInverse;
public static final String JSON_PROPERTY_NAME = "name";
private String name;
public static final String JSON_PROPERTY_NAV_CURRENCY = "navCurrency";
private String navCurrency;
public static final String JSON_PROPERTY_OBJECTIVE = "objective";
private String objective;
public static final String JSON_PROPERTY_PRICE_FIRST_DATE = "priceFirstDate";
private String priceFirstDate;
public static final String JSON_PROPERTY_PRICE_RECENT_DATE = "priceRecentDate";
private String priceRecentDate;
public static final String JSON_PROPERTY_SHR_CLASS = "shrClass";
private String shrClass;
public static final String JSON_PROPERTY_SHR_CLASS_ACTIVE_FLAG = "shrClassActiveFlag";
private Integer shrClassActiveFlag;
public static final String JSON_PROPERTY_SHR_CLS_CURRENCY = "shrClsCurrency";
private String shrClsCurrency;
public static final String JSON_PROPERTY_SHR_CLS_INCEPT_DATE = "shrClsInceptDate";
private String shrClsInceptDate;
public static final String JSON_PROPERTY_SHR_CLS_NAME = "shrClsName";
private String shrClsName;
public static final String JSON_PROPERTY_SHR_CLS_TERM_DATE = "shrClsTermDate";
private String shrClsTermDate;
public static final String JSON_PROPERTY_TERMINATION_DATE = "terminationDate";
private String terminationDate;
public static final String JSON_PROPERTY_TYPE = "type";
private String type;
public static final String JSON_PROPERTY_WEB_SITE = "webSite";
private String webSite;
public Summaries fsymId(String fsymId) {
this.fsymId = fsymId;
return this;
}
/**
* FactSet Security Identifier. Six alpha-numeric characters, excluding vowels, with a -S suffix (XXXXXX-S), resolved from the requestId of the Fund requested.
* @return fsymId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "FNK7XP-S", value = "FactSet Security Identifier. Six alpha-numeric characters, excluding vowels, with a -S suffix (XXXXXX-S), resolved from the requestId of the Fund requested.")
@JsonProperty(JSON_PROPERTY_FSYM_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFsymId() {
return fsymId;
}
@JsonProperty(JSON_PROPERTY_FSYM_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFsymId(String fsymId) {
this.fsymId = fsymId;
}
public Summaries fsymEntityId(String fsymEntityId) {
this.fsymEntityId = fsymEntityId;
return this;
}
/**
* FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E), resolved from the requestId of the Fund requested.
* @return fsymEntityId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "04BFG7-E", value = "FactSet Entity Identifier. Six alpha-numeric characters, excluding vowels, with a -E suffix (XXXXXX-E), resolved from the requestId of the Fund requested.")
@JsonProperty(JSON_PROPERTY_FSYM_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFsymEntityId() {
return fsymEntityId;
}
@JsonProperty(JSON_PROPERTY_FSYM_ENTITY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFsymEntityId(String fsymEntityId) {
this.fsymEntityId = fsymEntityId;
}
public Summaries fsymRegionalId(String fsymRegionalId) {
this.fsymRegionalId = fsymRegionalId;
return this;
}
/**
* FactSet Regional Identifier. Six alpha-numeric characters, excluding vowels, with a -R suffix (XXXXXX-R), resolved from the requestId of the Fund requested.
* @return fsymRegionalId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "SJY03Z-R", value = "FactSet Regional Identifier. Six alpha-numeric characters, excluding vowels, with a -R suffix (XXXXXX-R), resolved from the requestId of the Fund requested.")
@JsonProperty(JSON_PROPERTY_FSYM_REGIONAL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFsymRegionalId() {
return fsymRegionalId;
}
@JsonProperty(JSON_PROPERTY_FSYM_REGIONAL_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFsymRegionalId(String fsymRegionalId) {
this.fsymRegionalId = fsymRegionalId;
}
public Summaries fsymTickerRegion(String fsymTickerRegion) {
this.fsymTickerRegion = fsymTickerRegion;
return this;
}
/**
* FactSet Ticker-Region for the requested fund.
* @return fsymTickerRegion
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "MABAX-US", value = "FactSet Ticker-Region for the requested fund.")
@JsonProperty(JSON_PROPERTY_FSYM_TICKER_REGION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFsymTickerRegion() {
return fsymTickerRegion;
}
@JsonProperty(JSON_PROPERTY_FSYM_TICKER_REGION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFsymTickerRegion(String fsymTickerRegion) {
this.fsymTickerRegion = fsymTickerRegion;
}
public Summaries fsymUltimateParentId(String fsymUltimateParentId) {
this.fsymUltimateParentId = fsymUltimateParentId;
return this;
}
/**
* The FactSet Ultimate Parent Entity Identifer, with a -E suffix (XXXXXX-E).
* @return fsymUltimateParentId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "002HJD-E", value = "The FactSet Ultimate Parent Entity Identifer, with a -E suffix (XXXXXX-E).")
@JsonProperty(JSON_PROPERTY_FSYM_ULTIMATE_PARENT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFsymUltimateParentId() {
return fsymUltimateParentId;
}
@JsonProperty(JSON_PROPERTY_FSYM_ULTIMATE_PARENT_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFsymUltimateParentId(String fsymUltimateParentId) {
this.fsymUltimateParentId = fsymUltimateParentId;
}
public Summaries requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* The requested Id sent as input.
* @return requestId
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "MABAX", value = "The requested Id sent as input.")
@JsonProperty(JSON_PROPERTY_REQUEST_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getRequestId() {
return requestId;
}
@JsonProperty(JSON_PROPERTY_REQUEST_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setRequestId(String requestId) {
this.requestId = requestId;
}
public Summaries activeFlag(Integer activeFlag) {
this.activeFlag = activeFlag;
return this;
}
/**
* Binary flag to indicate whether the fund is currently active, where 1 is active and 0 is inactive.
* @return activeFlag
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "1", value = "Binary flag to indicate whether the fund is currently active, where 1 is active and 0 is inactive.")
@JsonProperty(JSON_PROPERTY_ACTIVE_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getActiveFlag() {
return activeFlag;
}
@JsonProperty(JSON_PROPERTY_ACTIVE_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setActiveFlag(Integer activeFlag) {
this.activeFlag = activeFlag;
}
public Summaries activelyManagedFlag(Integer activelyManagedFlag) {
this.activelyManagedFlag = activelyManagedFlag;
return this;
}
/**
* Binary indicator of whether the fund is actively managed, where 1 is active and 0 is inactive.
* @return activelyManagedFlag
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "1", value = "Binary indicator of whether the fund is actively managed, where 1 is active and 0 is inactive.")
@JsonProperty(JSON_PROPERTY_ACTIVELY_MANAGED_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getActivelyManagedFlag() {
return activelyManagedFlag;
}
@JsonProperty(JSON_PROPERTY_ACTIVELY_MANAGED_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setActivelyManagedFlag(Integer activelyManagedFlag) {
this.activelyManagedFlag = activelyManagedFlag;
}
public Summaries brand(String brand) {
this.brand = brand;
return this;
}
/**
* The Funds Brand Name in proper format.
* @return brand
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "BlackRock", value = "The Funds Brand Name in proper format.")
@JsonProperty(JSON_PROPERTY_BRAND)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getBrand() {
return brand;
}
@JsonProperty(JSON_PROPERTY_BRAND)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setBrand(String brand) {
this.brand = brand;
}
public Summaries countryDomicile(String countryDomicile) {
this.countryDomicile = countryDomicile;
return this;
}
/**
* Returns the fund's country of domicile in ISO2 format. Only available for Mutual Funds.
* @return countryDomicile
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "US", value = "Returns the fund's country of domicile in ISO2 format. Only available for Mutual Funds.")
@JsonProperty(JSON_PROPERTY_COUNTRY_DOMICILE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCountryDomicile() {
return countryDomicile;
}
@JsonProperty(JSON_PROPERTY_COUNTRY_DOMICILE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCountryDomicile(String countryDomicile) {
this.countryDomicile = countryDomicile;
}
public Summaries currency(String currency) {
this.currency = currency;
return this;
}
/**
* The fund's currency.
* @return currency
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "USD", value = "The fund's currency.")
@JsonProperty(JSON_PROPERTY_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getCurrency() {
return currency;
}
@JsonProperty(JSON_PROPERTY_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setCurrency(String currency) {
this.currency = currency;
}
public Summaries descInfo(String descInfo) {
this.descInfo = descInfo;
return this;
}
/**
* The Fund's Investment Strategy short description.
* @return descInfo
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "The investment objective of the BlackRock Basic Value Fund, Inc. (the Fund) is to seek capital appreciation and, secondarily, income by investing in securities, primarily equity securities, that management of the Fund believes are undervalued and therefore represent basic investment value.", value = "The Fund's Investment Strategy short description.")
@JsonProperty(JSON_PROPERTY_DESC_INFO)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getDescInfo() {
return descInfo;
}
@JsonProperty(JSON_PROPERTY_DESC_INFO)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setDescInfo(String descInfo) {
this.descInfo = descInfo;
}
public Summaries fundOfFundsId(String fundOfFundsId) {
this.fundOfFundsId = fundOfFundsId;
return this;
}
/**
* The fund of fund's id if applicable. Will provide plain Fund of Funds text.
* @return fundOfFundsId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The fund of fund's id if applicable. Will provide plain Fund of Funds text.")
@JsonProperty(JSON_PROPERTY_FUND_OF_FUNDS_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getFundOfFundsId() {
return fundOfFundsId;
}
@JsonProperty(JSON_PROPERTY_FUND_OF_FUNDS_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setFundOfFundsId(String fundOfFundsId) {
this.fundOfFundsId = fundOfFundsId;
}
public Summaries inceptionDate(String inceptionDate) {
this.inceptionDate = inceptionDate;
return this;
}
/**
* The fund's inception date in YYYY-MM-DD format.
* @return inceptionDate
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Fri Jul 01 00:00:00 UTC 1977", value = "The fund's inception date in YYYY-MM-DD format.")
@JsonProperty(JSON_PROPERTY_INCEPTION_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getInceptionDate() {
return inceptionDate;
}
@JsonProperty(JSON_PROPERTY_INCEPTION_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setInceptionDate(String inceptionDate) {
this.inceptionDate = inceptionDate;
}
public Summaries insight(String insight) {
this.insight = insight;
return this;
}
/**
* The fund's investment strategy long description. Use `descInfo` if needing short description.
* @return insight
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The fund's investment strategy long description. Use `descInfo` if needing short description.")
@JsonProperty(JSON_PROPERTY_INSIGHT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getInsight() {
return insight;
}
@JsonProperty(JSON_PROPERTY_INSIGHT)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setInsight(String insight) {
this.insight = insight;
}
public Summaries issuerId(String issuerId) {
this.issuerId = issuerId;
return this;
}
/**
* The Issuer Identifier.
* @return issuerId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The Issuer Identifier.")
@JsonProperty(JSON_PROPERTY_ISSUER_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getIssuerId() {
return issuerId;
}
@JsonProperty(JSON_PROPERTY_ISSUER_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIssuerId(String issuerId) {
this.issuerId = issuerId;
}
public Summaries issuerName(String issuerName) {
this.issuerName = issuerName;
return this;
}
/**
* The Issuer Name in proper format.
* @return issuerName
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "BlackRock Inc.", value = "The Issuer Name in proper format.")
@JsonProperty(JSON_PROPERTY_ISSUER_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getIssuerName() {
return issuerName;
}
@JsonProperty(JSON_PROPERTY_ISSUER_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setIssuerName(String issuerName) {
this.issuerName = issuerName;
}
public Summaries legalStructure(String legalStructure) {
this.legalStructure = legalStructure;
return this;
}
/**
* The legal structure of the fund, e.g. Open-Ended Fund, close-ended fund
* @return legalStructure
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Open-Ended Fund", value = "The legal structure of the fund, e.g. Open-Ended Fund, close-ended fund")
@JsonProperty(JSON_PROPERTY_LEGAL_STRUCTURE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getLegalStructure() {
return legalStructure;
}
@JsonProperty(JSON_PROPERTY_LEGAL_STRUCTURE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLegalStructure(String legalStructure) {
this.legalStructure = legalStructure;
}
public Summaries leverageFactor(Double leverageFactor) {
this.leverageFactor = leverageFactor;
return this;
}
/**
* The leverage factor of the fund.
* @return leverageFactor
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "0", value = "The leverage factor of the fund.")
@JsonProperty(JSON_PROPERTY_LEVERAGE_FACTOR)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Double getLeverageFactor() {
return leverageFactor;
}
@JsonProperty(JSON_PROPERTY_LEVERAGE_FACTOR)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLeverageFactor(Double leverageFactor) {
this.leverageFactor = leverageFactor;
}
public Summaries leverageInverse(String leverageInverse) {
this.leverageInverse = leverageInverse;
return this;
}
/**
* Indicates whether the fund is leveraged, inverse, or neither in proper format.
* @return leverageInverse
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Neither", value = "Indicates whether the fund is leveraged, inverse, or neither in proper format.")
@JsonProperty(JSON_PROPERTY_LEVERAGE_INVERSE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getLeverageInverse() {
return leverageInverse;
}
@JsonProperty(JSON_PROPERTY_LEVERAGE_INVERSE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setLeverageInverse(String leverageInverse) {
this.leverageInverse = leverageInverse;
}
public Summaries name(String name) {
this.name = name;
return this;
}
/**
* The Fund security's name in proper format.
* @return name
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "BlackRock Basic Value Fund Incorporated", value = "The Fund security's name in proper format.")
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getName() {
return name;
}
@JsonProperty(JSON_PROPERTY_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setName(String name) {
this.name = name;
}
public Summaries navCurrency(String navCurrency) {
this.navCurrency = navCurrency;
return this;
}
/**
* The NAV currency for the specified share class.
* @return navCurrency
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "USD", value = "The NAV currency for the specified share class.")
@JsonProperty(JSON_PROPERTY_NAV_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getNavCurrency() {
return navCurrency;
}
@JsonProperty(JSON_PROPERTY_NAV_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setNavCurrency(String navCurrency) {
this.navCurrency = navCurrency;
}
public Summaries objective(String objective) {
this.objective = objective;
return this;
}
/**
* The Fund's objective long description.
* @return objective
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "The Fund invests primarily in equity securities that Fund management believes are undervalued, which means that their prices are less than Fund management believes they are worth. Equity securities primarily consist of common stock, preferred stock, securities convertible into common stock, or securities or other instruments whose price is linked to the value of common stock. Fund management places particular emphasis on companies with below average price/earnings ratios that may pay above average dividends. The Fund invests primarily in common stock of U.S. companies, but the Fund may invest up to 25% of its total assets in the securities of foreign companies. The Fund focuses primarily on companies with market capitalizations of over $5 billion.", value = "The Fund's objective long description.")
@JsonProperty(JSON_PROPERTY_OBJECTIVE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getObjective() {
return objective;
}
@JsonProperty(JSON_PROPERTY_OBJECTIVE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setObjective(String objective) {
this.objective = objective;
}
public Summaries priceFirstDate(String priceFirstDate) {
this.priceFirstDate = priceFirstDate;
return this;
}
/**
* The fund's first available date for prices (NAV) in YYYY-MM-DD format. This can be used to fetch the first available price from FactSet. *NOTE: This is not the inception date of fund.*
* @return priceFirstDate
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Wed Apr 18 00:00:00 UTC 2018", value = "The fund's first available date for prices (NAV) in YYYY-MM-DD format. This can be used to fetch the first available price from FactSet. *NOTE: This is not the inception date of fund.*")
@JsonProperty(JSON_PROPERTY_PRICE_FIRST_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPriceFirstDate() {
return priceFirstDate;
}
@JsonProperty(JSON_PROPERTY_PRICE_FIRST_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPriceFirstDate(String priceFirstDate) {
this.priceFirstDate = priceFirstDate;
}
public Summaries priceRecentDate(String priceRecentDate) {
this.priceRecentDate = priceRecentDate;
return this;
}
/**
* The fund's most recent available date for prices (NAV) in YYYY-MM-DD format.
* @return priceRecentDate
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Fri Mar 26 00:00:00 UTC 2021", value = "The fund's most recent available date for prices (NAV) in YYYY-MM-DD format.")
@JsonProperty(JSON_PROPERTY_PRICE_RECENT_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getPriceRecentDate() {
return priceRecentDate;
}
@JsonProperty(JSON_PROPERTY_PRICE_RECENT_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setPriceRecentDate(String priceRecentDate) {
this.priceRecentDate = priceRecentDate;
}
public Summaries shrClass(String shrClass) {
this.shrClass = shrClass;
return this;
}
/**
* The Funds Share class type name in proper format.
* @return shrClass
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Institutional Class", value = "The Funds Share class type name in proper format.")
@JsonProperty(JSON_PROPERTY_SHR_CLASS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShrClass() {
return shrClass;
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClass(String shrClass) {
this.shrClass = shrClass;
}
public Summaries shrClassActiveFlag(Integer shrClassActiveFlag) {
this.shrClassActiveFlag = shrClassActiveFlag;
return this;
}
/**
* Returns a binary indicator of whether the specified share class is currently active, where 1 is active and 0 is inactive.
* @return shrClassActiveFlag
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "1", value = "Returns a binary indicator of whether the specified share class is currently active, where 1 is active and 0 is inactive.")
@JsonProperty(JSON_PROPERTY_SHR_CLASS_ACTIVE_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Integer getShrClassActiveFlag() {
return shrClassActiveFlag;
}
@JsonProperty(JSON_PROPERTY_SHR_CLASS_ACTIVE_FLAG)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClassActiveFlag(Integer shrClassActiveFlag) {
this.shrClassActiveFlag = shrClassActiveFlag;
}
public Summaries shrClsCurrency(String shrClsCurrency) {
this.shrClsCurrency = shrClsCurrency;
return this;
}
/**
* The currency for the specified share class.
* @return shrClsCurrency
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "USD", value = "The currency for the specified share class.")
@JsonProperty(JSON_PROPERTY_SHR_CLS_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShrClsCurrency() {
return shrClsCurrency;
}
@JsonProperty(JSON_PROPERTY_SHR_CLS_CURRENCY)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClsCurrency(String shrClsCurrency) {
this.shrClsCurrency = shrClsCurrency;
}
public Summaries shrClsInceptDate(String shrClsInceptDate) {
this.shrClsInceptDate = shrClsInceptDate;
return this;
}
/**
* The specified share class's inception date in YYYY-MM-DD format.
* @return shrClsInceptDate
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Fri Jul 01 00:00:00 UTC 1977", value = "The specified share class's inception date in YYYY-MM-DD format.")
@JsonProperty(JSON_PROPERTY_SHR_CLS_INCEPT_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShrClsInceptDate() {
return shrClsInceptDate;
}
@JsonProperty(JSON_PROPERTY_SHR_CLS_INCEPT_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClsInceptDate(String shrClsInceptDate) {
this.shrClsInceptDate = shrClsInceptDate;
}
public Summaries shrClsName(String shrClsName) {
this.shrClsName = shrClsName;
return this;
}
/**
* The specified share class name for the fund in proper format.
* @return shrClsName
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "BlackRock Basic Value I", value = "The specified share class name for the fund in proper format.")
@JsonProperty(JSON_PROPERTY_SHR_CLS_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShrClsName() {
return shrClsName;
}
@JsonProperty(JSON_PROPERTY_SHR_CLS_NAME)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClsName(String shrClsName) {
this.shrClsName = shrClsName;
}
public Summaries shrClsTermDate(String shrClsTermDate) {
this.shrClsTermDate = shrClsTermDate;
return this;
}
/**
* The Share class Termination Date in YYYY-MM-DD format. If still active, value will be null.
* @return shrClsTermDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The Share class Termination Date in YYYY-MM-DD format. If still active, value will be null.")
@JsonProperty(JSON_PROPERTY_SHR_CLS_TERM_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getShrClsTermDate() {
return shrClsTermDate;
}
@JsonProperty(JSON_PROPERTY_SHR_CLS_TERM_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setShrClsTermDate(String shrClsTermDate) {
this.shrClsTermDate = shrClsTermDate;
}
public Summaries terminationDate(String terminationDate) {
this.terminationDate = terminationDate;
return this;
}
/**
* The Termination Date in YYYY-MM-DD format. If still active, value will be null.
* @return terminationDate
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The Termination Date in YYYY-MM-DD format. If still active, value will be null.")
@JsonProperty(JSON_PROPERTY_TERMINATION_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getTerminationDate() {
return terminationDate;
}
@JsonProperty(JSON_PROPERTY_TERMINATION_DATE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setTerminationDate(String terminationDate) {
this.terminationDate = terminationDate;
}
public Summaries type(String type) {
this.type = type;
return this;
}
/**
* The Type of Fund, e.g. Mutual Fund, Unit Investment Trust
* @return type
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Mutual Fund", value = "The Type of Fund, e.g. Mutual Fund, Unit Investment Trust")
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getType() {
return type;
}
@JsonProperty(JSON_PROPERTY_TYPE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setType(String type) {
this.type = type;
}
public Summaries webSite(String webSite) {
this.webSite = webSite;
return this;
}
/**
* The URL of the Fund.
* @return webSite
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "https://www.blackrock.com/investing/products/227716/blackrock-basic-value-class-a-fund", value = "The URL of the Fund.")
@JsonProperty(JSON_PROPERTY_WEB_SITE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public String getWebSite() {
return webSite;
}
@JsonProperty(JSON_PROPERTY_WEB_SITE)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public void setWebSite(String webSite) {
this.webSite = webSite;
}
/**
* Return true if this summaries object is equal to o.
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Summaries summaries = (Summaries) o;
return Objects.equals(this.fsymId, summaries.fsymId) &&
Objects.equals(this.fsymEntityId, summaries.fsymEntityId) &&
Objects.equals(this.fsymRegionalId, summaries.fsymRegionalId) &&
Objects.equals(this.fsymTickerRegion, summaries.fsymTickerRegion) &&
Objects.equals(this.fsymUltimateParentId, summaries.fsymUltimateParentId) &&
Objects.equals(this.requestId, summaries.requestId) &&
Objects.equals(this.activeFlag, summaries.activeFlag) &&
Objects.equals(this.activelyManagedFlag, summaries.activelyManagedFlag) &&
Objects.equals(this.brand, summaries.brand) &&
Objects.equals(this.countryDomicile, summaries.countryDomicile) &&
Objects.equals(this.currency, summaries.currency) &&
Objects.equals(this.descInfo, summaries.descInfo) &&
Objects.equals(this.fundOfFundsId, summaries.fundOfFundsId) &&
Objects.equals(this.inceptionDate, summaries.inceptionDate) &&
Objects.equals(this.insight, summaries.insight) &&
Objects.equals(this.issuerId, summaries.issuerId) &&
Objects.equals(this.issuerName, summaries.issuerName) &&
Objects.equals(this.legalStructure, summaries.legalStructure) &&
Objects.equals(this.leverageFactor, summaries.leverageFactor) &&
Objects.equals(this.leverageInverse, summaries.leverageInverse) &&
Objects.equals(this.name, summaries.name) &&
Objects.equals(this.navCurrency, summaries.navCurrency) &&
Objects.equals(this.objective, summaries.objective) &&
Objects.equals(this.priceFirstDate, summaries.priceFirstDate) &&
Objects.equals(this.priceRecentDate, summaries.priceRecentDate) &&
Objects.equals(this.shrClass, summaries.shrClass) &&
Objects.equals(this.shrClassActiveFlag, summaries.shrClassActiveFlag) &&
Objects.equals(this.shrClsCurrency, summaries.shrClsCurrency) &&
Objects.equals(this.shrClsInceptDate, summaries.shrClsInceptDate) &&
Objects.equals(this.shrClsName, summaries.shrClsName) &&
Objects.equals(this.shrClsTermDate, summaries.shrClsTermDate) &&
Objects.equals(this.terminationDate, summaries.terminationDate) &&
Objects.equals(this.type, summaries.type) &&
Objects.equals(this.webSite, summaries.webSite);
}
@Override
public int hashCode() {
return Objects.hash(fsymId, fsymEntityId, fsymRegionalId, fsymTickerRegion, fsymUltimateParentId, requestId, activeFlag, activelyManagedFlag, brand, countryDomicile, currency, descInfo, fundOfFundsId, inceptionDate, insight, issuerId, issuerName, legalStructure, leverageFactor, leverageInverse, name, navCurrency, objective, priceFirstDate, priceRecentDate, shrClass, shrClassActiveFlag, shrClsCurrency, shrClsInceptDate, shrClsName, shrClsTermDate, terminationDate, type, webSite);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Summaries {\n");
sb.append(" fsymId: ").append(toIndentedString(fsymId)).append("\n");
sb.append(" fsymEntityId: ").append(toIndentedString(fsymEntityId)).append("\n");
sb.append(" fsymRegionalId: ").append(toIndentedString(fsymRegionalId)).append("\n");
sb.append(" fsymTickerRegion: ").append(toIndentedString(fsymTickerRegion)).append("\n");
sb.append(" fsymUltimateParentId: ").append(toIndentedString(fsymUltimateParentId)).append("\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n");
sb.append(" activeFlag: ").append(toIndentedString(activeFlag)).append("\n");
sb.append(" activelyManagedFlag: ").append(toIndentedString(activelyManagedFlag)).append("\n");
sb.append(" brand: ").append(toIndentedString(brand)).append("\n");
sb.append(" countryDomicile: ").append(toIndentedString(countryDomicile)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" descInfo: ").append(toIndentedString(descInfo)).append("\n");
sb.append(" fundOfFundsId: ").append(toIndentedString(fundOfFundsId)).append("\n");
sb.append(" inceptionDate: ").append(toIndentedString(inceptionDate)).append("\n");
sb.append(" insight: ").append(toIndentedString(insight)).append("\n");
sb.append(" issuerId: ").append(toIndentedString(issuerId)).append("\n");
sb.append(" issuerName: ").append(toIndentedString(issuerName)).append("\n");
sb.append(" legalStructure: ").append(toIndentedString(legalStructure)).append("\n");
sb.append(" leverageFactor: ").append(toIndentedString(leverageFactor)).append("\n");
sb.append(" leverageInverse: ").append(toIndentedString(leverageInverse)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" navCurrency: ").append(toIndentedString(navCurrency)).append("\n");
sb.append(" objective: ").append(toIndentedString(objective)).append("\n");
sb.append(" priceFirstDate: ").append(toIndentedString(priceFirstDate)).append("\n");
sb.append(" priceRecentDate: ").append(toIndentedString(priceRecentDate)).append("\n");
sb.append(" shrClass: ").append(toIndentedString(shrClass)).append("\n");
sb.append(" shrClassActiveFlag: ").append(toIndentedString(shrClassActiveFlag)).append("\n");
sb.append(" shrClsCurrency: ").append(toIndentedString(shrClsCurrency)).append("\n");
sb.append(" shrClsInceptDate: ").append(toIndentedString(shrClsInceptDate)).append("\n");
sb.append(" shrClsName: ").append(toIndentedString(shrClsName)).append("\n");
sb.append(" shrClsTermDate: ").append(toIndentedString(shrClsTermDate)).append("\n");
sb.append(" terminationDate: ").append(toIndentedString(terminationDate)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" webSite: ").append(toIndentedString(webSite)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}