Package com.caplin.generated.motif.commodities.tradeconfirmation

Class TradeConfPartsDef.CommonTradeConfirmationFields

java.lang.Object
com.caplin.generated.motif.commodities.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields
All Implemented Interfaces:
BuilderMessage, Message
Enclosing class:
TradeConfPartsDef
public static final class TradeConfPartsDef.CommonTradeConfirmationFields extends Object implements BuilderMessage

  • Method Details

    • getTradingType

      @Nullable public @Nullable String getTradingType()
      Returns:
      Caplin supported values are [FIXED_SWAP, BASIS_SWAP, EURO_PUT, EURO_CALL, EURO_COLLAR, EURO_3_WAY_COLLAR, EURO_CALL_SPREAD, ASIAN_CAP, ASIAN_FLOOR, ASIAN_COLLAR, ASIAN_3_WAY_COLLAR, ASIAN_CAP_SPREAD, ASIAN_FLOOR_SPREAD, SPREAD_PUT]. See the constants defined within com.caplin.motif.commodities.trading.CommoditiesTradingType for further details.

    • getCommodity

      @Nullable public @Nullable String getCommodity()
      Returns:
      The commodity of the trade.

    • getTradeID

      @Nullable public @Nullable String getTradeID()
      Returns:
      A unique identifier for this trade.

    • getEffectiveDate

      @Nullable public @Nullable String getEffectiveDate()
      Returns:
      The date the trade comes into effect.

    • getTerminationDate

      @Nullable public @Nullable String getTerminationDate()
      Returns:
      The termination date of the trade.

    • getTradeDate

      @Nullable public @Nullable String getTradeDate()
      Returns:
      tradeDate e.g. 20160314

    • getReferencePrice

      @Nullable public @Nullable BigDecimal getReferencePrice()
      Returns:
      The reference price of the traded commodity

    • getPricingDate

      @Nullable public @Nullable String getPricingDate()
      Returns:
      The date the price was generated on.

    • getPaymentDate

      @Nullable public @Nullable String getPaymentDate()
      Returns:
      The date by when the payment needs to be done.

    • getLEI

      @Nullable public @Nullable String getLEI()
      Returns:
      Legal entity identifier, unique number to identify the entity engaging in a financial transaction.

    • getUPI

      @Nullable public @Nullable String getUPI()
      Returns:
      Unique product identifier, similar to USI/UTI but at product level not transaction level.

    • getDealBreakdown

      @Nullable public @Nullable String getDealBreakdown()
      Returns:
      A JSON structure containing all the individual deals of a commodities trade. Use DefaultTableFields builders to provide Caplin default and/or custom fields.

    • getSettlementStatus

      @Nullable public @Nullable String getSettlementStatus()
      Returns:
      Caplin supported statuses are [PENDING, AFFIRMED, CONFIRMED, DISPUTED, CANCELLED, REPLACED, AUTO_CONFIRMED, OVERDUE, REJECTED]

    • getNextActionDeadline

      @Nullable public @Nullable Instant getNextActionDeadline()
      Returns:
      The deadline for a user to perform a trade's next action in ISO-8601 format

    • getNextActionDeadlineDisplayTimezone

      @Nullable public @Nullable String getNextActionDeadlineDisplayTimezone()
      Returns:
      The timezone for the NextActionDeadline field in the form Area/Location

    • getTOBOUser

      @Nullable public @Nullable String getTOBOUser()
      Returns:
      The user the trade is on behalf of.

    • getEntityDescription

      @Nullable public @Nullable String getEntityDescription()
      Returns:
      The entity the trade is on behalf of.

    • getMarket

      @Nullable public @Nullable String getMarket()
      Returns:
      market e.g. Metals

    • getCanAffirm

      @Nullable public @Nullable Boolean getCanAffirm()
      Returns:
      Ability to Affirm the Trade Details are as agreed.

    • getUnit

      @Nullable public @Nullable String getUnit()
      Returns:
      unit e.g. bbl

    • getCurrency

      @Nullable public @Nullable String getCurrency()
      Returns:
      The currency the transaction has been made in.

    • getTotalPremium

      @Nullable public @Nullable BigDecimal getTotalPremium()
      Returns:
      The total premiums of deal breakdown. When there is no deal breakdown present it will be the actual premium paid for the deal.

    • getFields

      @NotNull public @NotNull Map<String,String> getFields()
      Specified by:
      getFields in interface Message

    • getFieldFlags

      @NotNull public @NotNull Map<String,Collection<String>> getFieldFlags()
      Specified by:
      getFieldFlags in interface BuilderMessage
      Returns:
      Get the flags for all fields.

    • getFlagFields

      @NotNull public @NotNull Map<String,Collection<String>> getFlagFields()
      Specified by:
      getFlagFields in interface BuilderMessage
      Returns:
      Get the fields for all flags.

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Object

    • from

      @NotNull public static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields from(@NotNull @NotNull Map<String,String> fields)

    • from

      @NotNull public static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields from(@NotNull @NotNull Map<String,String> fields, @NotNull @NotNull String fieldPrefix)

    • newBuilder

      @NotNull public static @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder newBuilder()