• Home
• com.factset.sdk
• factsetfunds
• 2.1.0
• source code
• Classifications.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.factset.sdk.FactSetFunds.models.Classifications Maven / Gradle / Ivy

/*
 * 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  
This API is rate-limited to 10 requests per second and 10 concurrent requests per user.
 
 *
 * The version of the OpenAPI document: 1.1.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 org.openapitools.jackson.nullable.JsonNullable;
import com.fasterxml.jackson.annotation.JsonIgnore;
import org.openapitools.jackson.nullable.JsonNullable;
import java.util.NoSuchElementException;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetFunds.JSON;


/**
 * Classifications
 */
@JsonPropertyOrder({
  Classifications.JSON_PROPERTY_FSYM_ID,
  Classifications.JSON_PROPERTY_REQUEST_ID,
  Classifications.JSON_PROPERTY_ASSET_CLASS,
  Classifications.JSON_PROPERTY_CATEGORY_CLASS,
  Classifications.JSON_PROPERTY_ECONOMIC_DEVELOPMENT_CLASS,
  Classifications.JSON_PROPERTY_FOCUS_CLASS,
  Classifications.JSON_PROPERTY_GEOGRAPHIC_CLASS,
  Classifications.JSON_PROPERTY_NICHE_CLASS,
  Classifications.JSON_PROPERTY_REGION_CLASS
})
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")

public class Classifications implements Serializable {
  private static final long serialVersionUID = 1L;

  public static final String JSON_PROPERTY_FSYM_ID = "fsymId";
  private JsonNullable fsymId = JsonNullable.undefined();

  public static final String JSON_PROPERTY_REQUEST_ID = "requestId";
  private String requestId;

  public static final String JSON_PROPERTY_ASSET_CLASS = "assetClass";
  private JsonNullable assetClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_CATEGORY_CLASS = "categoryClass";
  private JsonNullable categoryClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_ECONOMIC_DEVELOPMENT_CLASS = "economicDevelopmentClass";
  private JsonNullable economicDevelopmentClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_FOCUS_CLASS = "focusClass";
  private JsonNullable focusClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_GEOGRAPHIC_CLASS = "geographicClass";
  private JsonNullable geographicClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_NICHE_CLASS = "nicheClass";
  private JsonNullable nicheClass = JsonNullable.undefined();

  public static final String JSON_PROPERTY_REGION_CLASS = "regionClass";
  private JsonNullable regionClass = JsonNullable.undefined();

  public Classifications() { 
  }

  public Classifications fsymId(String fsymId) {
    this.fsymId = JsonNullable.of(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
  **/
  @jakarta.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.")
  @JsonIgnore

  public String getFsymId() {
        return fsymId.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_FSYM_ID)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getFsymId_JsonNullable() {
    return fsymId;
  }
  
  @JsonProperty(JSON_PROPERTY_FSYM_ID)
  public void setFsymId_JsonNullable(JsonNullable fsymId) {
    this.fsymId = fsymId;
  }

  public void setFsymId(String fsymId) {
    this.fsymId = JsonNullable.of(fsymId);
  }


  public Classifications requestId(String requestId) {
    this.requestId = requestId;
    return this;
  }

   /**
   * The requested Id sent as input.
   * @return requestId
  **/
  @jakarta.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 Classifications assetClass(String assetClass) {
    this.assetClass = JsonNullable.of(assetClass);
    return this;
  }

   /**
   * Returns the asset class description from FactSet's fund classification system. Asset class designates the fund's underlying holding type, e.g. equity, fixed-income, etc.
   * @return assetClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "Equity", value = "Returns the asset class description from FactSet's fund classification system. Asset class designates the fund's underlying holding type, e.g. equity, fixed-income, etc.")
  @JsonIgnore

  public String getAssetClass() {
        return assetClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_ASSET_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getAssetClass_JsonNullable() {
    return assetClass;
  }
  
  @JsonProperty(JSON_PROPERTY_ASSET_CLASS)
  public void setAssetClass_JsonNullable(JsonNullable assetClass) {
    this.assetClass = assetClass;
  }

  public void setAssetClass(String assetClass) {
    this.assetClass = JsonNullable.of(assetClass);
  }


  public Classifications categoryClass(String categoryClass) {
    this.categoryClass = JsonNullable.of(categoryClass);
    return this;
  }

   /**
   * Returns the asset class category description from FactSet's fund classification system. The asset class category is the first-tier subcategory within the fund's asset class, e.g. size & style, sector, precious metals, etc.
   * @return categoryClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "Size and Style", value = "Returns the asset class category description from FactSet's fund classification system. The asset class category is the first-tier subcategory within the fund's asset class, e.g. size & style, sector, precious metals, etc.")
  @JsonIgnore

  public String getCategoryClass() {
        return categoryClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_CATEGORY_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getCategoryClass_JsonNullable() {
    return categoryClass;
  }
  
  @JsonProperty(JSON_PROPERTY_CATEGORY_CLASS)
  public void setCategoryClass_JsonNullable(JsonNullable categoryClass) {
    this.categoryClass = categoryClass;
  }

  public void setCategoryClass(String categoryClass) {
    this.categoryClass = JsonNullable.of(categoryClass);
  }


  public Classifications economicDevelopmentClass(String economicDevelopmentClass) {
    this.economicDevelopmentClass = JsonNullable.of(economicDevelopmentClass);
    return this;
  }

   /**
   * Returns the fund's economic development description from FactSet's fund classification system. This description refers to the development level for the fund's geographic region of focus, e.g. developed, emerging, etc.
   * @return economicDevelopmentClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "Developed Markets", value = "Returns the fund's economic development description from FactSet's fund classification system. This description refers to the development level for the fund's geographic region of focus, e.g. developed, emerging, etc.")
  @JsonIgnore

  public String getEconomicDevelopmentClass() {
        return economicDevelopmentClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_ECONOMIC_DEVELOPMENT_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getEconomicDevelopmentClass_JsonNullable() {
    return economicDevelopmentClass;
  }
  
  @JsonProperty(JSON_PROPERTY_ECONOMIC_DEVELOPMENT_CLASS)
  public void setEconomicDevelopmentClass_JsonNullable(JsonNullable economicDevelopmentClass) {
    this.economicDevelopmentClass = economicDevelopmentClass;
  }

  public void setEconomicDevelopmentClass(String economicDevelopmentClass) {
    this.economicDevelopmentClass = JsonNullable.of(economicDevelopmentClass);
  }


  public Classifications focusClass(String focusClass) {
    this.focusClass = JsonNullable.of(focusClass);
    return this;
  }

   /**
   * Returns the fund's focus description from FactSet's fund classification system. The fund's focus is the second-tier subcategory within the fund's asset class, e.g. small cap, energy, etc.
   * @return focusClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "Total Market", value = "Returns the fund's focus description from FactSet's fund classification system. The fund's focus is the second-tier subcategory within the fund's asset class, e.g. small cap, energy, etc.")
  @JsonIgnore

  public String getFocusClass() {
        return focusClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_FOCUS_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getFocusClass_JsonNullable() {
    return focusClass;
  }
  
  @JsonProperty(JSON_PROPERTY_FOCUS_CLASS)
  public void setFocusClass_JsonNullable(JsonNullable focusClass) {
    this.focusClass = focusClass;
  }

  public void setFocusClass(String focusClass) {
    this.focusClass = JsonNullable.of(focusClass);
  }


  public Classifications geographicClass(String geographicClass) {
    this.geographicClass = JsonNullable.of(geographicClass);
    return this;
  }

   /**
   * Returns the fund's specific geography description from FactSet's fund classification system. Specific geography refers to the fund's particular geographic focus within the region, e.g. Chile, BRICs, etc.
   * @return geographicClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "U.S.", value = "Returns the fund's specific geography description from FactSet's fund classification system. Specific geography refers to the fund's particular geographic focus within the region, e.g. Chile, BRICs, etc.")
  @JsonIgnore

  public String getGeographicClass() {
        return geographicClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_GEOGRAPHIC_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getGeographicClass_JsonNullable() {
    return geographicClass;
  }
  
  @JsonProperty(JSON_PROPERTY_GEOGRAPHIC_CLASS)
  public void setGeographicClass_JsonNullable(JsonNullable geographicClass) {
    this.geographicClass = geographicClass;
  }

  public void setGeographicClass(String geographicClass) {
    this.geographicClass = JsonNullable.of(geographicClass);
  }


  public Classifications nicheClass(String nicheClass) {
    this.nicheClass = JsonNullable.of(nicheClass);
    return this;
  }

   /**
   * Returns the fund's niche description from FactSet's fund classification system. The fund's niche is the third-tier subcategory with the fund's asset class, e.g. growth, coal, etc.
   * @return nicheClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "Value", value = "Returns the fund's niche description from FactSet's fund classification system. The fund's niche is the third-tier subcategory with the fund's asset class, e.g. growth, coal, etc.")
  @JsonIgnore

  public String getNicheClass() {
        return nicheClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_NICHE_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getNicheClass_JsonNullable() {
    return nicheClass;
  }
  
  @JsonProperty(JSON_PROPERTY_NICHE_CLASS)
  public void setNicheClass_JsonNullable(JsonNullable nicheClass) {
    this.nicheClass = nicheClass;
  }

  public void setNicheClass(String nicheClass) {
    this.nicheClass = JsonNullable.of(nicheClass);
  }


  public Classifications regionClass(String regionClass) {
    this.regionClass = JsonNullable.of(regionClass);
    return this;
  }

   /**
   * Returns the fund's region description from FactSet's fund classification system. Refers to the broad regional exposure of the fund's holdings, e.g. Latin America, Asia-Pacific, etc.
   * @return regionClass
  **/
  @jakarta.annotation.Nullable
  @ApiModelProperty(example = "North America", value = "Returns the fund's region description from FactSet's fund classification system. Refers to the broad regional exposure of the fund's holdings, e.g. Latin America, Asia-Pacific, etc.")
  @JsonIgnore

  public String getRegionClass() {
        return regionClass.orElse(null);
  }

  @JsonProperty(JSON_PROPERTY_REGION_CLASS)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public JsonNullable getRegionClass_JsonNullable() {
    return regionClass;
  }
  
  @JsonProperty(JSON_PROPERTY_REGION_CLASS)
  public void setRegionClass_JsonNullable(JsonNullable regionClass) {
    this.regionClass = regionClass;
  }

  public void setRegionClass(String regionClass) {
    this.regionClass = JsonNullable.of(regionClass);
  }


  /**
   * Return true if this classifications object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Classifications classifications = (Classifications) o;
    return equalsNullable(this.fsymId, classifications.fsymId) &&
        Objects.equals(this.requestId, classifications.requestId) &&
        equalsNullable(this.assetClass, classifications.assetClass) &&
        equalsNullable(this.categoryClass, classifications.categoryClass) &&
        equalsNullable(this.economicDevelopmentClass, classifications.economicDevelopmentClass) &&
        equalsNullable(this.focusClass, classifications.focusClass) &&
        equalsNullable(this.geographicClass, classifications.geographicClass) &&
        equalsNullable(this.nicheClass, classifications.nicheClass) &&
        equalsNullable(this.regionClass, classifications.regionClass);
  }

  private static  boolean equalsNullable(JsonNullable a, JsonNullable b) {
    return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
  }

  @Override
  public int hashCode() {
    return Objects.hash(hashCodeNullable(fsymId), requestId, hashCodeNullable(assetClass), hashCodeNullable(categoryClass), hashCodeNullable(economicDevelopmentClass), hashCodeNullable(focusClass), hashCodeNullable(geographicClass), hashCodeNullable(nicheClass), hashCodeNullable(regionClass));
  }

  private static  int hashCodeNullable(JsonNullable a) {
    if (a == null) {
      return 1;
    }
    return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class Classifications {\n");
    sb.append("    fsymId: ").append(toIndentedString(fsymId)).append("\n");
    sb.append("    requestId: ").append(toIndentedString(requestId)).append("\n");
    sb.append("    assetClass: ").append(toIndentedString(assetClass)).append("\n");
    sb.append("    categoryClass: ").append(toIndentedString(categoryClass)).append("\n");
    sb.append("    economicDevelopmentClass: ").append(toIndentedString(economicDevelopmentClass)).append("\n");
    sb.append("    focusClass: ").append(toIndentedString(focusClass)).append("\n");
    sb.append("    geographicClass: ").append(toIndentedString(geographicClass)).append("\n");
    sb.append("    nicheClass: ").append(toIndentedString(nicheClass)).append("\n");
    sb.append("    regionClass: ").append(toIndentedString(regionClass)).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    ");
  }

}