limebrokerage.trading.api

Class USOptionsOrderOptions

java.lang.Object

limebrokerage.trading.api.USOptionsOrderOptions

public final class USOptionsOrderOptions
extends java.lang.Object

Order options for US-Options orders. All setters return the object, so that multiple sets can be easily chained together.

Not all order options are applicable for all venues or account types. Setting an option where not allowed or not applicable will result in an order reject.

See Also:

Client.placeUSOptions(long, int, long, limebrokerage.trading.api.Side, limebrokerage.trading.api.PositionEffect, limebrokerage.trading.api.USOptionsSymbol, java.lang.String)

Constructor Summary

Constructors

Constructor and Description
USOptionsOrderOptions() Constructs an instance without any options set.

Method Summary

Methods

Modifier and Type	Method and Description
USOptionsOrderOptions	setAllOrNone() Enables the all-or-none option.
USOptionsOrderOptions	setAllowRouting() Enables the allow-routing option.
USOptionsOrderOptions	setArcaTracking() Enables the ARCA tracking option.
USOptionsOrderOptions	setClientData1(java.lang.String clientData) Enables the client data 1 option.
USOptionsOrderOptions	setClientData2(java.lang.String clientData) Enables the client data 2 option.
USOptionsOrderOptions	setClientData3(java.lang.String clientData) Enables the client data 3 option.
USOptionsOrderOptions	setCustomerType(CustomerType type) Enables the customer-type option.
USOptionsOrderOptions	setDiscretionOffset(int offset) Enables the discretion offset option.
USOptionsOrderOptions	setExpireTime(java.util.Date expire) Enables the expire-time option.
USOptionsOrderOptions	setIseDisplayRange(int range) Enables the ISE display-range option.
USOptionsOrderOptions	setIseDisplayWhen(byte when) Enables the ISE display-when option.
USOptionsOrderOptions	setIseExposureFlag(java.lang.String flag) Enables the ISE exposure flag option.
USOptionsOrderOptions	setISO(int id) Enables the ISO option.
USOptionsOrderOptions	setMaxFloor(int floor) Enables the max-floor option.
USOptionsOrderOptions	setMinQuantity(int qty) Enables the min-quantity option.
USOptionsOrderOptions	setPostOnly() Enables the post-only option.
USOptionsOrderOptions	setRoutingInstructions(RoutingInstructions instructions) Enables the routing-instructions option.
USOptionsOrderOptions	setTimeInForce(TimeInForce tif) Enables the time-in-force option.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

USOptionsOrderOptions

public USOptionsOrderOptions()

Constructs an instance without any options set.

Method Detail

setPostOnly

public USOptionsOrderOptions setPostOnly()

Enables the post-only option. An order with this option set will either add liquidity or be rejected.

Returns:

itself

setAllowRouting

public USOptionsOrderOptions setAllowRouting()

Enables the allow-routing option. An order with this option set is eligible to be routed out by the market to another venue.

Returns:

itself

setArcaTracking

public USOptionsOrderOptions setArcaTracking()

Enables the ARCA tracking option.

Returns:

itself

setAllOrNone

public USOptionsOrderOptions setAllOrNone()

Enables the all-or-none option. An order with this option set will only fill in its entirety.

Returns:

itself

setTimeInForce

public USOptionsOrderOptions setTimeInForce(TimeInForce tif)

Enables the time-in-force option. This option determines how long the order will remain live. The default is to stay live for the rest of the day. Certain TIF values may require additional options set.

Parameters:

tif - Time-in-force setting

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting a TIF value not appropriate for an US-Options order

setExpireTime

public USOptionsOrderOptions setExpireTime(java.util.Date expire)

Enables the expire-time option. This option must only be set in conjunction with the TimeInForce.GOOD_TILL_DATE TIF option and is required for it. It determines the time when the order should expire.

Parameters:

expire - expiration time

Returns:

itself

See Also:

TimeInForce.GOOD_TILL_DATE

setRoutingInstructions

public USOptionsOrderOptions setRoutingInstructions(RoutingInstructions instructions)

Enables the routing-instructions option. This option gives market specific instructions how to the order should be routed by the market to other venues.

Parameters:

instructions - routing instructions

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting routing instructions not valid for an US-Options order

setCustomerType

public USOptionsOrderOptions setCustomerType(CustomerType type)

Enables the customer-type option. Certain accounts are configured to allow specifying their class of account rather than have it configured in the Lime-Brokerage trading-server.

Parameters:

type - Customer type

Returns:

itself

setClientData1

public USOptionsOrderOptions setClientData1(java.lang.String clientData)

Enables the client data 1 option. The contents of this option will be echoed on fills.

Parameters:

clientData - client data 1 value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting an empty or too large string

setClientData2

public USOptionsOrderOptions setClientData2(java.lang.String clientData)

Enables the client data 2 option. The contents of this option will be echoed on fills.

Parameters:

clientData - client data 2 value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting an empty or too large string

setClientData3

public USOptionsOrderOptions setClientData3(java.lang.String clientData)

Enables the client data 3 option. The contents of this option will be echoed on fills.

Parameters:

clientData - client data 3 value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting an empty or too large string

setIseExposureFlag

public USOptionsOrderOptions setIseExposureFlag(java.lang.String flag)

Enables the ISE exposure flag option.

Parameters:

flag - ISE exposure flag value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting an empty or too long flag value

setMaxFloor

public USOptionsOrderOptions setMaxFloor(int floor)

Enables the max-floor option.

Parameters:

floor - max floor value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting a negative or zero max-floor

setMinQuantity

public USOptionsOrderOptions setMinQuantity(int qty)

Enables the min-quantity option.

Parameters:

qty - min-quantity value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting a negative or zero min-quantity

setISO

public USOptionsOrderOptions setISO(int id)

Enables the ISO option. An account must be configured to allow for ISO orders. Every ISO order requires an associated group-id, which identifies all orders in the same ISO sweep.

Parameters:

id - ISO group-id

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting a negative or zero group-id

setDiscretionOffset

public USOptionsOrderOptions setDiscretionOffset(int offset)

Enables the discretion offset option.

Parameters:

offset - discretion offset (scaled by Client.PRICE_SCALE)

Returns:

itself

setIseDisplayWhen

public USOptionsOrderOptions setIseDisplayWhen(byte when)

Enables the ISE display-when option.

Parameters:

when - ISE display-when value

Returns:

itself

Throws:

java.lang.IllegalArgumentException - setting an invalid value

setIseDisplayRange

public USOptionsOrderOptions setIseDisplayRange(int range)

Enables the ISE display-range option.

Parameters:

range - ISE display-range value

Returns:

itself