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

Interface ExecutionClientFieldSet

All Superinterfaces:
LeggedMessage, Message
All Known Implementing Classes:
ClientCloseTradeEvent, ClientCloseTradeEvent, ClientCloseTradeEvent, ClientCloseTradeEvent, ExecuteTradeEvent, ExecuteTradeEvent, ExecuteTradeEvent, ExecuteTradeEvent, ExecutionClientFieldSetChild
public interface ExecutionClientFieldSet extends LeggedMessage

  • Method Details

    • getQuoteID

      default String getQuoteID()
      The unique ID of the quote the client wants to trade on. This is generated by the OMS. Unlike ESP where you have a quote ID for the forward points and a quote ID for the related SPOT quote there is only one quote ID for an RFS quote, even if it's a forward or swap

    • getSpotBidRate

      default String getSpotBidRate()
      This field is included on the rate update that the client wants to trade on

    • getSpotAskRate

      default String getSpotAskRate()
      This field is included on the rate update that the client wants to trade on

    • getAssetClass

      default String getAssetClass()
      The asset class for the trade; used by permissioning and licensing.

    • getTradingAssetClass

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

    • 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.

    • getTOBOUser

      default String getTOBOUser()
      The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.

    • getCurrencyPair

      default String getCurrencyPair()
      The currency pair for the trade. For example, EURUSD

    • getDealtCurrency

      default String getDealtCurrency()
      The currency of the Amount of a trade or order. For example, GBP

    • getTradingType

      default String getTradingType()
      Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.

    • getStartDate

      default String getStartDate()
      The start date value for a time option trade. example: 20150620

    • getEndDate

      default String getEndDate()
      The end date value for a time option trade. example: 20150620

    • getSpotBidMargin

      default String getSpotBidMargin()
      This field represents the spot margin that the sales user has selected. It should be sent as a raw value, and unformatted.

    • getSpotAskMargin

      default String getSpotAskMargin()
      This field represents the spot margin that the sales user has selected. It should be sent as a raw value, and unformatted.

    • getSwapBidPoints

      default String getSwapBidPoints()
      This is the swap bid points that the client wants to trade on.

    • getSwapAskPoints

      default String getSwapAskPoints()
      This is the swap ask points that the client wants to trade on.

    • getSwapBidMargin

      default String getSwapBidMargin()
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.

    • getSwapAskMargin

      default String getSwapAskMargin()
      This field represents the swap margin to be applied to the bid side: L*_FwdAskMargin + L2_FwdBidMargin.

    • getIsAdvised

      default String getIsAdvised()
      true or false to indicate whether the trader gave the client advice

    • getRemarks

      default String getRemarks()
      The clients or trader's comments on a trade - visible to both the Client and the Trader.

    • getTraderRemarks

      default String getTraderRemarks()
      The trader's comments on an trade - visible to only the Trader

    • getStreamingMode

      default String getStreamingMode()
      Indicates whether the rates/margins of this trade were manually provided, 'Manual Mode', 'Streaming Mode'

    • getTraderSpotBidRate

      default String getTraderSpotBidRate()
      This field is included on the rate update that the client wants to trade on

    • getTraderSpotAskRate

      default String getTraderSpotAskRate()
      This field is included on the rate update that the client wants to trade on

    • getAllInBidRate

      default String getAllInBidRate()
      The bid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getAllInAskRate

      default String getAllInAskRate()
      The ask rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

    • getAllInBidMargin

      default String getAllInBidMargin()
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

    • getAllInAskMargin

      default String getAllInAskMargin()
      This is the user’s selected SpotBidMargin added to the selected FwdBidMargin

    • getBidPips

      @Deprecated default String getBidPips()
      Deprecated.
      For swap trades this field is included on the rate update that the client wants to trade on. For non-swap trades this field should be not sent.

    • getAskPips

      @Deprecated default String getAskPips()
      Deprecated.
      For swap trades this field is included on the rate update that the client wants to trade on. For non-swap trades this field should be not sent.

    • getPurpose

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

    • getIsCommercial

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

    • getClientAgreementDateTime

      default String getClientAgreementDateTime()
      Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different.

    • getAppID

      default String getAppID()
      A unique identifier for the client application

    • getSpotTrader

      default String getSpotTrader()
      The Spot trader for a manual mode trade

    • getForwardPointsTrader

      default String getForwardPointsTrader()
      The Forward points trader for a manual mode trade

    • getLLegById

      default ExecutionLegClientFieldSetChild getLLegById(int legId)
      Returns:
      Get the L leg for the given id

    • getLLegById

      default ExecutionLegClientFieldSetChild getLLegById(String legId)
      Returns:
      Get the L leg for the given id

    • getLLegByIndex

      default ExecutionLegClientFieldSetChild getLLegByIndex(int index)
      Returns:
      Get the L leg for the given index

    • getLLegs

      List<ExecutionLegClientFieldSetChild> getLLegs()
      Returns:
      Get all the L legs for this trade

    • getNumLLegs

      default int getNumLLegs()
      Returns:
      Get the number of L legs for this trade

    • getCLegById

      default SyntheticComponentClientFieldSetChild getCLegById(int legId)
      Returns:
      Get the C leg for the given id

    • getCLegById

      default SyntheticComponentClientFieldSetChild getCLegById(String legId)
      Returns:
      Get the C leg for the given id

    • getCLegByIndex

      default SyntheticComponentClientFieldSetChild getCLegByIndex(int index)
      Returns:
      Get the C leg for the given index

    • getCLegs

      List<SyntheticComponentClientFieldSetChild> getCLegs()
      Returns:
      Get all the C legs for this trade

    • getNumCLegs

      default int getNumCLegs()
      Returns:
      Get the number of C legs for this trade

    • getULegById

      default SettlementLegClientFieldSetChild getULegById(int legId)
      Returns:
      Get the U leg for the given id

    • getULegById

      default SettlementLegClientFieldSetChild getULegById(String legId)
      Returns:
      Get the U leg for the given id

    • getULegByIndex

      default SettlementLegClientFieldSetChild getULegByIndex(int index)
      Returns:
      Get the U leg for the given index

    • getULegs

      List<SettlementLegClientFieldSetChild> getULegs()
      Returns:
      Get all the U legs for this trade

    • getNumULegs

      default int getNumULegs()
      Returns:
      Get the number of U legs for this trade