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

Class TradeConfPartsDef.CommonTradeConfirmationFields

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

  • Method Details

    • getAllowedAllocationTypes

      @Nullable public @Nullable String getAllowedAllocationTypes()
      Returns:
      Comma separated string of allowed allocation types.

    • getTradeID

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

    • getCurrencyPair

      @Nullable public @Nullable String getCurrencyPair()
      Returns:
      The currency pair for the trade. For example, EURUSD

    • getDealtCurrency

      @Nullable public @Nullable String getDealtCurrency()
      Returns:
      The currency of the Amount of a trade or order.

    • getSpotRate

      @Nullable public @Nullable BigDecimal getSpotRate()
      Returns:
      The rate for trading two currencies on the spot settlement date.

    • getSpotMidRate

      @Nullable public @Nullable BigDecimal getSpotMidRate()
      Returns:
      The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

    • getSpotRateDPS

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

    • getExecutionDateTime

      @Nullable public @Nullable String getExecutionDateTime()
      Returns:
      The date and time a trade was executed on.

    • getTradeDate

      @Nullable public @Nullable String getTradeDate()
      Returns:
      The date a trade was executed on.

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

    • getTraderUsername

      @Nullable public @Nullable String getTraderUsername()
      Returns:
      The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. 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 dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.

    • 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

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

    • getAssetType

      @Nullable public @Nullable String getAssetType()
      Returns:
      A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]

    • getTradingType

      @Nullable public @Nullable String getTradingType()
      Returns:
      Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.

    • getDeliverableType

      @Nullable public @Nullable String getDeliverableType()
      Returns:
      Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)

    • getDigitsBeforePips

      @Nullable public @Nullable Integer getDigitsBeforePips()
      Returns:
      Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this field will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.

    • getNumberOfPips

      @Nullable public @Nullable Integer getNumberOfPips()
      Returns:
      Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.

    • getOrderID

      @Nullable public @Nullable String getOrderID()
      Returns:
      The id of the order.

    • getWarningCode

      @Nullable public @Nullable String getWarningCode()
      Returns:
      The code for the warning regarding a quote request.

    • getWarningMessage

      @Nullable public @Nullable String getWarningMessage()
      Returns:
      The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.

    • getDetailedWarningMessage

      @Nullable public @Nullable String getDetailedWarningMessage()
      Returns:
      detailedWarningMessage e.g. color: {{theme:foreground.semantic.warning_inverse}}

    • getClient

      @Deprecated @Nullable public @Nullable String getClient()
      Deprecated.
      Returns:
      Client is a duplicate of TOBOUser

    • getCostAmount

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

    • 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

    • getCostCurrencyDPS

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

    • 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

    • getContraCostCurrencyDPS

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

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

    • getServiceCostCurrencyDPS

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

    • getServiceContraCostCurrencyDPS

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

    • getCanAllocate

      @Nullable public @Nullable String getCanAllocate()
      Returns:
      Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL

    • getCanDrawdown

      @Nullable public @Nullable Boolean getCanDrawdown()
      Returns:
      Ability to Drawdown a time option trade.

    • getAllocationSettlementDateOptions

      @Deprecated @Nullable public @Nullable String getAllocationSettlementDateOptions()
      Deprecated.
      Returns:
      Comma-separated list, defines available settlement dates for an allocation.

    • getIsAllocated

      @Deprecated @Nullable public @Nullable Boolean getIsAllocated()
      Deprecated.
      Returns:
      Deprecated, use HasPostTradeHistory instead.

    • getHasPostTradeHistory

      @Nullable public @Nullable Boolean getHasPostTradeHistory()
      Returns:
      Define whether post-trade history (related deals e.g. drawdowns, allocations, early take ups and roll overs) is available.

    • getIsReversible

      @Nullable public @Nullable Boolean getIsReversible()
      Returns:
      Whether a trade can be reversed.

    • getIsAmendable

      @Nullable public @Nullable Boolean getIsAmendable()
      Returns:
      Whether a trade can be amended.

    • getIsCancellable

      @Nullable public @Nullable Boolean getIsCancellable()
      Returns:
      Whether a trade can be cancelled.

    • getAmountDPS

      @Nullable public @Nullable Integer getAmountDPS()
      Returns:
      The precision for a specified currency pair and dealt currency

    • getContraAmountDPS

      @Nullable public @Nullable Integer getContraAmountDPS()
      Returns:
      The precision for a specified currency pair and contra currency

    • getRemarks

      @Nullable public @Nullable String getRemarks()
      Returns:
      The text content of a comment left on a leg of a trade or order, visible to Client and sales and possibly the trader, set/edited by Client or sales

    • getUTI

      @Nullable public @Nullable String getUTI()
      Returns:
      Unique Transaction Identifier.

    • getBackOfficeID

      @Nullable public @Nullable String getBackOfficeID()
      Returns:
      Back office trade identifier.

    • getPriceSource

      @Nullable public @Nullable String getPriceSource()
      Returns:
      Identifies the person or system that priced the trade.

    • getVenue

      @Nullable public @Nullable String getVenue()
      Returns:
      Where the trade was placed.

    • getPurpose

      @Nullable public @Nullable String getPurpose()
      Returns:
      The purpose of a trade.

    • getTags

      @Nullable public @Nullable String getTags()
      Returns:
      Tags for a trade (see also `com.caplin.motif.fx.config.DefaultTag`) or order (see also `com.caplin.motif.fx.orders.DefaultOrderTag`).

    • getClientAgreementDateTime

      @Nullable public @Nullable Instant getClientAgreementDateTime()
      Returns:
      Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different

    • getPostTradeType

      @Nullable public @Nullable String getPostTradeType()
      Returns:
      The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION, DRAWDOWN

    • getIsRepriceTrade

      @Nullable public @Nullable Boolean getIsRepriceTrade()
      Returns:
      Boolean flag that indicates whether the trade was created from a Post Trade Action, where a new price was executed against.

    • getOriginalTradeID

      @Nullable public @Nullable String getOriginalTradeID()
      Returns:
      TradeID of the trade that this trade was created from.

    • getStatus

      @Nullable public @Nullable String getStatus()
      Returns:
      Status of the trade. Frontends may use this value for display purpose, but no logic is associated with it. Use Can* flags to drive post-trade logic.

    • getNaturalLanguageSummaryHidden

      @Nullable public @Nullable Boolean getNaturalLanguageSummaryHidden()
      Returns:
      When true, the natural language summary will be hidden on the RFS ticket summary.

    • getIsCommercial

      @Nullable public @Nullable Boolean getIsCommercial()
      Returns:
      Indicates whether the given trade is commercial or not

    • 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()