Package com.caplin.generated.motif.fx.rates

Class QuotePartsDef.LegFields

    • Method Detail

      • getTenor

        @Nullable
public @Nullable java.lang.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 a SettlementDate must be sent

      • getRiskDate

        @Nullable
public @Nullable java.lang.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 java.lang.String getRiskTenor()
        Returns:
        The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.

      • getSettlementDate

        @Nullable
public @Nullable java.lang.String getSettlementDate()
        Returns:
        settlementDate

      • getIsTimeOption

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

      • getStartTenor

        @Nullable
public @Nullable java.lang.String getStartTenor()
        Returns:
        startTenor e.g. 1W

      • getStartDate

        @Nullable
public @Nullable java.lang.String getStartDate()
        Returns:
        startDate e.g. 20150620

      • getAllInRateDPS

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

      • getAllInBidRate

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

      • getFwdBidPoints

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

      • getAllInAskRate

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

      • getFwdAskPoints

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

      • getFwdMidPoints

        @Nullable
public @Nullable java.math.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.

      • getFwdBidPips

        @Deprecated
@Nullable
public @Nullable java.lang.String getFwdBidPips()
        Deprecated.
        Returns:
        fwdBidPips e.g. 53.90

      • getFwdAskPips

        @Deprecated
@Nullable
public @Nullable java.lang.String getFwdAskPips()
        Deprecated.
        Returns:
        fwdAskPips e.g. 53.90

      • getAllInMidRate

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

      • getAmount

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

      • getBuySell

        @Nullable
public @Nullable java.lang.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.

      • getCostCurrency

        @Nullable
public @Nullable java.lang.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

      • getBidCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getBidCostAmount()
        Returns:
        The total amount on the bid side of the trade when requesting a quote

      • getBidCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal 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%.

      • getBidCostRate

        @Nullable
public @Nullable java.math.BigDecimal getBidCostRate()
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • getAskCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getAskCostAmount()
        Returns:
        The total amount on the ask side of the trade when requesting a quote

      • getAskCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal 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

        @Nullable
public @Nullable java.math.BigDecimal getAskCostRate()
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • getAskContraCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getAskContraCostAmount()
        Returns:
        The total amount on the ask side of the trade when requesting a quote seen in contra currency

      • getAskContraCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal 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

        @Nullable
public @Nullable java.math.BigDecimal getAskContraCostRate()
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • getBidContraCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getBidContraCostAmount()
        Returns:
        The total amount on the bid side of the trade when requesting a quote seen in contra currency

      • getBidContraCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal 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

        @Nullable
public @Nullable java.math.BigDecimal getBidContraCostRate()
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • getContraCostAmount

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

      • getContraCostPercentage

        @Nullable
public @Nullable java.math.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%.

      • getContraCostCurrency

        @Nullable
public @Nullable java.math.BigDecimal getContraCostCurrency()
        Returns:
        The contra currency that the cost is displayed in

      • getForwardPointsDecimalOffset

        @Nullable
public @Nullable java.lang.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.

      • getFields

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.lang.String> getFields()
        Specified by:
        getFields in interface Message

      • getFieldFlags

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

      • getFlagFields

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

      • toString

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

      • from

        @NotNull
public static @NotNull QuotePartsDef.LegFields from​(@NotNull
                                                    @NotNull java.util.Map<java.lang.String,​java.lang.String> fields)

      • from

        @NotNull
public static @NotNull QuotePartsDef.LegFields from​(@NotNull
                                                    @NotNull java.util.Map<java.lang.String,​java.lang.String> fields,
                                                    @NotNull
                                                    @NotNull java.lang.String fieldPrefix)