Class QuotePartsDef.CommonFields
java.lang.Object
com.caplin.generated.motif.fx.rates.QuotePartsDef.CommonFields
- All Implemented Interfaces:
BuilderMessage
,Message
- Enclosing class:
- QuotePartsDef
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull QuotePartsDef.CommonFields
static @NotNull QuotePartsDef.CommonFields
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable Boolean
@Nullable String
Deprecated.@Nullable String
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable Boolean
@Nullable String
Deprecated.@Nullable String
@Nullable BigDecimal
@Nullable String
@Nullable BigDecimal
@Nullable String
@Nullable Integer
@Nullable String
@Nullable String
@Nullable Integer
@NotNull Map<String,
Collection<String>> @NotNull Map<String,
Collection<String>> @Nullable String
getGFA()
@Nullable String
Deprecated.@Nullable Integer
@Nullable Integer
@Nullable String
@Nullable Integer
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable BigDecimal
@Nullable Integer
@Nullable String
Deprecated.@Nullable String
@Nullable String
@Nullable String
static @NotNull QuotePartsDef.CommonFields.Builder
@NotNull String
toString()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.caplin.motif.datasource.BuilderMessage
getFieldFlags, getFlagFields
-
Method Details
-
getBidQuoteID
- Returns:
- A unique ID that identifies the bid side of this quote.
-
getAskQuoteID
- Returns:
- A unique ID that identifies the ask side of this quote.
-
getBidIndicative
- Returns:
- Determines whether the Bid price is indicative. Indicative prices cannot be executed upon
-
getAskIndicative
- Returns:
- Determines whether the Ask price is indicative. Indicative prices cannot be executed upon
-
getGFA
- Returns:
- The maximum amount that a quote can be executed for. If the client wishes to quote for more than this, they must perform an RFS
-
getTimePriceReceived
- Returns:
- The time the price is received from the liquidity provider, in epoch milliseconds.
-
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
- 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.
-
getSpotBidRate
- Returns:
- For SPOT quotes this value will be identical to the L1_AllInBidRate. For forward quotes this will contain the SPOT rate that the forward all-in rate was derived from. For forward quotes the value in this field should always equal L1_AllInBidRate - L1_FwdBidPoints.
-
getSpotMidRate
- Returns:
- The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.
-
getSpotAskRate
- Returns:
- For SPOT quotes this value will be identical to the L1_AllInAskRate. For forward quotes this will contain the SPOT rate that the forward all-in rate was derived from. For forward quotes the value in this field should always equal L1_AllInAskRate - L1_FwdAskPoints.
-
getSpotRateDPS
- Returns:
- The number of decimal places to display after the decimal point.
-
getOverallTimeOut
- Returns:
- The number of seconds remaining before this stream (not this individual quote) is timed out. This is not present for standard price updates.
-
getRemainingTimeOutMillis
- Returns:
- The number of seconds remaining of the OverallTimeOut before this stream is timed out. This is not present for standard price updates.
-
getWarningCode
- Returns:
- The code for the warning regarding a quote request.
-
getWarningMessage
- Returns:
- The message to display for any warnings regarding a quote request. Supports Markdown syntax for formatting.
-
getDetailedWarningMessage
- Returns:
- detailedWarningMessage e.g. color: {{theme:foreground.semantic.warning_inverse}}
-
getNumberOfFractionalPips
Deprecated.- Returns:
- Precision-related field that tells the client how to display rates. This is the number of digits after the pips. For example, for a USDGBP rate of 1.23456 the pips are the 45 and there is one digit (the 6) after the pips, so the value of the NumberOfFractionalPips field should be 1. There are typically more fractional pips on forward rates than spot rates.
-
getBidPips
Deprecated.- Returns:
- bidPips e.g. 11.98
-
getAskPips
Deprecated.- Returns:
- askPips e.g. 11.98
-
getSwapGFA
Deprecated.- Returns:
- swapGFA e.g. 1 000 000
-
getCurrencyPair
- Returns:
- The currency pair for the trade. For example, EURUSD
-
getBidCostAmount
- Returns:
- The total amount on the bid side of the trade when requesting a quote
-
getBidCostPercentage
- Returns:
- Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the bid side. This number should be out of 100, where 100.0 represents 100%.
-
getCostCurrency
- Returns:
- The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency
-
getAskCostAmount
- Returns:
- The total amount on the ask side of the trade when requesting a quote
-
getAskCostPercentage
- Returns:
- Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the ask side. This number should be out of 100, where 100.0 represents 100%.
-
getAskCostRate
- Returns:
- The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.
-
getBidCostRate
- Returns:
- The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.
-
getCostCurrencyDPS
- Returns:
- The number of decimal places to display after the decimal point.
-
getPriceUpdateSource
- Returns:
- The name of the adapter a particular price update originated from.
-
getAskContraCostAmount
- Returns:
- The total amount on the ask side of the trade when requesting a quote seen in contra currency
-
getAskContraCostPercentage
- Returns:
- Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the ask side in contra currency. This number should be out of 100, where 100.0 represents 100%.
-
getAskContraCostRate
- Returns:
- The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.
-
getBidContraCostAmount
- Returns:
- The total amount on the bid side of the trade when requesting a quote seen in contra currency
-
getBidContraCostPercentage
- Returns:
- Percentage of the overall price which is the transactional cost to the client of performing the trade, displayed on the bid side in cost currency. This number should be out of 100, where 100.0 represents 100%.
-
getBidContraCostRate
- Returns:
- The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.
-
getContraCostAmount
- Returns:
- The actual transactional cost of performing the trade to the client on the contra currency
-
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%.
-
getContraCostCurrency
- Returns:
- The contra currency that the cost is displayed in
-
getFields
-
getFieldFlags
- Specified by:
getFieldFlags
in interfaceBuilderMessage
- Returns:
- Get the flags for all fields.
-
getFlagFields
- Specified by:
getFlagFields
in interfaceBuilderMessage
- Returns:
- Get the fields for all flags.
-
toString
-
from
@NotNull public static @NotNull QuotePartsDef.CommonFields from(@NotNull @NotNull Map<String, String> fields) -
from
@NotNull public static @NotNull QuotePartsDef.CommonFields from(@NotNull @NotNull Map<String, String> fields, @NotNull @NotNull String fieldPrefix) -
newBuilder
-