com.caplin.motif.fx.rates

Class SalesFwdQuoteBuilder

java.lang.Object

com.caplin.motif.fx.rates.SalesFwdQuoteBuilder

public class SalesFwdQuoteBuilder
extends Object

A builder class for creating concrete instances of the SalesFwdQuote interface.

Method Summary

Modifier and Type	Method and Description
SalesFwdQuote	build() Builds the quote.
static SalesFwdQuoteBuilder	create() Creates a SalesFwdQuoteBuilder to be used for constructing a SalesFwdQuote.
SalesFwdQuoteBuilder	defaultFwdAskMargin(String defaultFwdAskMargin) The default forward margin on the ask rate.
SalesFwdQuoteBuilder	defaultFwdBidMargin(String defaultFwdBidMargin) The default forward margin on the bid rate.
SalesFwdQuoteBuilder	defaultSpotAskMargin(String defaultSpotAskMargin) The default margin to be applied to the Spot Ask Rate
SalesFwdQuoteBuilder	defaultSpotBidMargin(String defaultSpotBidMargin) The default margin to be applied to the Spot Bid Rate
SalesFwdQuoteBuilder	fwdQuote(FwdQuote fwdQuote) The underlying FwdQuote that contains all the fields a standard RFS quote would.
SalesFwdQuoteBuilder	profitAskRate(String profitAskRate) The ask rate that can be used to calculate the profit on the ask side in the given currency
SalesFwdQuoteBuilder	profitBidRate(String profitBidRate) The bid rate that can be used to calculate the profit on the bid side in the given currency
SalesFwdQuoteBuilder	profitCurrency(String profitCurrency) The currency that the Profit Bid Rate and Profit Ask Rate relate to
SalesFwdQuoteBuilder	profitCurrencyDPS(String profitCurrencyDPS) The number of decimal places that should be used for formatting the profit currency
SalesFwdQuoteBuilder	traderAllInAskRate(String traderAllInAskRate)
SalesFwdQuoteBuilder	traderAllInBidRate(String traderAllInBidRate)
SalesFwdQuoteBuilder	traderFwdAskPoints(String traderFwdAskPoints)
SalesFwdQuoteBuilder	traderFwdBidPoints(String traderFwdBidPoints)
SalesFwdQuoteBuilder	traderSpotAskRate(String traderSpotAskRate)
SalesFwdQuoteBuilder	traderSpotBidRate(String traderSpotBidRate)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fwdQuote

public SalesFwdQuoteBuilder fwdQuote(FwdQuote fwdQuote)

The underlying FwdQuote that contains all the fields a standard RFS quote would.

Parameters:

fwdQuote - The base RFS fwd quote

Returns:

This builder

defaultSpotBidMargin

public SalesFwdQuoteBuilder defaultSpotBidMargin(String defaultSpotBidMargin)

The default margin to be applied to the Spot Bid Rate

Parameters:

defaultSpotBidMargin - The default margin to be applied to the Spot Bid Rate

Returns:

This builder

defaultFwdBidMargin

public SalesFwdQuoteBuilder defaultFwdBidMargin(String defaultFwdBidMargin)

The default forward margin on the bid rate. The spot rate has the spot margin applied to it, this margin is then applied on top of that in order to calculate to the bid all-in rate.

Parameters:

defaultFwdBidMargin - The default forward margin on the bid rate

Returns:

This builder

defaultSpotAskMargin

public SalesFwdQuoteBuilder defaultSpotAskMargin(String defaultSpotAskMargin)

The default margin to be applied to the Spot Ask Rate

Parameters:

defaultSpotAskMargin - The default margin to be applied to the Spot Ask Rate

Returns:

This builder

defaultFwdAskMargin

public SalesFwdQuoteBuilder defaultFwdAskMargin(String defaultFwdAskMargin)

The default forward margin on the ask rate. The spot rate has the spot margin applied to it, this margin is then applied on top of that in order to calculate to the ask all-in rate.

Parameters:

defaultFwdAskMargin - The default forward margin on the ask rate.

Returns:

This builder

profitCurrency

public SalesFwdQuoteBuilder profitCurrency(String profitCurrency)

The currency that the Profit Bid Rate and Profit Ask Rate relate to

Parameters:

profitCurrency - The currency that the Profit Bid Rate and Profit Ask Rate relate to

Returns:

This builder

profitCurrencyDPS

public SalesFwdQuoteBuilder profitCurrencyDPS(String profitCurrencyDPS)

The number of decimal places that should be used for formatting the profit currency

Parameters:

profitCurrencyDPS - The number of decimal places that should be used for formatting the profit currency

Returns:

This builder

profitBidRate

public SalesFwdQuoteBuilder profitBidRate(String profitBidRate)

The bid rate that can be used to calculate the profit on the bid side in the given currency

Parameters:

profitBidRate - The bid rate that can be used to calculate the profit on the bid side in the given currency

Returns:

This builder

profitAskRate

public SalesFwdQuoteBuilder profitAskRate(String profitAskRate)

The ask rate that can be used to calculate the profit on the ask side in the given currency

Parameters:

profitAskRate - The ask rate that can be used to calculate the profit on the ask side in the given currency

Returns:

This builder

traderSpotBidRate

public SalesFwdQuoteBuilder traderSpotBidRate(String traderSpotBidRate)

traderFwdBidPoints

public SalesFwdQuoteBuilder traderFwdBidPoints(String traderFwdBidPoints)

traderAllInBidRate

public SalesFwdQuoteBuilder traderAllInBidRate(String traderAllInBidRate)

traderSpotAskRate

public SalesFwdQuoteBuilder traderSpotAskRate(String traderSpotAskRate)

traderFwdAskPoints

public SalesFwdQuoteBuilder traderFwdAskPoints(String traderFwdAskPoints)

traderAllInAskRate

public SalesFwdQuoteBuilder traderAllInAskRate(String traderAllInAskRate)

build

public SalesFwdQuote build()
                    throws IllegalStateException

Builds the quote.

Returns:

A SalesFwdQuote.

Throws:

IllegalStateException

create

public static SalesFwdQuoteBuilder create()

Creates a SalesFwdQuoteBuilder to be used for constructing a SalesFwdQuote.

Returns:

A SalesFwdQuoteBuilder.