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

Class OrderDetailsPartsDef.CommonFields.Builder

    • Method Detail

      • toString

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

      • setCurrencyPair

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

      • setCurrencyPair

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

      • setAccount

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAccount​(@NotNull
                                                                     @NotNull java.lang.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 java.lang.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>

      • setAllowedActions

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAllowedActions​(@NotNull
                                                                            @NotNull java.lang.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 java.lang.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 java.lang.String activationType)
        Returns:
        How the order should be activated. Caplin supported statuses are [GFA, EXPLICIT]

      • setActivationDateTime

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDateTime​(@NotNull
                                                                                @NotNull java.time.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 java.time.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 java.lang.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 java.lang.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.

      • setActivationDisplayTimeZone

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationDisplayTimeZone​(@NotNull
                                                                                       @NotNull java.time.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 java.time.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 java.lang.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 java.lang.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.

      • setExpirationType

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationType​(@NotNull
                                                                            @NotNull java.lang.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 java.lang.String expirationType)
        Returns:
        How the order should be deactivated. Caplin supported statuses are [IOC, GTC, GFD, FOK, EXPLICIT]

      • setExpirationDateTime

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDateTime​(@NotNull
                                                                                @NotNull java.time.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 java.time.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 java.lang.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 java.lang.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.

      • setExpirationDisplayTimeZone

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationDisplayTimeZone​(@NotNull
                                                                                       @NotNull java.time.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 java.time.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 java.lang.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 java.lang.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.

      • setAlertType

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setAlertType​(@NotNull
                                                                       @NotNull java.lang.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 java.lang.String alertType)
        Returns:
        The type of alert that an order will send. Caplin supported statuses are [EMAIL, SMS].

      • setStrategyType

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setStrategyType​(@NotNull
                                                                          @NotNull java.lang.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 java.lang.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.

      • setTraderUsername

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setTraderUsername​(@NotNull
                                                                            @NotNull java.lang.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 java.lang.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.

      • setEntityId

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setEntityId​(@NotNull
                                                                      @NotNull java.lang.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 java.lang.String entityDescription)
        Parameters:
        entityDescription - e.g. Customer 1
        Returns:
        The description of a trade on behalf of entity.

      • setActivationDate

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

      • setActivationDate

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

      • setActivationTime

        @Deprecated
@NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationTime​(@NotNull
                                                                            @NotNull java.lang.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 java.lang.String activationTime)
        Deprecated.
        Returns:
        What time the strategy should be activated if the ActivationDate was in the format of yyyymmdd.

      • setActivationLocation

        @Deprecated
@NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setActivationLocation​(@NotNull
                                                                                @NotNull java.lang.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 java.lang.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.

      • setActivationUTCOffset

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

      • setActivationUTCOffset

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

      • setExpirationDate

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

      • setExpirationDate

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

      • setExpirationTime

        @Deprecated
@NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationTime​(@NotNull
                                                                            @NotNull java.lang.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 java.lang.String expirationTime)
        Deprecated.
        Returns:
        What time the strategy should be activated if the ExpirationDate was in the format of yyyymmdd.

      • setExpirationLocation

        @Deprecated
@NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setExpirationLocation​(@NotNull
                                                                                @NotNull java.lang.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 java.lang.String expirationLocation)
        Deprecated.
        Returns:
        When location should be used to evaluate the time to expire if the ExpirationDate was in the format of yyyymmdd.

      • setExpirationUTCOffset

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

      • setExpirationUTCOffset

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

      • setTemperature

        @NotNull
public @NotNull OrderDetailsPartsDef.CommonFields.Builder setTemperature​(@NotNull
                                                                         @NotNull java.lang.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 java.time.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 java.lang.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 java.lang.String fixingSource)
        Parameters:
        fixingSource - e.g. WMR 8am London Time
        Returns:
        fixingSource

      • setSettlementCurrency

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