Package com.caplin.generated.motif.fx.orders

Class OrderDetailsPartsDef.CommonFields.Builder

java.lang.Object
com.caplin.generated.motif.fx.orders.OrderDetailsPartsDef.CommonFields.Builder
Enclosing class:
OrderDetailsPartsDef.CommonFields
public static final class OrderDetailsPartsDef.CommonFields.Builder extends Object

  • Method Details

    • addField

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder addField(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • build

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields build()

    • toString

      @NotNull public @NotNull String toString()
      Overrides:
      toString in class Object

    • setCurrencyPair

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setCurrencyPair(@NotNull @NotNull String currencyPair, boolean isEditable)
      Returns:
      The currency pair for the trade. For example, EURUSD

    • setCurrencyPair

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setCurrencyPair(@NotNull @NotNull String currencyPair)
      Returns:
      The currency pair for the trade. For example, EURUSD

    • setCurrencyPairEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setCurrencyPairEditable()

    • setAccount

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAccount(@NotNull @NotNull String account, boolean isEditable)
      Parameters:
      account - e.g. Garfields|GARF
      Returns:
      The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

    • setAccount

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAccount(@NotNull @NotNull String account)
      Parameters:
      account - e.g. Garfields|GARF
      Returns:
      The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

    • setAccountEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAccountEditable()

    • setAllowedActions

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAllowedActions(@NotNull @NotNull String allowedActions)
      Returns:
      Comma separated list of Caplin supported values [Edit, Deactivate, Cancel, Activate, InactiveEdit, InactiveDeactivate, InactiveCancel, InactiveActivate]

    • setActivationType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationType(@NotNull @NotNull String activationType, boolean isEditable)
      Returns:
      How the order should be activated. Caplin supported statuses are [GFA, EXPLICIT]

    • setActivationType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationType(@NotNull @NotNull String activationType)
      Returns:
      How the order should be activated. Caplin supported statuses are [GFA, EXPLICIT]

    • setActivationTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationTypeEditable()

    • setActivationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTime(@NotNull @NotNull Instant activationDateTime, boolean isEditable)
      Parameters:
      activationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will become active. This is in ISO-8601 format.

    • setActivationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTime(@NotNull @NotNull Instant activationDateTime)
      Parameters:
      activationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will become active. This is in ISO-8601 format.

    • setActivationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTime(@NotNull @NotNull String activationDateTime, boolean isEditable)
      Parameters:
      activationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will become active. This is in ISO-8601 format.

    • setActivationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTime(@NotNull @NotNull String activationDateTime)
      Parameters:
      activationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will become active. This is in ISO-8601 format.

    • setActivationDateTimeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTimeEditable()

    • setActivationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZone(@NotNull @NotNull ZoneId activationDisplayTimeZone, boolean isEditable)
      Parameters:
      activationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.

    • setActivationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZone(@NotNull @NotNull ZoneId activationDisplayTimeZone)
      Parameters:
      activationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.

    • setActivationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZone(@NotNull @NotNull String activationDisplayTimeZone, boolean isEditable)
      Parameters:
      activationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.

    • setActivationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZone(@NotNull @NotNull String activationDisplayTimeZone)
      Parameters:
      activationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the activation time and date should be formatted to for display. This is in the TZ database format.

    • setActivationDisplayTimeZoneEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZoneEditable()

    • setExpirationType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationType(@NotNull @NotNull String expirationType, boolean isEditable)
      Returns:
      How the order should be deactivated. Caplin supported statuses are [IOC, GTC, GFD, FOK, EXPLICIT]

    • setExpirationType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationType(@NotNull @NotNull String expirationType)
      Returns:
      How the order should be deactivated. Caplin supported statuses are [IOC, GTC, GFD, FOK, EXPLICIT]

    • setExpirationTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationTypeEditable()

    • setExpirationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTime(@NotNull @NotNull Instant expirationDateTime, boolean isEditable)
      Parameters:
      expirationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will be deactivated. This is in ISO-8601 format.

    • setExpirationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTime(@NotNull @NotNull Instant expirationDateTime)
      Parameters:
      expirationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will be deactivated. This is in ISO-8601 format.

    • setExpirationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTime(@NotNull @NotNull String expirationDateTime, boolean isEditable)
      Parameters:
      expirationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will be deactivated. This is in ISO-8601 format.

    • setExpirationDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTime(@NotNull @NotNull String expirationDateTime)
      Parameters:
      expirationDateTime - e.g. 2013-07-24T17:13:59.985
      Returns:
      The time and date the order will be deactivated. This is in ISO-8601 format.

    • setExpirationDateTimeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTimeEditable()

    • setExpirationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZone(@NotNull @NotNull ZoneId expirationDisplayTimeZone, boolean isEditable)
      Parameters:
      expirationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.

    • setExpirationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZone(@NotNull @NotNull ZoneId expirationDisplayTimeZone)
      Parameters:
      expirationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.

    • setExpirationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZone(@NotNull @NotNull String expirationDisplayTimeZone, boolean isEditable)
      Parameters:
      expirationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.

    • setExpirationDisplayTimeZone

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZone(@NotNull @NotNull String expirationDisplayTimeZone)
      Parameters:
      expirationDisplayTimeZone - e.g. Europe/London
      Returns:
      The timezone that the expiration time and date should be formatted to for display. This is in the TZ database format.

    • setExpirationDisplayTimeZoneEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZoneEditable()

    • setAlertType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAlertType(@NotNull @NotNull String alertType, boolean isEditable)
      Returns:
      The type of alert that an order will send. Caplin supported statuses are [EMAIL, SMS].

    • setAlertType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAlertType(@NotNull @NotNull String alertType)
      Returns:
      The type of alert that an order will send. Caplin supported statuses are [EMAIL, SMS].

    • setAlertTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAlertTypeEditable()

    • setStrategyID

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setStrategyID(@NotNull @NotNull String strategyID)
      Returns:
      The strategy Id of the order.

    • setStrategyType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setStrategyType(@NotNull @NotNull String strategyType, boolean isEditable)
      Returns:
      The strategy the order was submitted with. This field should not be used by the front end for structuring orders. Comma separated list of Caplin supported values are [SINGLE, IF-DONE-OCO, OCO, IF-DONE, IF-TIMEOUT, IF-DONE-LOOP, LOOP]. OTHER denotes a strategy type that is unsupported.

    • setStrategyType

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setStrategyType(@NotNull @NotNull String strategyType)
      Returns:
      The strategy the order was submitted with. This field should not be used by the front end for structuring orders. Comma separated list of Caplin supported values are [SINGLE, IF-DONE-OCO, OCO, IF-DONE, IF-TIMEOUT, IF-DONE-LOOP, LOOP]. OTHER denotes a strategy type that is unsupported.

    • setStrategyTypeEditable

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setStrategyTypeEditable()

    • setTraderUsername

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setTraderUsername(@NotNull @NotNull String traderUsername)
      Parameters:
      traderUsername - e.g. sales_trader@novobank.co.za
      Returns:
      The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. 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 dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.

    • setTOBOUser

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setTOBOUser(@NotNull @NotNull String tOBOUser)
      Parameters:
      tOBOUser - e.g. client@customer.co.za
      Returns:
      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.

    • setFullName

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setFullName(@NotNull @NotNull String fullName)
      Returns:
      The full name of the user the trade is on behalf of

    • setEntityId

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setEntityId(@NotNull @NotNull String entityId)
      Parameters:
      entityId - e.g. CUSTONE
      Returns:
      The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.

    • setEntityDescription

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setEntityDescription(@NotNull @NotNull String entityDescription)
      Parameters:
      entityDescription - e.g. Customer 1
      Returns:
      The description of a trade on behalf of entity.

    • setOrderCount

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setOrderCount(int orderCount)
      Deprecated.
      Returns:
      orderCount

    • setOrderCount

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setOrderCount(@NotNull @NotNull String orderCount)
      Deprecated.
      Returns:
      orderCount

    • setOrderID

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setOrderID(@NotNull @NotNull String orderID)
      Returns:
      The id of the order.

    • setActivationDate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDate(@NotNull @NotNull String activationDate, boolean isEditable)
      Deprecated.
      Returns:
      What date the strategy should be activated.

    • setActivationDate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDate(@NotNull @NotNull String activationDate)
      Deprecated.
      Returns:
      What date the strategy should be activated.

    • setActivationDateEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateEditable()
      Deprecated.

    • setActivationTime

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationTime(@NotNull @NotNull String activationTime, boolean isEditable)
      Deprecated.
      Returns:
      What time the strategy should be activated if the ActivationDate was in the format of yyyymmdd.

    • setActivationTime

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationTime(@NotNull @NotNull String activationTime)
      Deprecated.
      Returns:
      What time the strategy should be activated if the ActivationDate was in the format of yyyymmdd.

    • setActivationTimeEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationTimeEditable()
      Deprecated.

    • setActivationLocation

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationLocation(@NotNull @NotNull String activationLocation, boolean isEditable)
      Deprecated.
      Parameters:
      activationLocation - e.g. Europe/London
      Returns:
      When location should be used to evaluate the time to activate if the ActivationDate was in the format of yyyymmdd.

    • setActivationLocation

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationLocation(@NotNull @NotNull String activationLocation)
      Deprecated.
      Parameters:
      activationLocation - e.g. Europe/London
      Returns:
      When location should be used to evaluate the time to activate if the ActivationDate was in the format of yyyymmdd.

    • setActivationLocationEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationLocationEditable()
      Deprecated.

    • setActivationUTCOffset

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationUTCOffset(@NotNull @NotNull String activationUTCOffset, boolean isEditable)
      Deprecated.
      Returns:
      activationUTCOffset

    • setActivationUTCOffset

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationUTCOffset(@NotNull @NotNull String activationUTCOffset)
      Deprecated.
      Returns:
      activationUTCOffset

    • setActivationUTCOffsetEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationUTCOffsetEditable()
      Deprecated.

    • setExpirationDate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDate(@NotNull @NotNull String expirationDate, boolean isEditable)
      Deprecated.
      Returns:
      What date the strategy should expire.

    • setExpirationDate

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDate(@NotNull @NotNull String expirationDate)
      Deprecated.
      Returns:
      What date the strategy should expire.

    • setExpirationDateEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateEditable()
      Deprecated.

    • setExpirationTime

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationTime(@NotNull @NotNull String expirationTime, boolean isEditable)
      Deprecated.
      Returns:
      What time the strategy should be activated if the ExpirationDate was in the format of yyyymmdd.

    • setExpirationTime

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationTime(@NotNull @NotNull String expirationTime)
      Deprecated.
      Returns:
      What time the strategy should be activated if the ExpirationDate was in the format of yyyymmdd.

    • setExpirationTimeEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationTimeEditable()
      Deprecated.

    • setExpirationLocation

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationLocation(@NotNull @NotNull String expirationLocation, boolean isEditable)
      Deprecated.
      Returns:
      When location should be used to evaluate the time to expire if the ExpirationDate was in the format of yyyymmdd.

    • setExpirationLocation

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationLocation(@NotNull @NotNull String expirationLocation)
      Deprecated.
      Returns:
      When location should be used to evaluate the time to expire if the ExpirationDate was in the format of yyyymmdd.

    • setExpirationLocationEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationLocationEditable()
      Deprecated.

    • setExpirationUTCOffset

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationUTCOffset(@NotNull @NotNull String expirationUTCOffset, boolean isEditable)
      Deprecated.
      Returns:
      expirationUTCOffset

    • setExpirationUTCOffset

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationUTCOffset(@NotNull @NotNull String expirationUTCOffset)
      Deprecated.
      Returns:
      expirationUTCOffset

    • setExpirationUTCOffsetEditable

      @Deprecated @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationUTCOffsetEditable()
      Deprecated.

    • setTemperature

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setTemperature(@NotNull @NotNull String temperature)
      Parameters:
      temperature - e.g. 2
      Returns:
      Shows how close an Order is to its trigger point at the leg level. Shows the maximum of the leg temperatures at the common level [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].

    • setSubmittedDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setSubmittedDateTime(@NotNull @NotNull Instant submittedDateTime)
      Parameters:
      submittedDateTime - e.g. 2023-04-19T11:09:45.00Z
      Returns:
      The time and date a trade or order was submitted

    • setSubmittedDateTime

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setSubmittedDateTime(@NotNull @NotNull String submittedDateTime)
      Parameters:
      submittedDateTime - e.g. 2023-04-19T11:09:45.00Z
      Returns:
      The time and date a trade or order was submitted

    • setFixingSource

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setFixingSource(@NotNull @NotNull String fixingSource)
      Parameters:
      fixingSource - e.g. WMR 8am London Time
      Returns:
      fixingSource

    • setSettlementCurrency

      @NotNull public @NotNull OrderDetailsPartsDef.CommonFields.Builder setSettlementCurrency(@NotNull @NotNull String settlementCurrency)
      Parameters:
      settlementCurrency - e.g. GBP
      Returns:
      A currency for of settlement instruction