OrderSource (dxFeed API 3.346)

java.lang.Object
- com.dxfeed.event.IndexedEventSource
- - com.dxfeed.event.market.OrderSource

```
public final class OrderSource
extends IndexedEventSource
```
Identifies source of Order, AnalyticOrder, OtcMarketsOrder, NuamOrder, SpreadOrder and OrderImbalance events. There are the following kinds of order sources:
- Synthetic sources COMPOSITE, COMPOSITE_BID, COMPOSITE_ASK, REGIONAL, REGIONAL_BID, and REGIONAL_ASK are provided for convenience of a consolidated order book and are automatically generated based on the corresponding Quote events.
- Aggregate sources AGGREGATE, AGGREGATE_BID and AGGREGATE_ASK provide futures depth (aggregated by price level) and NASDAQ Level II (top of book for each market maker). These sources are automatically generated based on the corresponding MarketMaker events.
- Publishable sources DEFAULT, NTV, and ISE support full range of dxFeed API features.

Field Summary

Fields
Modifier and Type	Field and Description
`static OrderSource`	`ABE` ABE (abe.io) exchange.
`static OrderSource`	`AGGREGATE` Aggregate order book (futures depth and NASDAQ Level II).
`static OrderSource`	`AGGREGATE_ASK` Deprecated. Use the `AGGREGATE` source.
`static OrderSource`	`AGGREGATE_BID` Deprecated. Use the `AGGREGATE` source.
`static OrderSource`	`arca` NYSE Arca traded securities.
`static OrderSource`	`ARCA` NYSE Arca traded securities.
`static OrderSource`	`BATE` Bats Europe BXE Exchange.
`static OrderSource`	`BI20` Borsa Istanbul Exchange.
`static OrderSource`	`BXTR` Bats Europe TRF.
`static OrderSource`	`BYX` Bats BYX Exchange.
`static OrderSource`	`bzx` Bats BZX Exchange.
`static OrderSource`	`BZX` Bats BZX Exchange.
`static OrderSource`	`C2OX` CBOE Options C2 Exchange.
`static OrderSource`	`cedx` Cboe European Derivatives.
`static OrderSource`	`CEDX` Cboe European Derivatives.
`static OrderSource`	`CEUX` Bats Europe DXE Exchange.
`static OrderSource`	`CFE` CBOE Futures Exchange.
`static OrderSource`	`CHIX` Bats Europe CXE Exchange.
`static OrderSource`	`COMPOSITE` Composite `Quote`.
`static OrderSource`	`COMPOSITE_ASK` Deprecated. Use the `COMPOSITE` source.
`static OrderSource`	`COMPOSITE_BID` Deprecated. Use the `COMPOSITE` source.
`static OrderSource`	`DEA` Direct-Edge EDGA Exchange.
`static OrderSource`	`DEFAULT` Default source for publishing custom order books.
`static OrderSource`	`dex` Direct-Edge EDGX Exchange.
`static OrderSource`	`DEX` Direct-Edge EDGX Exchange.
`static OrderSource`	`edx` EDX Exchange.
`static OrderSource`	`EDX` EDX Exchange.
`static OrderSource`	`ERIS` Eris Exchange group of companies.
`static OrderSource`	`ESPD` NASDAQ eSpeed.
`static OrderSource`	`FAIR` FAIR (FairX) exchange.
`static OrderSource`	`glbx` CME Globex.
`static OrderSource`	`GLBX` CME Globex.
`static OrderSource`	`ICE` Intercontinental Exchange.
`static OrderSource`	`iex` Investors exchange.
`static OrderSource`	`igc` IG CFDs Gate.
`static OrderSource`	`IGC` IG CFDs Gate.
`static OrderSource`	`ISE` International Securities Exchange.
`static OrderSource`	`IST` Borsa Istanbul Exchange.
`static OrderSource`	`memx` Members Exchange.
`static OrderSource`	`MEMX` Members Exchange.
`static OrderSource`	`moon` MOON ATS.
`static OrderSource`	`MOON` MOON ATS.
`static OrderSource`	`NFX` NASDAQ Futures Exchange.
`static OrderSource`	`ntv` NASDAQ Total View.
`static OrderSource`	`NTV` NASDAQ Total View.
`static OrderSource`	`nuam` Nuam Exchange Gate.
`static OrderSource`	`NUAM` Nuam Exchange Gate.
`static OrderSource`	`ocea` Blue Ocean Technologies Alternative Trading System.
`static OrderSource`	`OCEA` Blue Ocean Technologies Alternative Trading System.
`static OrderSource`	`otcm` OTC Overnight.
`static OrderSource`	`OTCM` OTC Overnight.
`static OrderSource`	`pink` Pink Sheets.
`static OrderSource`	`REGIONAL` Regional `Quote`.
`static OrderSource`	`REGIONAL_ASK` Deprecated. Use the `REGIONAL` source.
`static OrderSource`	`REGIONAL_BID` Deprecated. Use the `REGIONAL` source.
`static OrderSource`	`smfe` Small Exchange.
`static OrderSource`	`SMFE` Small Exchange.
`static OrderSource`	`xeur` Eurex Exchange.
`static OrderSource`	`XEUR` Eurex Exchange.
`static OrderSource`	`XNFI` NASDAQ Fixed Income.

Fields inherited from class com.dxfeed.event.IndexedEventSource
id, name

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static List<OrderSource>`	`fullOrderBook()` Returns a list of publishable order sources that support Full Order Book.
`boolean`	`isFullOrderBook()` Returns `true` if this source supports Full Order Book.
`boolean`	`isPublishable(Class<? extends MarketEvent> eventType)` Returns `true` if the given event type can be directly published with this source.
`static boolean`	`isSpecialSourceId(int sourceId)` Determines whether specified source identifier refers to special order source.
`static List<OrderSource>`	`publishable(Class<? extends MarketEvent> eventType)` Returns a list of publishable order sources for a given event type.
`static OrderSource`	`valueOf(int sourceId)` Returns order source for the specified source identifier.
`static OrderSource`	`valueOf(String name)` Returns order source for the specified source name.

Methods inherited from class com.dxfeed.event.IndexedEventSource
equals, hashCode, id, name, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COMPOSITE_BID
```
@Deprecated
public static final OrderSource COMPOSITE_BID
```
    Deprecated. Use the COMPOSITE source.
    
    Bid side of a composite Quote. It is a synthetic and separate source. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to. The subscription on composite Quote event is observed when this source is subscribed to.
  - COMPOSITE_ASK
```
@Deprecated
public static final OrderSource COMPOSITE_ASK
```
    Deprecated. Use the COMPOSITE source.
    
    Ask side of a composite Quote. It is a synthetic and separate source. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to. The subscription on composite Quote event is observed when this source is subscribed to.
  - REGIONAL_BID
```
@Deprecated
public static final OrderSource REGIONAL_BID
```
    Deprecated. Use the REGIONAL source.
    
    Bid side of a regional Quote. It is a synthetic and separate source. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to. The subscription on regional Quote event is observed when this source is subscribed to.
  - REGIONAL_ASK
```
@Deprecated
public static final OrderSource REGIONAL_ASK
```
    Deprecated. Use the REGIONAL source.
    
    Ask side of a regional Quote. It is a synthetic and separate source. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to The subscription on regional Quote event is observed when this source is subscribed to.
  - AGGREGATE_BID
```
@Deprecated
public static final OrderSource AGGREGATE_BID
```
    Deprecated. Use the AGGREGATE source.
    
    Bid side of an aggregate order book (futures depth and NASDAQ Level II). It is a aggregate and separate source. This source cannot be directly published via dxFeed API, but otherwise it is fully operational.
  - AGGREGATE_ASK
```
@Deprecated
public static final OrderSource AGGREGATE_ASK
```
    Deprecated. Use the AGGREGATE source.
    
    Ask side of an aggregate order book (futures depth and NASDAQ Level II). It is a aggregate and separate source. This source cannot be directly published via dxFeed API, but otherwise it is fully operational.
  - COMPOSITE
```
public static final OrderSource COMPOSITE
```
    Composite Quote. It is a synthetic and unitary source, that represents both bid and ask side. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to. The subscription on composite Quote event is observed when this source is subscribed to. To use this source when subscribing to all sources (e.g., when subscribing to an order without specifying a source), instead of COMPOSITE_ASK and COMPOSITE_BID, set the system property dxscheme.unitaryOrderSource to true.
  - REGIONAL
```
public static final OrderSource REGIONAL
```
    Regional Quote. It is a synthetic and unitary source, that represents both bid and ask side. It cannot be used with DXFeed.getIndexedEventsPromise method and it cannot be published directly to. The subscription on regional Quote event is observed when this source is subscribed to. To use this source when subscribing to all sources (e.g., when subscribing to an order without specifying a source), instead of REGIONAL_ASK and REGIONAL_BID, set the system property dxscheme.unitaryOrderSource to true.
  - AGGREGATE
```
public static final OrderSource AGGREGATE
```
    Aggregate order book (futures depth and NASDAQ Level II). It is a aggregate and unitary source, that represents both bid and ask side. This source cannot be directly published via dxFeed API, but otherwise it is fully operational. To use this source when subscribing to all sources (e.g., when subscribing to an order without specifying a source), instead of AGGREGATE_ASK and AGGREGATE_BID, set the system property dxscheme.unitaryOrderSource to true.
  - DEFAULT
```
public static final OrderSource DEFAULT
```
    Default source for publishing custom order books. Order, AnalyticOrder, OtcMarketsOrder, NuamOrder, SpreadOrder and OrderImbalance events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - NTV
```
public static final OrderSource NTV
```
    NASDAQ Total View. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ntv
```
public static final OrderSource ntv
```
    NASDAQ Total View. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - NFX
```
public static final OrderSource NFX
```
    NASDAQ Futures Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ESPD
```
public static final OrderSource ESPD
```
    NASDAQ eSpeed. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - XNFI
```
public static final OrderSource XNFI
```
    NASDAQ Fixed Income. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ICE
```
public static final OrderSource ICE
```
    Intercontinental Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ISE
```
public static final OrderSource ISE
```
    International Securities Exchange. Order and SpreadOrder events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - DEA
```
public static final OrderSource DEA
```
    Direct-Edge EDGA Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - DEX
```
public static final OrderSource DEX
```
    Direct-Edge EDGX Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - dex
```
public static final OrderSource dex
```
    Direct-Edge EDGX Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - BYX
```
public static final OrderSource BYX
```
    Bats BYX Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - BZX
```
public static final OrderSource BZX
```
    Bats BZX Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - bzx
```
public static final OrderSource bzx
```
    Bats BZX Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - BATE
```
public static final OrderSource BATE
```
    Bats Europe BXE Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - CHIX
```
public static final OrderSource CHIX
```
    Bats Europe CXE Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - CEUX
```
public static final OrderSource CEUX
```
    Bats Europe DXE Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - BXTR
```
public static final OrderSource BXTR
```
    Bats Europe TRF. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - IST
```
public static final OrderSource IST
```
    Borsa Istanbul Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - BI20
```
public static final OrderSource BI20
```
    Borsa Istanbul Exchange. Record for particular top 20 order book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ABE
```
public static final OrderSource ABE
```
    ABE (abe.io) exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - FAIR
```
public static final OrderSource FAIR
```
    FAIR (FairX) exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - GLBX
```
public static final OrderSource GLBX
```
    CME Globex. Order and AnalyticOrder events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - glbx
```
public static final OrderSource glbx
```
    CME Globex. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ERIS
```
public static final OrderSource ERIS
```
    Eris Exchange group of companies. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - XEUR
```
public static final OrderSource XEUR
```
    Eurex Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - xeur
```
public static final OrderSource xeur
```
    Eurex Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - CFE
```
public static final OrderSource CFE
```
    CBOE Futures Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - C2OX
```
public static final OrderSource C2OX
```
    CBOE Options C2 Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - SMFE
```
public static final OrderSource SMFE
```
    Small Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - smfe
```
public static final OrderSource smfe
```
    Small Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - iex
```
public static final OrderSource iex
```
    Investors exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - MEMX
```
public static final OrderSource MEMX
```
    Members Exchange. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - memx
```
public static final OrderSource memx
```
    Members Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - OCEA
```
public static final OrderSource OCEA
```
    Blue Ocean Technologies Alternative Trading System. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ocea
```
public static final OrderSource ocea
```
    Blue Ocean Technologies Alternative Trading System. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - pink
```
public static final OrderSource pink
```
    Pink Sheets. Record for price level book. Pink sheets are listings for stocks that trade over-the-counter (OTC). Order and OtcMarketsOrder events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - ARCA
```
public static final OrderSource ARCA
```
    NYSE Arca traded securities. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - arca
```
public static final OrderSource arca
```
    NYSE Arca traded securities. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - CEDX
```
public static final OrderSource CEDX
```
    Cboe European Derivatives. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - cedx
```
public static final OrderSource cedx
```
    Cboe European Derivatives. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - IGC
```
public static final OrderSource IGC
```
    IG CFDs Gate. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - igc
```
public static final OrderSource igc
```
    IG CFDs Gate. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - EDX
```
public static final OrderSource EDX
```
    EDX Exchange. Order and publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - edx
```
public static final OrderSource edx
```
    EDX Exchange. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - NUAM
```
public static final OrderSource NUAM
```
    Nuam Exchange Gate. Order, NuamOrder and OrderImbalance events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - nuam
```
public static final OrderSource nuam
```
    Nuam Exchange Gate. Record for price level book. Order and NuamOrder events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - MOON
```
public static final OrderSource MOON
```
    MOON ATS. Order and publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - moon
```
public static final OrderSource moon
```
    MOON ATS. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - OTCM
```
public static final OrderSource OTCM
```
    OTC Overnight. Order and publishable on this source and the corresponding subscription can be observed via DXPublisher.
  - otcm
```
public static final OrderSource otcm
```
    OTC Overnight. Record for price level book. Order events are publishable on this source and the corresponding subscription can be observed via DXPublisher.
- Method Detail
  - isSpecialSourceId
```
public static boolean isSpecialSourceId(int sourceId)
```
    Determines whether specified source identifier refers to special order source. Special order sources are used for wrapping non-order events into order events.
    
    Parameters:
    
    sourceId - the source identifier.
    
    Returns:
    
    true if it is a special source identifier
  - valueOf
```
public static OrderSource valueOf(int sourceId)
```
    Returns order source for the specified source identifier.
    
    Parameters:
    
    sourceId - the source identifier.
    
    Returns:
    
    order source.
    
    Throws:
    
    IllegalArgumentException - if sourceId is negative or zero.
  - valueOf
```
public static OrderSource valueOf(String name)
```
    Returns order source for the specified source name. The name must be either predefined, or contain at most 4 alphanumeric characters.
    
    Parameters:
    
    name - the name of the source.
    
    Returns:
    
    order source.
    
    Throws:
    
    IllegalArgumentException - if name is malformed.
  - publishable
```
public static List<OrderSource> publishable(Class<? extends MarketEvent> eventType)
```
    Returns a list of publishable order sources for a given event type. These are the sources with isPublishable of true. Events can be directly published with these sources and their subscription can be observed directly via DXPublisher. Subscription on such sources is observed via instances of IndexedEventSubscriptionSymbol class.
    
    Parameters:
    
    eventType - Order.class, AnalyticOrder.class, OtcMarketsOrder.class, NuamOrder.class, SpreadOrder.class or OrderImbalance.class.
    
    Returns:
    
    a list of publishable order sources.
    
    Throws:
    
    IllegalArgumentException - if eventType is not in Order.class, AnalyticOrder.class, OtcMarketsOrder.class, NuamOrder.class, SpreadOrder.class or OrderImbalance.class.
  - fullOrderBook
```
public static List<OrderSource> fullOrderBook()
```
    Returns a list of publishable order sources that support Full Order Book.
    
    Returns:
    
    a list of publishable order sources that support Full Order Book.
  - isPublishable
```
public boolean isPublishable(Class<? extends MarketEvent> eventType)
```
    Returns true if the given event type can be directly published with this source. Subscription on such sources can be observed directly via DXPublisher. Subscription on such sources is observed via instances of IndexedEventSubscriptionSymbol class.
    
    Parameters:
    
    eventType - Order.class, AnalyticOrder.class, OtcMarketsOrder.class, NuamOrder.class SpreadOrder.class or OrderImbalance.class.
    
    Returns:
    
    true if Order, AnalyticOrder, OtcMarketsOrder, NuamOrder and SpreadOrder events can be directly published with this source.
    
    Throws:
    
    IllegalArgumentException - if eventType differs from Order.class, AnalyticOrder.class, OtcMarketsOrder.class, NuamOrder.class, SpreadOrder.class or OrderImbalance.class
  - isFullOrderBook
```
public boolean isFullOrderBook()
```
    Returns true if this source supports Full Order Book.
    
    Returns:
    
    true if this source supports Full Order Book.

Class OrderSource

Field Summary

Fields inherited from class com.dxfeed.event.IndexedEventSource

Method Summary

Methods inherited from class com.dxfeed.event.IndexedEventSource

Methods inherited from class java.lang.Object

Field Detail

COMPOSITE_BID

COMPOSITE_ASK

REGIONAL_BID

REGIONAL_ASK

AGGREGATE_BID

AGGREGATE_ASK

COMPOSITE

REGIONAL

AGGREGATE

DEFAULT

NTV

ntv

NFX

ESPD

XNFI

ICE

ISE

DEA

DEX

dex

BYX

BZX

bzx

BATE

CHIX

CEUX

BXTR

IST

BI20

ABE

FAIR

GLBX

glbx

ERIS

XEUR

xeur

CFE

C2OX

SMFE

smfe

iex

MEMX

memx

OCEA

ocea

pink

ARCA

arca

CEDX

cedx

IGC

igc

EDX

edx

NUAM

nuam

MOON

moon

OTCM

otcm

Method Detail

isSpecialSourceId

valueOf

valueOf

publishable

fullOrderBook

isPublishable

isFullOrderBook