OrderOptions (Lime Brokerage Trading API)

java.lang.Object
- limebrokerage.trading.api.OrderOptions

```
public final class OrderOptions
extends java.lang.Object
```
Order options for US-Equities 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.place(long, int, long, limebrokerage.trading.api.Side, java.lang.String, java.lang.String)

Constructor Summary

Constructors
Constructor and Description

OrderOptions()
Constructs an instance without any options set.

Constructors
Constructor and Description
`OrderOptions()` Constructs an instance without any options set.

Method Summary

Methods
Modifier and Type	Method and Description
`OrderOptions`	`setAllowRouting()` Enables the allow-routing option.
`OrderOptions`	`setArcaPassiveLiquidity()` Enables the ARCA passive liquidity option.
`OrderOptions`	`setArcaPreOpenSession()` Enables the ArcaPreOpenSession option.
`OrderOptions`	`setArcaTracking()` Enables the ARCA tracking option.
`OrderOptions`	`setBatsDarkScan()` Enables the BATS dark-scan option.
`OrderOptions`	`setBatsNoRescrapeAtLimit()` Enables the BATS no-rescrape at-limit option.
`OrderOptions`	`setCeilingFloorPrice(int price)` Enables the ceiling/floor price option.
`OrderOptions`	`setClientData1(java.lang.String clientData)` Enables the client data 1 option.
`OrderOptions`	`setClientData2(java.lang.String clientData)` Enables the client data 2 option.
`OrderOptions`	`setClientData3(java.lang.String clientData)` Enables the client data 3 option.
`OrderOptions`	`setDiscretionOffset(int offset)` Enables the discretion offset option.
`OrderOptions`	`setExpireTime(java.util.Date expire)` Enables the expire-time option.
`OrderOptions`	`setImbalanceOnly()` Enables the imbalance only option.
`OrderOptions`	`setInvisible()` Enables the invisible option.
`OrderOptions`	`setISO(int id)` Enables the ISO option.
`OrderOptions`	`setLockedCrossedAction(LockedCrossedAction action)` Enables the locked/crossed action option.
`OrderOptions`	`setMarketDisplayPrice(int price)` Enables the market display price option.
`OrderOptions`	`setMaxFloor(int floor)` Enables the max-floor option.
`OrderOptions`	`setMinimumTriggerVol(int mtv)` Enables the minimumTriggerVol option.
`OrderOptions`	`setMinQuantity(int qty)` Enables the min-quantity option.
`OrderOptions`	`setNasdaqPostOnly()` Enables the Nasdaq post-only option.
`OrderOptions`	`setNYSEClosingOffset()` Enables the NYSE closing-offset option.
`OrderOptions`	`setNyseParityStrategy(java.lang.String strategy)` Enables the NYSE parity-strategy option.
`OrderOptions`	`setPegDifference(int difference)` Enables the peg-difference option.
`OrderOptions`	`setPegOffsets(int near, int far)` Enables the peg-offsets option.
`OrderOptions`	`setPegType(PegType type)` Enables the peg-type option.
`OrderOptions`	`setPostOnly()` Enables the post-only option.
`OrderOptions`	`setRegularSessionOnly()` Enables the regular session only option.
`OrderOptions`	`setRetailPriceOffset(int offset)` Enables the retail price offset option.
`OrderOptions`	`setRouteToNYSE()` Enables the route-to-NYSE option.
`OrderOptions`	`setRoutingInstructions(RoutingInstructions instructions)` Enables the routing-instructions option.
`OrderOptions`	`setRoutingStrategy(java.lang.String strategy)` Enables the routing strategy option.
`OrderOptions`	`setSaleAffirm()` Enables the sale affirm option.
`OrderOptions`	`setShortSaleAffirmLongQuantity(int quantity)` Enables the short-sale affirm long-quantity option.
`OrderOptions`	`setTargetLocationId(java.lang.String location)` Enables the target-location id option.
`OrderOptions`	`setTimeInForce(TimeInForce tif)` Enables the time-in-force option.
`OrderOptions`	`setTimeInMarket(int seconds)` Enables the time-in-market option.
`OrderOptions`	`setWashTradePrevention(WashTradePrevention wash)` Enables the wash-trade prevention option.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OrderOptions
```
public OrderOptions()
```
    Constructs an instance without any options set.
- Method Detail
  - setRegularSessionOnly
```
public OrderOptions setRegularSessionOnly()
```
    Enables the regular session only option.
    
    Returns:
    itself
  - setSaleAffirm
```
public OrderOptions setSaleAffirm()
```
    Enables the sale affirm option. This option is needed for sale affirmation for DVP accounts.
    
    Returns:
    itself
  - setImbalanceOnly
```
public OrderOptions setImbalanceOnly()
```
    Enables the imbalance only option.
    
    Returns:
    itself
  - setNasdaqPostOnly
```
public OrderOptions setNasdaqPostOnly()
```
    Enables the Nasdaq post-only option. An order with this option set will either add liquidity or be rejected. Only valid for orders sent to Nasdaq.
    
    Returns:
    itself
  - setPostOnly
```
public OrderOptions setPostOnly()
```
    Enables the post-only option. An order with this option set will either add liquidity or be rejected.
    
    Returns:
    itself
  - setInvisible
```
public OrderOptions setInvisible()
```
    Enables the invisible option. An order with this option set will not be displayed on the market's order book.
    
    Returns:
    itself
  - setAllowRouting
```
public OrderOptions 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
  - setBatsDarkScan
```
public OrderOptions setBatsDarkScan()
```
    Enables the BATS dark-scan option.
    
    Returns:
    itself
  - setBatsNoRescrapeAtLimit
```
public OrderOptions setBatsNoRescrapeAtLimit()
```
    Enables the BATS no-rescrape at-limit option.
    
    Returns:
    itself
  - setArcaTracking
```
public OrderOptions setArcaTracking()
```
    Enables the ARCA tracking option.
    
    Returns:
    itself
  - setArcaPassiveLiquidity
```
public OrderOptions setArcaPassiveLiquidity()
```
    Enables the ARCA passive liquidity option.
    
    Returns:
    itself
  - setRouteToNYSE
```
public OrderOptions setRouteToNYSE()
```
    Enables the route-to-NYSE option.
    
    Returns:
    itself
  - setNYSEClosingOffset
```
public OrderOptions setNYSEClosingOffset()
```
    Enables the NYSE closing-offset option.
    
    Returns:
    itself
  - setArcaPreOpenSession
```
public OrderOptions setArcaPreOpenSession()
```
    Enables the ArcaPreOpenSession option. An order with this option set will only interact with Arca trading session 1
    
    Returns:
    itself
  - setTimeInForce
```
public OrderOptions 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-Equities order
  - setPegType
```
public OrderOptions setPegType(PegType type)
```
    Enables the peg-type option.
    
    Parameters:
    type - peg-type value
    
    Returns:
    itself
  - setWashTradePrevention
```
public OrderOptions setWashTradePrevention(WashTradePrevention wash)
```
    Enables the wash-trade prevention option. This option designates the proper action to take (by the market) if the order washes against another Lime customer's order. Only specially configured accounts can utilize this option.
    
    Parameters:
    wash - wash-trade prevention value
    
    Returns:
    itself
  - setExpireTime
```
public OrderOptions 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 OrderOptions 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-Equities order
  - setLockedCrossedAction
```
public OrderOptions setLockedCrossedAction(LockedCrossedAction action)
```
    Enables the locked/crossed action option. This option designates the proper action to take (by the market) if the order would lock or cross the market.
    
    Parameters:
    action - locked/crossed action
    
    Returns:
    itself
  - setTargetLocationId
```
public OrderOptions setTargetLocationId(java.lang.String location)
```
    Enables the target-location id option.
    
    Parameters:
    location - target-location id
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setNyseParityStrategy
```
public OrderOptions setNyseParityStrategy(java.lang.String strategy)
```
    Enables the NYSE parity-strategy option.
    
    Parameters:
    strategy - NYSE parity-strategy
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setTimeInMarket
```
public OrderOptions setTimeInMarket(int seconds)
```
    Enables the time-in-market option. This option must only be set in conjunction with the TimeInForce.TIME_IN_MARKET TIF option and is required for it. It determines how long, in seconds, until the order should expire.
    
    Parameters:
    seconds - seconds until order expires
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting negative or zero seconds, or seconds larger than in a day
    See Also:
    TimeInForce.TIME_IN_MARKET
  - setPegDifference
```
public OrderOptions setPegDifference(int difference)
```
    Enables the peg-difference option.
    
    Parameters:
    difference - peg-difference value (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setMaxFloor
```
public OrderOptions 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 OrderOptions 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 OrderOptions 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
  - setMinimumTriggerVol
```
public OrderOptions setMinimumTriggerVol(int mtv)
```
    Enables the minimumTriggerVol option.
    
    Parameters:
    mtv - minimum Trigger Volume
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative minimum Trigger Volume
  - setDiscretionOffset
```
public OrderOptions setDiscretionOffset(int offset)
```
    Enables the discretion offset option.
    
    Parameters:
    offset - discretion offset (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setShortSaleAffirmLongQuantity
```
public OrderOptions setShortSaleAffirmLongQuantity(int quantity)
```
    Enables the short-sale affirm long-quantity option. This option is required for certain accounts and affirms that the client has the given long position in the security being traded. This option can only be set for orders which are short-sales. The value must be greater than zero.
    
    Parameters:
    quantity - long position being affirmed
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero value
    See Also:
    setSaleAffirm()
  - setMarketDisplayPrice
```
public OrderOptions setMarketDisplayPrice(int price)
```
    Enables the market display price option. This option determines what price the order will be displayed as on the order book.
    
    Parameters:
    price - market display price (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero price
  - setRetailPriceOffset
```
public OrderOptions setRetailPriceOffset(int offset)
```
    Enables the retail price offset option.
    
    Parameters:
    offset - retail price offset value (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
  - setCeilingFloorPrice
```
public OrderOptions setCeilingFloorPrice(int price)
```
    Enables the ceiling/floor price option.
    
    Parameters:
    price - ceiling/floor price value (scaled by Client.PRICE_SCALE)
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting a negative or zero price
  - setPegOffsets
```
public OrderOptions setPegOffsets(int near,
                         int far)
```
    Enables the peg-offsets option. The near and far peg-offsets are expressed as percentages, scaled by 100.
    
    Parameters:
    near - near peg-offset value (must be between 0 and 100)
    far - far peg-offset value (must be between 0 and 100)
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting peg-offsets which are negative or exceed 100
  - setRoutingStrategy
```
public OrderOptions setRoutingStrategy(java.lang.String strategy)
```
    Enables the routing strategy option.
    
    Parameters:
    strategy - routing strategy value
    
    Returns:
    itself
    
    Throws:
    
    java.lang.IllegalArgumentException - setting an empty or too large string
  - setClientData1
```
public OrderOptions 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 OrderOptions 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 OrderOptions 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

Class OrderOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OrderOptions

Method Detail

setRegularSessionOnly

setSaleAffirm

setImbalanceOnly

setNasdaqPostOnly

setPostOnly

setInvisible

setAllowRouting

setBatsDarkScan

setBatsNoRescrapeAtLimit

setArcaTracking

setArcaPassiveLiquidity

setRouteToNYSE

setNYSEClosingOffset

setArcaPreOpenSession

setTimeInForce

setPegType

setWashTradePrevention

setExpireTime

setRoutingInstructions

setLockedCrossedAction

setTargetLocationId

setNyseParityStrategy

setTimeInMarket

setPegDifference

setMaxFloor

setMinQuantity

setISO

setMinimumTriggerVol

setDiscretionOffset

setShortSaleAffirmLongQuantity

setMarketDisplayPrice

setRetailPriceOffset

setCeilingFloorPrice

setPegOffsets

setRoutingStrategy

setClientData1

setClientData2

setClientData3

Reach Us

General Inquiries

Quant & Algo Traders