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 Details

    • getCurrencyPair

      default 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 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 String getAssetClass()
      The asset class for the trade; used by permissioning and licensing. Example value: FX

    • getTradingAssetClass

      default String getTradingAssetClass()
      The trading asset class for the trade; used by permissioning and licensing. Example value: FX

    • getTradingProtocol

      default 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 String getTradingSubProtocol()
      The trade sub protocol, e.g. SALES_ESP, SALES_RFS or SALES_ALLOCATE. Also used for permissioning.

    • getAccount

      default String getAccount()
      The settlement account to use

    • getTOBOUser

      default 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 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 String getTradingType()
      This could be SPOT, FWD for example

    • getPurpose

      default String getPurpose()
      The purpose of the trade. Example: Commercial

    • getIsCommercial

      default String getIsCommercial()
      Indication whether something is commercial or not

    • getAppID

      default 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(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

      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