Package com.caplin.generated.motif.fx.trading.fieldsets

Interface ExecutionLegClientFieldSet

All Superinterfaces:

LeggedMessage, Message

All Known Implementing Classes:

ExecutionLegClientFieldSetChild

public interface ExecutionLegClientFieldSet
extends LeggedMessage

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getAllInAskMargin()	This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
default java.lang.String	getAllInAskRate()	This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message
default java.lang.String	getAllInBidMargin()	This is the user’s selected SpotBidMargin added to the selected FwdBidMargin
default java.lang.String	getAllInBidRate()	This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message
default java.lang.String	getBuySell()	Whether the client wants to buy or sell the base currency, NOT the dealt currency.
default java.lang.String	getFwdAskMargin()	This field represents the Forward margin that the sales user has selected.
default java.lang.String	getFwdAskPips()	Deprecated.
default java.lang.String	getFwdAskPoints()	For forward trades this is the forward points that the client wants to trade on.
default java.lang.String	getFwdBidMargin()	This field represents the Forward margin that the sales user has selected.
default java.lang.String	getFwdBidPips()	Deprecated.
default java.lang.String	getFwdBidPoints()	For forward trades this is the forward points that the client wants to trade on.
default java.lang.String	getFwdPips()	Deprecated.
default java.lang.String	getPrice()	This is the all-in rate that the client wants to trade on.

Methods inherited from interface com.caplin.motif.datasource.LeggedMessage

getId, getIndex

Methods inherited from interface com.caplin.motif.datasource.Message

getField, getFields

Method Detail

getBuySell

default java.lang.String getBuySell()

Whether the client wants to buy or sell the base currency, NOT the dealt currency. For example if the currency pair is EURGBP and this value is EUR then this field always tells you if the client wants to buy or sell EUR, even if the dealt currency is GBP. The dealt currency just tells you which currency the client has specified the amount in.

getPrice

default java.lang.String getPrice()

This is the all-in rate that the client wants to trade on. The value of this field must equal the value of either the L*_AllInBidRate or L*_AllInAskRate field on the rate update that the client is executing. The front end typically populates this field by reading the currently rendered price on the buy or sell button at the time the user clicks.

getFwdBidPoints

default java.lang.String getFwdBidPoints()

For forward trades this is the forward points that the client wants to trade on. The value of this field must equal the value of either the BidPoints or AskPoints field on the rate update that the client is executing. For SPOT trades this field should be not sent. If the trade is a forward but the back end did not send the BidPoints and AskPoints fields (because they are optional) then this field should be not sent.

getFwdAskPoints

default java.lang.String getFwdAskPoints()

For forward trades this is the forward points that the client wants to trade on. The value of this field must equal the value of either the BidPoints or AskPoints field on the rate update that the client is executing. For SPOT trades this field should be not sent. If the trade is a forward but the back end did not send the BidPoints and AskPoints fields (because they are optional) then this field should be not sent.

getAllInBidRate

default java.lang.String getAllInBidRate()

This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message

getAllInAskRate

default java.lang.String getAllInAskRate()

This field is included on the rate update that the client wants to trade on, and should be sent back unchanged on the Submit message

getAllInBidMargin

default java.lang.String getAllInBidMargin()

This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

getAllInAskMargin

default java.lang.String getAllInAskMargin()

This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

getFwdBidMargin

default java.lang.String getFwdBidMargin()

This field represents the Forward margin that the sales user has selected. This field should be sent raw and unformatted.

getFwdAskMargin

default java.lang.String getFwdAskMargin()

This field represents the Forward margin that the sales user has selected. This field should be sent raw and unformatted.

getFwdPips

@Deprecated
default java.lang.String getFwdPips()

Deprecated.

For forward trades this is the forward pips that the client wants to trade on. The value of this field must equal the value of either the BidPips or AskPips field on the rate update that the client is executing. The front end typically populates this field by reading the currently rendered forward points on the buy or sell button at the time the user clicks. For SPOT trades this field should be not sent

getFwdBidPips

@Deprecated
default java.lang.String getFwdBidPips()

Deprecated.

This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate, and should be sent back unchanged on the Submit message. If it is not present on the rate update (which will be the case for an RFS SPOT trade) then it should not be sent on the Submit message either.

getFwdAskPips

@Deprecated
default java.lang.String getFwdAskPips()

Deprecated.

This field is included on the rate update that the client wants to trade on if it is a streaming Forward rate, and should be sent back unchanged on the Submit message. If it is not present on the rate update (which will be the case for an RFS SPOT trade) then it should not be sent on the Submit message either.