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

Class QuotePartsDef.LegFields.Builder

java.lang.Object
com.caplin.generated.motif.fx.rates.QuotePartsDef.LegFields.Builder
Enclosing class:
QuotePartsDef.LegFields
public static final class QuotePartsDef.LegFields.Builder extends Object

  • Method Details

    • addField

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

    • build

      @NotNull public @NotNull QuotePartsDef.LegFields build()

    • toString

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

    • setTenor

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setTenor(@NotNull @NotNull 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 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 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 String settlementDate)
      Parameters:
      settlementDate - e.g. 20160314
      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.

    • 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 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 String startTenor)
      Parameters:
      startTenor - e.g. 1W
      Returns:
      The tenor of which the time option becomes active from.

    • setStartDate

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setStartDate(@NotNull @NotNull String startDate)
      Parameters:
      startDate - e.g. 20150620
      Returns:
      The date of which the time option becomes active from.

    • setAllInSpread

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setAllInSpread(@NotNull @NotNull BigDecimal allInSpread)
      Parameters:
      allInSpread - e.g. 0.00162
      Returns:
      Optional field for displaying the spread between a bid and ask rate value. Calculate by subtracting bid rate from ask rate.

    • setAllInSpread

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setAllInSpread(@NotNull @NotNull String allInSpread)
      Parameters:
      allInSpread - e.g. 0.00162
      Returns:
      Optional field for displaying the spread between a bid and ask rate value. Calculate by subtracting bid rate from ask rate.

    • 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 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 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 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 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 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 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 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 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 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 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 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 String fwdBidPips)
      Deprecated.
      Parameters:
      fwdBidPips - e.g. 53.90
      Returns:
      fwdBidPips

    • setFwdAskPips

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

    • setAllInMidRate

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setAllInMidRate(@NotNull @NotNull 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 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 BigDecimal amount)
      Returns:
      The amount of a trade or order in the DealtCurrency.

    • setAmount

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

    • setBuySell

      @NotNull public @NotNull QuotePartsDef.LegFields.Builder setBuySell(@NotNull @NotNull 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.