Package markets.alpaca.client.openapi.data.model

Class Reorganization

java.lang.Object
markets.alpaca.client.openapi.data.model.Reorganization
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Reorganization extends Object implements Serializable
Reorganization (cash and/or multiple stock allocations).
See Also:

  • Field Details

  • Constructor Details

    • Reorganization

      public Reorganization()

  • Method Details

    • cashRate

      public Reorganization cashRate(@Nullable Double cashRate)

    • getCashRate

      @Nullable public Double getCashRate()
      Get cashRate
      Returns:
      cashRate

    • setCashRate

      public void setCashRate(@Nullable Double cashRate)

    • currency

      public Reorganization currency(@Nullable String currency)

    • getCurrency

      @Nullable public String getCurrency()
      The ISO 4217 currency code associated with the corporate action. Empty value can mean USD, non-applicable (e.g. for name changes) or unknown (can change later to a valid currency).
      Returns:
      currency

    • setCurrency

      public void setCurrency(@Nullable String currency)

    • cusip

      public Reorganization cusip(@Nonnull String cusip)

    • getCusip

      @Nonnull public String getCusip()
      Get cusip
      Returns:
      cusip

    • setCusip

      public void setCusip(@Nonnull String cusip)

    • effectiveDate

      public Reorganization effectiveDate(@Nonnull LocalDate effectiveDate)

    • getEffectiveDate

      @Nonnull public LocalDate getEffectiveDate()
      The effective date marks the cutoff point for shareholders to be credited.
      Returns:
      effectiveDate

    • setEffectiveDate

      public void setEffectiveDate(@Nonnull LocalDate effectiveDate)

    • id

      public Reorganization id(@Nonnull UUID id)

    • getId

      @Nonnull public UUID getId()
      The internal Alpaca identifier of the corporate action.
      Returns:
      id

    • setId

      public void setId(@Nonnull UUID id)

    • isin

      public Reorganization isin(@Nullable String isin)

    • getIsin

      @Nullable public String getIsin()
      Get isin
      Returns:
      isin

    • setIsin

      public void setIsin(@Nullable String isin)

    • payableDate

      public Reorganization payableDate(@Nullable LocalDate payableDate)

    • getPayableDate

      @Nullable public LocalDate getPayableDate()
      The date when the corporate action benefit is paid or distributed.
      Returns:
      payableDate

    • setPayableDate

      public void setPayableDate(@Nullable LocalDate payableDate)

    • processDate

      public Reorganization processDate(@Nonnull LocalDate processDate)

    • getProcessDate

      @Nonnull public LocalDate getProcessDate()
      The date when the corporate action is processed by Alpaca.
      Returns:
      processDate

    • setProcessDate

      public void setProcessDate(@Nonnull LocalDate processDate)

    • stockMovements

      public Reorganization stockMovements(@Nullable List<ReorganizationStockMovement> stockMovements)

    • addStockMovementsItem

      public Reorganization addStockMovementsItem(ReorganizationStockMovement stockMovementsItem)

    • getStockMovements

      @Nullable public List<ReorganizationStockMovement> getStockMovements()
      Get stockMovements
      Returns:
      stockMovements

    • setStockMovements

      public void setStockMovements(@Nullable List<ReorganizationStockMovement> stockMovements)

    • symbol

      public Reorganization symbol(@Nonnull String symbol)

    • getSymbol

      @Nonnull public String getSymbol()
      Get symbol
      Returns:
      symbol

    • setSymbol

      public void setSymbol(@Nonnull String symbol)

    • putAdditionalProperty

      public Reorganization putAdditionalProperty(String key, Object value)
      Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
      Parameters:
      key - name of the property
      value - value of the property
      Returns:
      the Reorganization instance itself

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
      Return the additional (undeclared) property.
      Returns:
      a map of objects

    • getAdditionalProperty

      public Object getAdditionalProperty(String key)
      Return the additional (undeclared) property with the specified name.
      Parameters:
      key - name of the property
      Returns:
      an object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • validateJsonElement

      public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOException
      Validates the JSON Element and throws an exception if issues found
      Parameters:
      jsonElement - JSON Element
      Throws:
      IOException - if the JSON Element is invalid with respect to Reorganization

    • fromJson

      public static Reorganization fromJson(String jsonString) throws IOException
      Create an instance of Reorganization given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of Reorganization
      Throws:
      IOException - if the JSON string is invalid with respect to Reorganization

    • toJson

      public String toJson()
      Convert an instance of Reorganization to an JSON string
      Returns:
      JSON string