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 Summary

Modifier and Type	Method	Description
@NotNull OrderDetailsPartsDef.CommonFields.Builder	addField(@NotNull String key, @NotNull String value)
@NotNull OrderDetailsPartsDef.CommonFields	build()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setAccount(@NotNull String account, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setAccountEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDate(@NotNull String activationDate, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDateEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDateTime(@NotNull String activationDateTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDateTime(@NotNull Instant activationDateTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDateTimeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDisplayTimeZone(@NotNull String activationDisplayTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDisplayTimeZone(@NotNull ZoneId activationDisplayTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationDisplayTimeZoneEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationLocation(@NotNull String activationLocation, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationLocationEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationTime(@NotNull String activationTime, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationTimeEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationType(@NotNull String activationType, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationTypeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationUTCOffset(@NotNull String activationUTCOffset, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setActivationUTCOffsetEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setAlertType(@NotNull String alertType, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setAlertTypeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setAllowedActions(@NotNull String allowedActions)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setCurrencyPair(@NotNull String currencyPair, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setCurrencyPairEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDate(@NotNull String expirationDate, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDateEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDateTime(@NotNull String expirationDateTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDateTime(@NotNull Instant expirationDateTime, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDateTimeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDisplayTimeZone(@NotNull String expirationDisplayTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDisplayTimeZone(@NotNull ZoneId expirationDisplayTimeZone, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationDisplayTimeZoneEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationLocation(@NotNull String expirationLocation, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationLocationEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationTime(@NotNull String expirationTime, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationTimeEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationType(@NotNull String expirationType, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationTypeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationUTCOffset(@NotNull String expirationUTCOffset, boolean isEditable)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setExpirationUTCOffsetEditable()	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setOrderCount(int orderCount)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setOrderCount(@NotNull String orderCount)	Deprecated.
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setOrderID(@NotNull String orderID)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setStrategyType(@NotNull String strategyType, boolean isEditable)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setStrategyTypeEditable()
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setTemperature(@NotNull String temperature)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setTOBOUser(@NotNull String tOBOUser)
@NotNull OrderDetailsPartsDef.CommonFields.Builder	setTraderUsername(@NotNull String traderUsername)
@NotNull String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

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

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>

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]

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

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

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]

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

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

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

setAlertTypeEditable

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

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.

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.

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.

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.

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.

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

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.

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.

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.

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

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 [1=cold,2=warm,3=hot,4=very hot,5=target rate reached].