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

Class QuotePartsDef.LegFields.Builder

  • Enclosing class:
    QuotePartsDef.LegFields
    public static final class QuotePartsDef.LegFields.Builder
extends java.lang.Object

    • Method Detail

      • addField

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder addField​(@NotNull
                                                         @NotNull java.lang.String key,
                                                         @NotNull
                                                         @NotNull java.lang.String value)

      • toString

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

      • setTenor

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setTenor​(@NotNull
                                                         @NotNull java.lang.String tenor)
        Parameters:
        tenor - e.g. 1M
        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.

      • setRiskDate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setRiskDate​(@NotNull
                                                            @NotNull java.lang.String riskDate)
        Parameters:
        riskDate - e.g. 20160314
        Returns:
        The date in the settlement window which yields the lowest client sell price, or the highest client buy price.

      • setRiskTenor

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setRiskTenor​(@NotNull
                                                             @NotNull java.lang.String riskTenor)
        Parameters:
        riskTenor - e.g. 1W
        Returns:
        The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.

      • setSettlementDate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setSettlementDate​(@NotNull
                                                                  @NotNull java.lang.String settlementDate)
        Returns:
        settlementDate

      • setIsTimeOption

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setIsTimeOption​(boolean isTimeOption)
        Parameters:
        isTimeOption - e.g. true
        Returns:
        true if a leg is time-option

      • setIsTimeOption

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setIsTimeOption​(@NotNull
                                                                @NotNull java.lang.String isTimeOption)
        Parameters:
        isTimeOption - e.g. true
        Returns:
        true if a leg is time-option

      • setStartTenor

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setStartTenor​(@NotNull
                                                              @NotNull java.lang.String startTenor)
        Parameters:
        startTenor - e.g. 1W
        Returns:
        startTenor

      • setStartDate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setStartDate​(@NotNull
                                                             @NotNull java.lang.String startDate)
        Parameters:
        startDate - e.g. 20150620
        Returns:
        startDate

      • setAllInRateDPS

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInRateDPS​(int allInRateDPS)
        Parameters:
        allInRateDPS - e.g. 5
        Returns:
        The number of decimal places to display after the decimal point.

      • setAllInRateDPS

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInRateDPS​(@NotNull
                                                                @NotNull java.lang.String allInRateDPS)
        Parameters:
        allInRateDPS - e.g. 5
        Returns:
        The number of decimal places to display after the decimal point.

      • setAllInBidRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInBidRate​(@NotNull
                                                                @NotNull java.math.BigDecimal allInBidRate)
        Parameters:
        allInBidRate - e.g. 1.091790
        Returns:
        The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setAllInBidRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInBidRate​(@NotNull
                                                                @NotNull java.lang.String allInBidRate)
        Parameters:
        allInBidRate - e.g. 1.091790
        Returns:
        The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setFwdBidPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdBidPoints​(@NotNull
                                                                @NotNull java.math.BigDecimal fwdBidPoints)
        Parameters:
        fwdBidPoints - e.g. 0.005390
        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.

      • setFwdBidPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdBidPoints​(@NotNull
                                                                @NotNull java.lang.String fwdBidPoints)
        Parameters:
        fwdBidPoints - e.g. 0.005390
        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.

      • setAllInAskRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInAskRate​(@NotNull
                                                                @NotNull java.math.BigDecimal allInAskRate)
        Parameters:
        allInAskRate - e.g. 1.091790
        Returns:
        The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setAllInAskRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInAskRate​(@NotNull
                                                                @NotNull java.lang.String allInAskRate)
        Parameters:
        allInAskRate - e.g. 1.091790
        Returns:
        The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setFwdAskPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdAskPoints​(@NotNull
                                                                @NotNull java.math.BigDecimal fwdAskPoints)
        Parameters:
        fwdAskPoints - e.g. 0.005390
        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.

      • setFwdAskPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdAskPoints​(@NotNull
                                                                @NotNull java.lang.String fwdAskPoints)
        Parameters:
        fwdAskPoints - e.g. 0.005390
        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.

      • setFwdMidPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdMidPoints​(@NotNull
                                                                @NotNull java.math.BigDecimal fwdMidPoints)
        Parameters:
        fwdMidPoints - e.g. 0.005390
        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.

      • setFwdMidPoints

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdMidPoints​(@NotNull
                                                                @NotNull java.lang.String fwdMidPoints)
        Parameters:
        fwdMidPoints - e.g. 0.005390
        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.

      • setFwdBidPips

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdBidPips​(@NotNull
                                                              @NotNull java.lang.String fwdBidPips)
        Deprecated.
        Parameters:
        fwdBidPips - e.g. 53.90
        Returns:
        fwdBidPips

      • setFwdAskPips

        @Deprecated
@NotNull
public @NotNull QuotePartsDef.LegFields.Builder setFwdAskPips​(@NotNull
                                                              @NotNull java.lang.String fwdAskPips)
        Deprecated.
        Parameters:
        fwdAskPips - e.g. 53.90
        Returns:
        fwdAskPips

      • setAllInMidRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInMidRate​(@NotNull
                                                                @NotNull java.math.BigDecimal allInMidRate)
        Parameters:
        allInMidRate - e.g. 1.091790
        Returns:
        The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setAllInMidRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAllInMidRate​(@NotNull
                                                                @NotNull java.lang.String allInMidRate)
        Parameters:
        allInMidRate - e.g. 1.091790
        Returns:
        The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • setAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAmount​(@NotNull
                                                          @NotNull java.math.BigDecimal amount)
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • setAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAmount​(@NotNull
                                                          @NotNull java.lang.String amount)
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • setBuySell

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBuySell​(@NotNull
                                                           @NotNull java.lang.String buySell)
        Returns:
        The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

      • setCostCurrency

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setCostCurrency​(@NotNull
                                                                @NotNull java.lang.String costCurrency)
        Parameters:
        costCurrency - e.g. GBP
        Returns:
        The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

      • setBidCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostAmount​(@NotNull
                                                                 @NotNull java.math.BigDecimal bidCostAmount)
        Parameters:
        bidCostAmount - e.g. 150000.00
        Returns:
        The total amount on the bid side of the trade when requesting a quote

      • setBidCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostAmount​(@NotNull
                                                                 @NotNull java.lang.String bidCostAmount)
        Parameters:
        bidCostAmount - e.g. 150000.00
        Returns:
        The total amount on the bid side of the trade when requesting a quote

      • setBidCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostPercentage​(@NotNull
                                                                     @NotNull java.math.BigDecimal bidCostPercentage)
        Parameters:
        bidCostPercentage - e.g. 1.5
        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%.

      • setBidCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostPercentage​(@NotNull
                                                                     @NotNull java.lang.String bidCostPercentage)
        Parameters:
        bidCostPercentage - e.g. 1.5
        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%.

      • setBidCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostRate​(@NotNull
                                                               @NotNull java.math.BigDecimal bidCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setBidCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidCostRate​(@NotNull
                                                               @NotNull java.lang.String bidCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setAskCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostAmount​(@NotNull
                                                                 @NotNull java.math.BigDecimal askCostAmount)
        Parameters:
        askCostAmount - e.g. 150000.00
        Returns:
        The total amount on the ask side of the trade when requesting a quote

      • setAskCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostAmount​(@NotNull
                                                                 @NotNull java.lang.String askCostAmount)
        Parameters:
        askCostAmount - e.g. 150000.00
        Returns:
        The total amount on the ask side of the trade when requesting a quote

      • setAskCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostPercentage​(@NotNull
                                                                     @NotNull java.math.BigDecimal askCostPercentage)
        Parameters:
        askCostPercentage - e.g. 1.5
        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%.

      • setAskCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostPercentage​(@NotNull
                                                                     @NotNull java.lang.String askCostPercentage)
        Parameters:
        askCostPercentage - e.g. 1.5
        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%.

      • setAskCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostRate​(@NotNull
                                                               @NotNull java.math.BigDecimal askCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setAskCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskCostRate​(@NotNull
                                                               @NotNull java.lang.String askCostRate)
        Returns:
        The rate to multiply by the margin (in home currency), to get the cost in the CostCurrency.

      • setAskContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostAmount​(@NotNull
                                                                       @NotNull java.math.BigDecimal askContraCostAmount)
        Returns:
        The total amount on the ask side of the trade when requesting a quote seen in contra currency

      • setAskContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostAmount​(@NotNull
                                                                       @NotNull java.lang.String askContraCostAmount)
        Returns:
        The total amount on the ask side of the trade when requesting a quote seen in contra currency

      • setAskContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostPercentage​(@NotNull
                                                                           @NotNull java.math.BigDecimal askContraCostPercentage)
        Parameters:
        askContraCostPercentage - e.g. 1.5
        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%.

      • setAskContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostPercentage​(@NotNull
                                                                           @NotNull java.lang.String askContraCostPercentage)
        Parameters:
        askContraCostPercentage - e.g. 1.5
        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%.

      • setAskContraCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostRate​(@NotNull
                                                                     @NotNull java.math.BigDecimal askContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setAskContraCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setAskContraCostRate​(@NotNull
                                                                     @NotNull java.lang.String askContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setBidContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostAmount​(@NotNull
                                                                       @NotNull java.math.BigDecimal bidContraCostAmount)
        Returns:
        The total amount on the bid side of the trade when requesting a quote seen in contra currency

      • setBidContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostAmount​(@NotNull
                                                                       @NotNull java.lang.String bidContraCostAmount)
        Returns:
        The total amount on the bid side of the trade when requesting a quote seen in contra currency

      • setBidContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostPercentage​(@NotNull
                                                                           @NotNull java.math.BigDecimal bidContraCostPercentage)
        Parameters:
        bidContraCostPercentage - e.g. 1.5
        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%.

      • setBidContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostPercentage​(@NotNull
                                                                           @NotNull java.lang.String bidContraCostPercentage)
        Parameters:
        bidContraCostPercentage - e.g. 1.5
        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%.

      • setBidContraCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostRate​(@NotNull
                                                                     @NotNull java.math.BigDecimal bidContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setBidContraCostRate

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setBidContraCostRate​(@NotNull
                                                                     @NotNull java.lang.String bidContraCostRate)
        Returns:
        The rate to multiply by the margin (in contra currency), to get the cost in the CostCurrency.

      • setContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setContraCostAmount​(@NotNull
                                                                    @NotNull java.math.BigDecimal contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostAmount

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setContraCostAmount​(@NotNull
                                                                    @NotNull java.lang.String contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setContraCostPercentage​(@NotNull
                                                                        @NotNull java.math.BigDecimal contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setContraCostPercentage

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setContraCostPercentage​(@NotNull
                                                                        @NotNull java.lang.String contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setContraCostCurrency

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setContraCostCurrency​(@NotNull
                                                                      @NotNull java.lang.String contraCostCurrency)
        Parameters:
        contraCostCurrency - e.g. GBP
        Returns:
        The contra currency that the cost is displayed in

      • setForwardPointsDecimalOffset

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setForwardPointsDecimalOffset​(int forwardPointsDecimalOffset)
        Parameters:
        forwardPointsDecimalOffset - e.g. 4
        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.

      • setForwardPointsDecimalOffset

        @NotNull
public @NotNull QuotePartsDef.LegFields.Builder setForwardPointsDecimalOffset​(@NotNull
                                                                              @NotNull java.lang.String forwardPointsDecimalOffset)
        Parameters:
        forwardPointsDecimalOffset - e.g. 4
        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.