Class TradeConfPartsDef.CommonTradeConfirmationFields

java.lang.Object
com.caplin.generated.motif.mm.tradeconfirmation.TradeConfPartsDef.CommonTradeConfirmationFields
All Implemented Interfaces:
BuilderMessage, Message
Enclosing class:
TradeConfPartsDef

public static final class TradeConfPartsDef.CommonTradeConfirmationFields extends Object implements BuilderMessage
  • Method Details

    • getTOBOUser

      @Nullable public @Nullable String getTOBOUser()
      Returns:
      The client who the trade is for.
    • getTraderUsername

      @Nullable public @Nullable String getTraderUsername()
      Returns:
      The name of the trader providing the price to the user, or NO_TRADER if there is none.
    • getAccount

      @Nullable public @Nullable String getAccount()
      Returns:
      The used account for the trade.
    • getAction

      @Nullable public @Nullable String getAction()
      Returns:
      Withdraw or deposit for Call Deposit.
    • getCallAccount

      @Nullable public @Nullable String getCallAccount()
      Returns:
      The account which is being withdrawn from or deposited to.
    • getCurrency

      @Nullable public @Nullable String getCurrency()
      Returns:
      The currency in which the trade is made.
    • getMaturityDate

      @Nullable public @Nullable LocalDate getMaturityDate()
      Returns:
      The maturity date of the trade.
    • getMaturityTenor

      @Nullable public @Nullable String getMaturityTenor()
      Returns:
      The maturity tenor of the trade.
    • getStartDate

      @Nullable public @Nullable LocalDate getStartDate()
      Returns:
      The start date of the trade.
    • getStartTenor

      @Nullable public @Nullable String getStartTenor()
      Returns:
      The start tenor of the trade.
    • getTradeID

      @Nullable public @Nullable String getTradeID()
      Returns:
      The unique id identifying the trade.
    • getPrincipalAmount

      @Nullable public @Nullable BigDecimal getPrincipalAmount()
      Returns:
      Principal amount for the trade specified in the provided Currency.
    • getInterestRate

      @Nullable public @Nullable BigDecimal getInterestRate()
      Returns:
      Interest rate on the given PrincipalAmount.
    • getIndicativeProfitRate

      @Nullable public @Nullable String getIndicativeProfitRate()
      Returns:
      Indicative profit rate on the given PrincipalAmount.
    • getInterestRateDPS

      @Nullable public @Nullable BigDecimal getInterestRateDPS()
      Returns:
      The precision for a specified InterestRate.
    • getInterestAmount

      @Nullable public @Nullable BigDecimal getInterestAmount()
      Returns:
      Interest amount (specified in the provided Currency) calculated from the interest rate and principal amount.
    • getPrincipalPlusInterest

      @Nullable public @Nullable BigDecimal getPrincipalPlusInterest()
      Returns:
      Composite amount between principal amount and interest amount.
    • getPaymentFrequency

      @Nullable public @Nullable String getPaymentFrequency()
      Returns:
      Interest payment frequencies for term deposits, this could be ZERO-COUPON, MONTHLY, QUARTERLY, SEMI-ANNUALLY or ANNUALLY.
    • getAllocationMode

      @Nullable public @Nullable String getAllocationMode()
      Returns:
      Determines whether the amount will be alLocated to a single or multiple accounts. Supported types are [SINGLE, MULTIPLE] and is defaulted to SINGLE.
    • getNumberOfDays

      @Nullable public @Nullable String getNumberOfDays()
      Returns:
      The number of days between the start and maturity dates.
    • getExecutionDateTime

      @Nullable public @Nullable String getExecutionDateTime()
      Returns:
      executionDateTime e.g. 20160322123621
    • getEntityId

      @Nullable public @Nullable String getEntityId()
      Returns:
      The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.
    • getEntityDescription

      @Nullable public @Nullable String getEntityDescription()
      Returns:
      The description of a trade on behalf of entity.
    • getTradeDate

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

      @Nullable public @Nullable String getTradingType()
      Returns:
      The type of the trade. Supported types are [LOAN, DEPOSIT, CALL-DEPOSIT, TERM-DEPOSIT, FLEXI-NOTICE-DEPOSIT, TREASURY-BILL or GOVERNMENT-BOND].
    • getQuoteID

      @Nullable public @Nullable String getQuoteID()
      Returns:
      Unique id for a quote, used to determine which quote has been used for trade execution.
    • getQuoteDateTime

      @Nullable public @Nullable String getQuoteDateTime()
      Returns:
      quoteDateTime e.g. 20160314013000
    • getCanAffirm

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

      @Nullable public @Nullable String getDisplayFields()
      Returns:
      Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.
    • getCanCapitalIncrease

      @Nullable public @Nullable Boolean getCanCapitalIncrease()
      Returns:
      Ability to Capital Increase the Trade amount.
    • getCanRollOver

      @Nullable public @Nullable Boolean getCanRollOver()
      Returns:
      Ability to Roll Over the Trade amount.
    • getCanChangeSSI

      @Nullable public @Nullable Boolean getCanChangeSSI()
      Returns:
      Ability to Change the Settlement Instructions.
    • getCanGiveNotice

      @Nullable public @Nullable Boolean getCanGiveNotice()
      Returns:
      Ability to Give notice for Money Market trades.
    • getHasPostTradeHistory

      @Nullable public @Nullable Boolean getHasPostTradeHistory()
      Returns:
      Define whether post-trade history (related deals) is available.
    • getNoticePeriodDescription

      @Nullable public @Nullable String getNoticePeriodDescription()
      Returns:
      The notice period description for the trade, sent as the raw display value or a translation token.
    • getNoticePeriod

      @Nullable public @Nullable String getNoticePeriod()
      Returns:
      The notice period for the trade.
    • getIsShariaTrade

      @Nullable public @Nullable Boolean getIsShariaTrade()
      Returns:
      Indicates whether the trade is a Sharia trade
    • getCanConfirm

      @Nullable public @Nullable Boolean getCanConfirm()
      Returns:
      Ability to Confirm the Settlement Details are now final.
    • getConfirmedBy

      @Nullable public @Nullable String getConfirmedBy()
      Returns:
      The name of the user who confirmed a trade.
    • getTags

      @Nullable public @Nullable String getTags()
      Returns:
      Tags for a trade.
    • getConfirmedDateTime

      @Nullable public @Nullable Instant getConfirmedDateTime()
      Returns:
      The time at which a trade was confirmed in ISO-8601 format
    • 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()