UnderlyingInstrument (CME STP (Straight Through Processing) Handler Parent 3.1.1 API)

java.lang.Object
- biz.onixs.cme.stp.handler.UnderlyingInstrument

public class UnderlyingInstrument
extends Object

Information about underlying instrument.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UnderlyingInstrument.InstrumentStreams
Encapsulates the list of InstrumentStreams

Nested Classes
Modifier and Type	Class and Description
`static class`	`UnderlyingInstrument.InstrumentStreams` Encapsulates the list of InstrumentStreams

Constructor Summary

Constructors
Constructor and Description

UnderlyingInstrument()
Default constructor.

Constructors
Constructor and Description
`UnderlyingInstrument()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnderlyingInstrument.InstrumentStreams`	`getStreams()`
`ScaledDecimal`	`getUnderlyingDirtyPrice()` Gets Price (percent-of-par or per unit) of the underlying security or basket.
`String`	`getUnderlyingMaturity()`
`ScaledDecimal`	`getUnderlyingPrice()`
`String`	`getUnderlyingProductCode()`
`String`	`getUnderlyingProductCodeSource()`
`String`	`getUnderlyingProductExchange()`
`SecurityType`	`getUnderlyingSecurityType()`
`String`	`getUnderlyingSymbol()`
`UnderlyingSymbolSfx`	`getUnderlyingSymbolSfx()`
`void`	`setUnderlyingDirtyPrice(ScaledDecimal value)` Sets Price (percent-of-par or per unit) of the underlying security or basket.
`void`	`setUnderlyingMaturity(String value)`
`void`	`setUnderlyingPrice(ScaledDecimal value)`
`void`	`setUnderlyingProductCode(String value)`
`void`	`setUnderlyingProductCodeSource(String value)`
`void`	`setUnderlyingProductExchange(String value)`
`void`	`setUnderlyingSecurityType(SecurityType value)`
`void`	`setUnderlyingSymbol(String value)`
`void`	`setUnderlyingSymbolSfx(UnderlyingSymbolSfx value)`

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

- Constructor Detail
  - UnderlyingInstrument
```
public UnderlyingInstrument()
```
    Default constructor.
- Method Detail
  - getUnderlyingProductCode
```
public final String getUnderlyingProductCode()
```
    Returns:
    
    primary identifier for the underlying instrument.
  - setUnderlyingProductCode
```
public final void setUnderlyingProductCode(String value)
```
    Parameters:
    
    value - primary identifier for the underlying instrument.
  - getUnderlyingProductCodeSource
```
public final String getUnderlyingProductCodeSource()
```
    Returns:
    
    the source of the underlying instrument.
  - setUnderlyingProductCodeSource
```
public final void setUnderlyingProductCodeSource(String value)
```
    Parameters:
    
    value - the source of the underlying instrument.
  - getUnderlyingSecurityType
```
public final SecurityType getUnderlyingSecurityType()
```
    Returns:
    
    the type of underlying security being reported.
  - setUnderlyingSecurityType
```
public final void setUnderlyingSecurityType(SecurityType value)
```
    Parameters:
    
    value - the type of underlying security being reported.
  - getUnderlyingMaturity
```
public final String getUnderlyingMaturity()
```
    Returns:
    
    the expiration period code of an underlying instrument.
  - setUnderlyingMaturity
```
public final void setUnderlyingMaturity(String value)
```
    Parameters:
    
    value - the expiration period code of an underlying instrument.
  - getUnderlyingProductExchange
```
public final String getUnderlyingProductExchange()
```
    Returns:
    
    the exchange on which the underlying security is listed.
  - setUnderlyingProductExchange
```
public final void setUnderlyingProductExchange(String value)
```
    Parameters:
    
    value - the exchange on which the underlying security is listed.
  - getUnderlyingSymbol
```
public final String getUnderlyingSymbol()
```
    Returns:
    
    underlying symbol.
  - setUnderlyingSymbol
```
public final void setUnderlyingSymbol(String value)
```
    Parameters:
    
    value - underlying symbol.
  - getUnderlyingPrice
```
public final ScaledDecimal getUnderlyingPrice()
```
    Returns:
    
    underlying price associate with a derivative instrument.
  - setUnderlyingPrice
```
public final void setUnderlyingPrice(ScaledDecimal value)
```
    Parameters:
    
    value - underlying price associate with a derivative instrument.
  - getUnderlyingDirtyPrice
```
public final ScaledDecimal getUnderlyingDirtyPrice()
```
    Gets Price (percent-of-par or per unit) of the underlying security or basket. "Dirty" means it includes accrued interest.
    
    Returns:
    
    Underlying Dirty Price
  - setUnderlyingDirtyPrice
```
public final void setUnderlyingDirtyPrice(ScaledDecimal value)
```
    Sets Price (percent-of-par or per unit) of the underlying security or basket. "Dirty" means it includes accrued interest.
    
    Parameters:
    
    value - Underlying Dirty Price
  - getUnderlyingSymbolSfx
```
public final UnderlyingSymbolSfx getUnderlyingSymbolSfx()
```
    Returns:
    
    Underlying Symbol Sfx.
  - setUnderlyingSymbolSfx
```
public final void setUnderlyingSymbolSfx(UnderlyingSymbolSfx value)
```
    Parameters:
    
    value - Underlying Symbol Sfx
  - getStreams
```
public UnderlyingInstrument.InstrumentStreams getStreams()
```
    Returns:
    
    Information about underlying instrument streams reported.

Class UnderlyingInstrument

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UnderlyingInstrument

Method Detail

getUnderlyingProductCode

setUnderlyingProductCode

getUnderlyingProductCodeSource

setUnderlyingProductCodeSource

getUnderlyingSecurityType

setUnderlyingSecurityType

getUnderlyingMaturity

setUnderlyingMaturity

getUnderlyingProductExchange

setUnderlyingProductExchange

getUnderlyingSymbol

setUnderlyingSymbol

getUnderlyingPrice

setUnderlyingPrice

getUnderlyingDirtyPrice

setUnderlyingDirtyPrice

getUnderlyingSymbolSfx

setUnderlyingSymbolSfx

getStreams