Package com.caplin.generated.motif.fx.tradeconfirmation

Class TradeConfPartsDef.LegTradeConfirmationFields

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

  • Method Details

    • getTradeID

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

    • getAllInRate

      @Nullable public @Nullable BigDecimal getAllInRate()
      Returns:
      The final client rate that is made up of the spot rate + any additional costs or adjustments such as swap points or margin.

    • getAllInRateDPS

      @Nullable public @Nullable Integer getAllInRateDPS()
      Returns:
      The number of decimal places to display after the decimal point.

    • getAllInMidRate

      @Nullable public @Nullable BigDecimal getAllInMidRate()
      Returns:
      The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getFwdPoints

      @Nullable public @Nullable BigDecimal getFwdPoints()
      Returns:
      The number of pips to be added or subtracted from the spot rate to form the forward rate.

    • getFwdMidPoints

      @Nullable public @Nullable BigDecimal getFwdMidPoints()
      Returns:
      The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.

    • getFwdPips

      @Deprecated @Nullable public @Nullable String getFwdPips()
      Deprecated.
      Returns:
      fwdPips e.g. 11.98

    • getBuySell

      @Nullable public @Nullable String getBuySell()
      Returns:
      The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

    • getAmount

      @Nullable public @Nullable BigDecimal getAmount()
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • getContraAmount

      @Nullable public @Nullable BigDecimal getContraAmount()
      Returns:
      The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.

    • getTenor

      @Nullable public @Nullable String getTenor()
      Returns:
      Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.

    • getSettlementDate

      @Nullable public @Nullable String getSettlementDate()
      Returns:
      The date on which the two currencies in the FX trade are exchanged. Can be a tenor or a broken date, i.e. SPOT or 20160314.

    • getFilledAmount

      @Nullable public @Nullable BigDecimal getFilledAmount()
      Returns:
      The amount filled on an order, or the amount filled on a time option trade after performing a drawdown(s).

    • getRemainingAmount

      @Nullable public @Nullable BigDecimal getRemainingAmount()
      Returns:
      The amount remaining on a trade or order which can reduce after performing a post trade action/an order is filled.

    • getRiskDate

      @Nullable public @Nullable String getRiskDate()
      Returns:
      The date in the settlement window which yields the lowest client sell price, or the highest client buy price.

    • getRiskTenor

      @Nullable public @Nullable String getRiskTenor()
      Returns:
      The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.

    • getStartDate

      @Nullable public @Nullable String getStartDate()
      Returns:
      The date of which the time option becomes active from.

    • getStartTenor

      @Nullable public @Nullable String getStartTenor()
      Returns:
      The tenor of which the time option becomes active from.

    • getIsTimeOption

      @Nullable public @Nullable Boolean getIsTimeOption()
      Returns:
      true if a leg is time-option

    • getAccount

      @Nullable public @Nullable String getAccount()
      Returns:
      The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

    • getProfit

      @Nullable public @Nullable BigDecimal getProfit()
      Returns:
      The sales profit in the specified currency.

    • getCostAmount

      @Nullable public @Nullable BigDecimal getCostAmount()
      Returns:
      The actual transactional cost of performing the trade to the client in the home currency

    • 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.

    • getCostCurrency

      @Nullable public @Nullable String getCostCurrency()
      Returns:
      The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

    • getCostPercentage

      @Nullable public @Nullable BigDecimal getCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.

    • getContraCostAmount

      @Nullable public @Nullable BigDecimal getContraCostAmount()
      Returns:
      The actual transactional cost of performing the trade to the client on the contra currency

    • getContraCostCurrency

      @Nullable public @Nullable String getContraCostCurrency()
      Returns:
      The contra currency that the cost is displayed in

    • getContraCostPercentage

      @Nullable public @Nullable BigDecimal getContraCostPercentage()
      Returns:
      Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.

    • getServiceContraCostAmount

      @Nullable public @Nullable BigDecimal getServiceContraCostAmount()
      Returns:
      The actual service cost of performing the trade to the client on the contra currency

    • getServiceContraCostCurrency

      @Nullable public @Nullable String getServiceContraCostCurrency()
      Returns:
      The service contra currency that the cost is displayed in

    • getServiceCostAmount

      @Nullable public @Nullable BigDecimal getServiceCostAmount()
      Returns:
      The actual service cost of performing the trade to the client on the home currency

    • getServiceCostCurrency

      @Nullable public @Nullable String getServiceCostCurrency()
      Returns:
      The service home currency that the cost is displayed in

    • getTOBOUser

      @Nullable public @Nullable String getTOBOUser()
      Returns:
      The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.

    • getFullName

      @Nullable public @Nullable String getFullName()
      Returns:
      The full name of the user the trade is on behalf of

    • getForwardPointsDecimalOffset

      @Nullable public @Nullable Integer getForwardPointsDecimalOffset()
      Returns:
      Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.

    • getAllocatableAmount

      @Nullable public @Nullable BigDecimal getAllocatableAmount()
      Returns:
      This is the amount that can be allocated or rolled.

    • getAllocatableContraAmount

      @Nullable public @Nullable BigDecimal getAllocatableContraAmount()
      Returns:
      This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency

    • getOriginalRate

      @Nullable public @Nullable BigDecimal getOriginalRate()
      Returns:
      The Rate of the trade that this trade was created from.

    • getAdjustedSwapPoints

      @Nullable public @Nullable BigDecimal getAdjustedSwapPoints()
      Returns:
      The swap points adjusted for this repriced trade

    • getSettlementTradeFields

      @NotNull public SettlementInstructionsPartsDef.SettlementTradeFields getSettlementTradeFields()
      Returns:
      settlementTradeFields

    • getNostroAccountFields

      @NotNull public SettlementInstructionsPartsDef.NostroAccount getNostroAccountFields()
      Returns:
      nostroAccountFields

    • getRemarks

      @Nullable public @Nullable TradeConfPartsDef.RemarksEntry getRemarks(int id)
      Returns:
      remarks

    • getNumRemarks

      @Nullable public @org.jetbrains.annotations.Nullable int getNumRemarks()

    • 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.LegTradeConfirmationFields from(@NotNull @NotNull Map<String,String> fields)

    • from

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

    • newBuilder

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