Interface SubmissionServerFieldSet


  • public interface SubmissionServerFieldSet
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void addField​(java.lang.String fieldName, java.lang.Object value)
      Adds a field to this event
      default void setAccount​(java.lang.Object value)
      The settlement account to use
      default void setAppID​(java.lang.Object value)
      A unique identifier for the client application
      default void setAssetClass​(java.lang.Object value)
      The asset class for the trade; used by permissioning and licensing.
      default void setControlAddLeg​(java.lang.Object value)
      This is a control field that the front end trading library adds automatically.
      default void setCurrencyPair​(java.lang.Object value)
      The currency pair for the trade.
      default void setDealtCurrency​(java.lang.Object value)
      The dealt currency for the trade (what the amount is expressed in).
      default void setIsCommercial​(java.lang.Object value)
      Indication whether something is commercial or not
      default void setPurpose​(java.lang.Object value)
      The purpose of the trade.
      default void setTOBOUser​(java.lang.Object value)
      The user the trade is on behalf of.
      default void setTradingAssetClass​(java.lang.Object value)
      The trading asset class for the trade; used by permissioning and licensing.
      default void setTradingProtocol​(java.lang.Object value)
      The trade protocol, e.g, ESP or RFS.
      default void setTradingSubProtocol​(java.lang.Object value)
      The trade sub protocol, e.g.
      default void setTradingType​(java.lang.Object value)
      This could be SPOT, FWD for example
    • Method Detail

      • addField

        void addField​(java.lang.String fieldName,
                      java.lang.Object value)
        Adds a field to this event
        Parameters:
        fieldName - The name of the field to add.
        value - The value of the field to add. If the value is a BigDecimal then it will be converted to a String using BigDecimal.toPlainString()
      • setCurrencyPair

        default void setCurrencyPair​(java.lang.Object value)
        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
        Parameters:
        value - The value to be set passed by i18n
      • setDealtCurrency

        default void setDealtCurrency​(java.lang.Object value)
        The dealt currency for the trade (what the amount is expressed in). Must be either the base or term currency.Example value: EUR
        Parameters:
        value - The value to be set passed by i18n
      • setAssetClass

        default void setAssetClass​(java.lang.Object value)
        The asset class for the trade; used by permissioning and licensing. Example value: FX
        Parameters:
        value - The value to be set passed by i18n
      • setTradingAssetClass

        default void setTradingAssetClass​(java.lang.Object value)
        The trading asset class for the trade; used by permissioning and licensing. Example value: FX
        Parameters:
        value - The value to be set passed by i18n
      • setTradingProtocol

        default void setTradingProtocol​(java.lang.Object value)
        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.
        Parameters:
        value - The value to be set passed by i18n
      • setTradingSubProtocol

        default void setTradingSubProtocol​(java.lang.Object value)
        The trade sub protocol, e.g. SALES_ESP, SALES_RFS or SALES_ALLOCATE. Also used for permissioning.
        Parameters:
        value - The value to be set passed by i18n
      • setAccount

        default void setAccount​(java.lang.Object value)
        The settlement account to use
        Parameters:
        value - The value to be set passed by i18n
      • setTOBOUser

        default void setTOBOUser​(java.lang.Object value)
        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
        Parameters:
        value - The value to be set passed by i18n
      • setControlAddLeg

        default void setControlAddLeg​(java.lang.Object value)
        This is a control field that the front end trading library adds automatically. The user code doesn't need to do anything with this.
        Parameters:
        value - The value to be set passed by i18n
      • setTradingType

        default void setTradingType​(java.lang.Object value)
        This could be SPOT, FWD for example
        Parameters:
        value - The value to be set passed by i18n
      • setPurpose

        default void setPurpose​(java.lang.Object value)
        The purpose of the trade. Example: Commercial
        Parameters:
        value - The value to be set passed by i18n
      • setIsCommercial

        default void setIsCommercial​(java.lang.Object value)
        Indication whether something is commercial or not
        Parameters:
        value - The value to be set passed by i18n
      • setAppID

        default void setAppID​(java.lang.Object value)
        A unique identifier for the client application
        Parameters:
        value - The value to be set passed by i18n