Package com.caplin.generated.motif.fx.trading.esp.events.client

Class SubmitTradeEvent

java.lang.Object

com.caplin.generated.motif.fx.trading.esp.events.client.SubmitTradeEvent

All Implemented Interfaces:

ESPSubmissionClientFieldSet, SubmissionClientFieldSet, LeggedMessage, LeggedMessageRoot, Message

public class SubmitTradeEvent
extends Object
implements ESPSubmissionClientFieldSet, LeggedMessageRoot

A single event acting on a ESPTrade.

The event may be client generated and received through the respective TradeListener interface or it may be generated by custom code to be sent to the client.

A ESPTradeEvent is created using the ESPTrade it relates to.

A ESPTradeEvent typically represents a message received from the client or sent by the server. A message contains a set of fields and values which can be accessed using the Message.getField(String) method.

Constructor Summary

Constructors

Constructor	Description
SubmitTradeEvent(com.caplin.trading.TradeEvent tradeEvent)

Method Summary

Modifier and Type	Method	Description
com.caplin.trading.TradeEvent	getBackingEvent()
String	getBaseCurrency()
Map<String,String>	getFields()	Gets the fields of this TradeEvent as a Map
String	getIsCoverTrade()
ESPSubmissionLegClientFieldSetChild	getLegById(int legId)	Deprecated.
ESPSubmissionLegClientFieldSetChild	getLegById(String legId)	Deprecated.
ESPSubmissionLegClientFieldSetChild	getLegByIndex(int index)	Deprecated.
List<ESPSubmissionLegClientFieldSetChild>	getLegs()	Deprecated.
List<ESPSubmissionLegClientFieldSetChild>	getLLegs()
ESPSubmissionLegClientFieldSetChild	getNearLeg()
int	getNumLegs()	Deprecated.
String	getOneClickActionType()
String	getQuoteID()
String	getSlippageAmount()
String	getSpotRate()
String	getTermCurrency()
String	getTimePriceClicked()
String	getTimePriceOnScreen()
String	getTimePriceReceived()
List<SettlementLegClientFieldSetChild>	getULegs()
boolean	isSales()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.caplin.generated.motif.fx.trading.fieldsets.ESPSubmissionClientFieldSet

getLLegById, getLLegById, getLLegByIndex, getNumLLegs, getNumULegs, getULegById, getULegById, getULegByIndex

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

getId, getIndex

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

getField

Methods inherited from interface com.caplin.generated.motif.fx.trading.fieldsets.SubmissionClientFieldSet

getAccount, getAppID, getAssetClass, getControlAddLeg, getCurrencyPair, getDealtCurrency, getIsCommercial, getPurpose, getTOBOUser, getTradingAssetClass, getTradingProtocol, getTradingSubProtocol, getTradingType

Constructor Details

SubmitTradeEvent

public SubmitTradeEvent(com.caplin.trading.TradeEvent tradeEvent)

Method Details

getFields

public Map<String,String> getFields()

Gets the fields of this TradeEvent as a Map

Specified by:

getFields in interface Message

Returns:

a map of the fields;

getQuoteID

public String getQuoteID()

Returns:

The unique ID of the quote the client wants to trade on. This is generated by the OMS. For SPOT trades it will be the Quote ID for the SPOT quote, for Forward trades it will be the Quote ID of the forward points quote.

getSpotRate

public String getSpotRate()

Returns:

This is the spot rate that the client wants to trade on. The value of this field must equal the value of either the SpotBidRate or SpotAskRate field on the rate update that the client is executing. Example value: 1.08575

getOneClickActionType

public String getOneClickActionType()

Returns:

This field is used to tell the server if and how to apply slippage. The possible values are: FillAtMarket, FillAtMyRate or AllowFillSlippage.

getIsCoverTrade

public String getIsCoverTrade()

Returns:

This field is used to indicate to the back end that a cover trade has been submitted.

getSlippageAmount

public String getSlippageAmount()

Returns:

The amount of slippage permitted.

getTimePriceClicked

public String getTimePriceClicked()

Returns:

The time at which the trade is executed for that price, in epoch milliseconds.

getTimePriceOnScreen

public String getTimePriceOnScreen()

Returns:

The time the tile on the frontend receives that price, in epoch milliseconds.

getTimePriceReceived

public String getTimePriceReceived()

Returns:

The time the price is received from the liquidity provider, in epoch milliseconds.

getBackingEvent

public com.caplin.trading.TradeEvent getBackingEvent()

Returns:

Get the TradeEvent backing this event

getLLegs

public List<ESPSubmissionLegClientFieldSetChild> getLLegs()

Specified by:

getLLegs in interface ESPSubmissionClientFieldSet

Specified by:

getLLegs in interface SubmissionClientFieldSet

Returns:

Get all the L legs for this trade

getULegs

public List<SettlementLegClientFieldSetChild> getULegs()

Specified by:

getULegs in interface ESPSubmissionClientFieldSet

Returns:

Get all the U legs for this trade

getLegs

@Deprecated
public List<ESPSubmissionLegClientFieldSetChild> getLegs()

Deprecated.

Returns:

Get all the L legs for this trade This method is deprecated, please use getLLegs()

getLegById

@Deprecated
public ESPSubmissionLegClientFieldSetChild getLegById(int legId)

Deprecated.

Returns:

Get the L leg for the given id This method is deprecated, please use ESPSubmissionClientFieldSet.getLLegById(int)

getLegById

@Deprecated
public ESPSubmissionLegClientFieldSetChild getLegById(String legId)

Deprecated.

Returns:

Get the L leg for the given id This method is deprecated, please use ESPSubmissionClientFieldSet.getLLegById(String)

getLegByIndex

@Deprecated
public ESPSubmissionLegClientFieldSetChild getLegByIndex(int index)

Deprecated.

Returns:

Get the L leg for the given index This method is deprecated, please use ESPSubmissionClientFieldSet.getLLegByIndex(int)

getNumLegs

@Deprecated
public int getNumLegs()

Deprecated.

Returns:

Get the number of L legs for this trade This method is deprecated, please use ESPSubmissionClientFieldSet.getNumLLegs()

getNearLeg

public ESPSubmissionLegClientFieldSetChild getNearLeg()

isSales

public boolean isSales()

getBaseCurrency

public String getBaseCurrency()

getTermCurrency

public String getTermCurrency()

toString

public String toString()

Overrides:

toString in class Object