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

Interface SubmissionClientFieldSet

All Superinterfaces:

LeggedMessage, Message

All Known Subinterfaces:

AllocateClientFieldSet, AmendClientFieldSet, ESPSubmissionClientFieldSet, RFSSubmissionClientFieldSet

All Known Implementing Classes:

AllocateClientFieldSetChild, AmendClientFieldSetChild, AmendTradeEvent, ESPSubmissionClientFieldSetChild, ResubmitTradeEvent, ResubmitTradeEvent, ResubmitTradeEvent, ResubmitTradeEvent, RFSSubmissionClientFieldSetChild, RisklessSubmitTradeEvent, SubmissionClientFieldSetChild, SubmitTradeEvent, SubmitTradeEvent, SubmitTradeEvent, SubmitTradeEvent, SubmitTradeEvent

public interface SubmissionClientFieldSet
extends LeggedMessage

Method Summary

Modifier and Type	Method	Description
default java.lang.String	getAccount()	The settlement account to use
default java.lang.String	getAppID()	A unique identifier for the client application
default java.lang.String	getAssetClass()	The asset class for the trade; used by permissioning and licensing.
default java.lang.String	getControlAddLeg()	This is a control field that the front end trading library adds automatically.
default java.lang.String	getCurrencyPair()	The currency pair for the trade.
default java.lang.String	getDealtCurrency()	The dealt currency for the trade (what the amount is expressed in).
default java.lang.String	getIsCommercial()	Indication whether something is commercial or not
default SubmissionLegClientFieldSetChild	getLLegById(int legId)
default SubmissionLegClientFieldSetChild	getLLegById(java.lang.String legId)
default SubmissionLegClientFieldSetChild	getLLegByIndex(int index)
java.util.List<? extends SubmissionLegClientFieldSetChild>	getLLegs()
default int	getNumLLegs()
default java.lang.String	getPurpose()	The purpose of the trade.
default java.lang.String	getTOBOUser()	The user the trade is on behalf of.
default java.lang.String	getTradingAssetClass()	The trading asset class for the trade; used by permissioning and licensing.
default java.lang.String	getTradingProtocol()	The trade protocol, e.g, ESP or RFS.
default java.lang.String	getTradingSubProtocol()	The trade sub protocol, e.g.
default java.lang.String	getTradingType()	This could be SPOT, FWD for example

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

getId, getIndex

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

getField, getFields

Method Detail

getCurrencyPair

default java.lang.String getCurrencyPair()

The currency pair for the trade. This is sent in preference to BaseCurrency and TermCurrency because CurrencyPair is what we permission on. It would be a security hole for the back end to read BaseCurrency and TermCurrency fields, because a malicious client could send a valid currency pair in the CurrencyPair field in order to pass the permission check, but send two different currencies in the BaseCurrency and TermCurrency fields in order to execute a trade on a non-permissioned currency pair. Example value: EURUSD

getDealtCurrency

default java.lang.String getDealtCurrency()

The dealt currency for the trade (what the amount is expressed in). Must be either the base or term currency.Example value: EUR

getAssetClass

default java.lang.String getAssetClass()

The asset class for the trade; used by permissioning and licensing. Example value: FX

getTradingAssetClass

default java.lang.String getTradingAssetClass()

The trading asset class for the trade; used by permissioning and licensing. Example value: FX

getTradingProtocol

default java.lang.String getTradingProtocol()

The trade protocol, e.g, ESP or RFS. The Trading DataSource library needs this so that it knows which state model to use for the trade. Also used for permissioning.

getTradingSubProtocol

default java.lang.String getTradingSubProtocol()

The trade sub protocol, e.g. SALES_ESP, SALES_RFS or SALES_ALLOCATE. Also used for permissioning.

getAccount

default java.lang.String getAccount()

The settlement account to use

getTOBOUser

default java.lang.String getTOBOUser()

The user the trade is on behalf of. For example, if dealer1@novobank.co.za does a trade on behalf of bob_treasurer@anglo.co.za then the value of this field will be bob_treasurer@anglo.co.za. If this is not a TOBO trade then this field is not sent. Example value: bob_treasurer@anglo.co.za

getControlAddLeg

default java.lang.String getControlAddLeg()

This is a control field that the front end trading library adds automatically. The user code doesn't need to do anything with this.

getTradingType

default java.lang.String getTradingType()

This could be SPOT, FWD for example

getPurpose

default java.lang.String getPurpose()

The purpose of the trade. Example: Commercial

getIsCommercial

default java.lang.String getIsCommercial()

Indication whether something is commercial or not

getAppID

default java.lang.String getAppID()

A unique identifier for the client application

getLLegById

default SubmissionLegClientFieldSetChild getLLegById(int legId)

Returns:

Get the L leg for the given id

getLLegById

default SubmissionLegClientFieldSetChild getLLegById(java.lang.String legId)

Returns:

Get the L leg for the given id

getLLegByIndex

default SubmissionLegClientFieldSetChild getLLegByIndex(int index)

Returns:

Get the L leg for the given index

getLLegs

java.util.List<? extends SubmissionLegClientFieldSetChild> getLLegs()

Returns:

Get all the L legs for this trade

getNumLLegs

default int getNumLLegs()

Returns:

Get the number of L legs for this trade