UnderlyingInstrumentBlock (FIX Antenna Java 2.24.0 API Documentation)

java.lang.Object
- com.epam.fix.model.fix50sp1.block.UnderlyingInstrumentBlock

All Implemented Interfaces:: com.epam.fix.model.Block

public class UnderlyingInstrumentBlock
extends Object
implements com.epam.fix.model.Block

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup

Nested Classes
Modifier and Type	Class and Description
`class`	`UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup`

Constructor Summary

Constructors
Constructor and Description

UnderlyingInstrumentBlock()

Constructors
Constructor and Description
`UnderlyingInstrumentBlock()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`fromFIX(FIXFieldList l)`
`String`	`getEncodedUnderlyingIssuer()`
`Long`	`getEncodedUnderlyingIssuerLen()`
`String`	`getEncodedUnderlyingSecurityDesc()`
`Long`	`getEncodedUnderlyingSecurityDescLen()`
`int`	`getNoUnderlyingSecurityAltID()`
`Double`	`getUnderlyingAdjustedQuantity()`
`Double`	`getUnderlyingAllocationPercent()`
`Double`	`getUnderlyingCapValue()`
`Double`	`getUnderlyingCashAmount()`
`String`	`getUnderlyingCashType()`
`String`	`getUnderlyingCFICode()`
`Double`	`getUnderlyingContractMultiplier()`
`String`	`getUnderlyingCountryOfIssue()`
`Calendar`	`getUnderlyingCouponPaymentDate()`
`Double`	`getUnderlyingCouponRate()`
`String`	`getUnderlyingCPProgram()`
`String`	`getUnderlyingCPRegType()`
`String`	`getUnderlyingCreditRating()`
`String`	`getUnderlyingCurrency()`
`Double`	`getUnderlyingCurrentValue()`
`Double`	`getUnderlyingDirtyPrice()`
`Double`	`getUnderlyingEndPrice()`
`Double`	`getUnderlyingEndValue()`
`Long`	`getUnderlyingExerciseStyle()`
`Double`	`getUnderlyingFactor()`
`Double`	`getUnderlyingFXRate()`
`Character`	`getUnderlyingFXRateCalc()`
`String`	`getUnderlyingInstrRegistry()`
`Calendar`	`getUnderlyingIssueDate()`
`String`	`getUnderlyingIssuer()`
`String`	`getUnderlyingLocaleOfIssue()`
`Calendar`	`getUnderlyingMaturityDate()`
`Calendar`	`getUnderlyingMaturityMonthYear()`
`Calendar`	`getUnderlyingMaturityTime()`
`Character`	`getUnderlyingOptAttribute()`
`String`	`getUnderlyingPriceUnitOfMeasure()`
`Double`	`getUnderlyingPriceUnitOfMeasureQty()`
`Long`	`getUnderlyingProduct()`
`Long`	`getUnderlyingPutOrCall()`
`Double`	`getUnderlyingPx()`
`Double`	`getUnderlyingQty()`
`Calendar`	`getUnderlyingRedemptionDate()`
`String`	`getUnderlyingRepoCollateralSecurityType()`
`Double`	`getUnderlyingRepurchaseRate()`
`Long`	`getUnderlyingRepurchaseTerm()`
`Collection<UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup>`	`getUnderlyingSecurityAltIDGroup()`
`String`	`getUnderlyingSecurityDesc()`
`String`	`getUnderlyingSecurityExchange()`
`String`	`getUnderlyingSecurityID()`
`String`	`getUnderlyingSecurityIDSource()`
`String`	`getUnderlyingSecuritySubType()`
`String`	`getUnderlyingSecurityType()`
`Long`	`getUnderlyingSettlementType()`
`String`	`getUnderlyingSettlMethod()`
`Double`	`getUnderlyingStartValue()`
`String`	`getUnderlyingStateOrProvinceOfIssue()`
`UnderlyingStipulationsBlock`	`getUnderlyingStipulations()`
`String`	`getUnderlyingStrikeCurrency()`
`Double`	`getUnderlyingStrikePrice()`
`String`	`getUnderlyingSymbol()`
`String`	`getUnderlyingSymbolSfx()`
`String`	`getUnderlyingTimeUnit()`
`String`	`getUnderlyingUnitOfMeasure()`
`Double`	`getUnderlyingUnitOfMeasureQty()`
`UndlyInstrumentPartiesBlock`	`getUndlyInstrumentParties()`
`void`	`setEncodedUnderlyingIssuer(String value)`
`void`	`setEncodedUnderlyingIssuerLen(Long value)`
`void`	`setEncodedUnderlyingSecurityDesc(String value)`
`void`	`setEncodedUnderlyingSecurityDescLen(Long value)`
`void`	`setNoUnderlyingSecurityAltID(int value)`
`void`	`setUnderlyingAdjustedQuantity(Double value)`
`void`	`setUnderlyingAllocationPercent(Double value)`
`void`	`setUnderlyingCapValue(Double value)`
`void`	`setUnderlyingCashAmount(Double value)`
`void`	`setUnderlyingCashType(String value)`
`void`	`setUnderlyingCFICode(String value)`
`void`	`setUnderlyingContractMultiplier(Double value)`
`void`	`setUnderlyingCountryOfIssue(String value)`
`void`	`setUnderlyingCouponPaymentDate(Calendar value)`
`void`	`setUnderlyingCouponRate(Double value)`
`void`	`setUnderlyingCPProgram(String value)`
`void`	`setUnderlyingCPRegType(String value)`
`void`	`setUnderlyingCreditRating(String value)`
`void`	`setUnderlyingCurrency(String value)`
`void`	`setUnderlyingCurrentValue(Double value)`
`void`	`setUnderlyingDirtyPrice(Double value)`
`void`	`setUnderlyingEndPrice(Double value)`
`void`	`setUnderlyingEndValue(Double value)`
`void`	`setUnderlyingExerciseStyle(Long value)`
`void`	`setUnderlyingFactor(Double value)`
`void`	`setUnderlyingFXRate(Double value)`
`void`	`setUnderlyingFXRateCalc(Character value)`
`void`	`setUnderlyingInstrRegistry(String value)`
`void`	`setUnderlyingIssueDate(Calendar value)`
`void`	`setUnderlyingIssuer(String value)`
`void`	`setUnderlyingLocaleOfIssue(String value)`
`void`	`setUnderlyingMaturityDate(Calendar value)`
`void`	`setUnderlyingMaturityMonthYear(Calendar value)`
`void`	`setUnderlyingMaturityTime(Calendar value)`
`void`	`setUnderlyingOptAttribute(Character value)`
`void`	`setUnderlyingPriceUnitOfMeasure(String value)`
`void`	`setUnderlyingPriceUnitOfMeasureQty(Double value)`
`void`	`setUnderlyingProduct(Long value)`
`void`	`setUnderlyingPutOrCall(Long value)`
`void`	`setUnderlyingPx(Double value)`
`void`	`setUnderlyingQty(Double value)`
`void`	`setUnderlyingRedemptionDate(Calendar value)`
`void`	`setUnderlyingRepoCollateralSecurityType(String value)`
`void`	`setUnderlyingRepurchaseRate(Double value)`
`void`	`setUnderlyingRepurchaseTerm(Long value)`
`void`	`setUnderlyingSecurityAltIDGroup(Collection<UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup> value)`
`void`	`setUnderlyingSecurityDesc(String value)`
`void`	`setUnderlyingSecurityExchange(String value)`
`void`	`setUnderlyingSecurityID(String value)`
`void`	`setUnderlyingSecurityIDSource(String value)`
`void`	`setUnderlyingSecuritySubType(String value)`
`void`	`setUnderlyingSecurityType(String value)`
`void`	`setUnderlyingSettlementType(Long value)`
`void`	`setUnderlyingSettlMethod(String value)`
`void`	`setUnderlyingStartValue(Double value)`
`void`	`setUnderlyingStateOrProvinceOfIssue(String value)`
`void`	`setUnderlyingStipulations(UnderlyingStipulationsBlock value)`
`void`	`setUnderlyingStrikeCurrency(String value)`
`void`	`setUnderlyingStrikePrice(Double value)`
`void`	`setUnderlyingSymbol(String value)`
`void`	`setUnderlyingSymbolSfx(String value)`
`void`	`setUnderlyingTimeUnit(String value)`
`void`	`setUnderlyingUnitOfMeasure(String value)`
`void`	`setUnderlyingUnitOfMeasureQty(Double value)`
`void`	`setUndlyInstrumentParties(UndlyInstrumentPartiesBlock value)`
`void`	`toFIX(FIXFieldList l)`

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

Constructor Detail
- UnderlyingInstrumentBlock
```
public UnderlyingInstrumentBlock()
```

Method Detail

getUnderlyingSymbol
```
public String getUnderlyingSymbol()
```

setUnderlyingSymbol

public void setUnderlyingSymbol(String value)

getUnderlyingSymbolSfx

public String getUnderlyingSymbolSfx()

setUnderlyingSymbolSfx

public void setUnderlyingSymbolSfx(String value)

getUnderlyingSecurityID

public String getUnderlyingSecurityID()

setUnderlyingSecurityID

public void setUnderlyingSecurityID(String value)

getUnderlyingSecurityIDSource

public String getUnderlyingSecurityIDSource()

setUnderlyingSecurityIDSource

public void setUnderlyingSecurityIDSource(String value)

getNoUnderlyingSecurityAltID

public int getNoUnderlyingSecurityAltID()

setNoUnderlyingSecurityAltID

public void setNoUnderlyingSecurityAltID(int value)

getUnderlyingSecurityAltIDGroup

public Collection<UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup> getUnderlyingSecurityAltIDGroup()

setUnderlyingSecurityAltIDGroup

public void setUnderlyingSecurityAltIDGroup(Collection<UnderlyingInstrumentBlock.UnderlyingSecurityAltIDGroup> value)

getUnderlyingProduct
```
public Long getUnderlyingProduct()
```

setUnderlyingProduct

public void setUnderlyingProduct(Long value)

getUnderlyingCFICode
```
public String getUnderlyingCFICode()
```

setUnderlyingCFICode

public void setUnderlyingCFICode(String value)

getUnderlyingSecurityType

public String getUnderlyingSecurityType()

setUnderlyingSecurityType

public void setUnderlyingSecurityType(String value)

getUnderlyingSecuritySubType

public String getUnderlyingSecuritySubType()

setUnderlyingSecuritySubType

public void setUnderlyingSecuritySubType(String value)

getUnderlyingMaturityMonthYear

public Calendar getUnderlyingMaturityMonthYear()

setUnderlyingMaturityMonthYear

public void setUnderlyingMaturityMonthYear(Calendar value)

getUnderlyingMaturityDate

public Calendar getUnderlyingMaturityDate()

setUnderlyingMaturityDate

public void setUnderlyingMaturityDate(Calendar value)

getUnderlyingMaturityTime

public Calendar getUnderlyingMaturityTime()

setUnderlyingMaturityTime

public void setUnderlyingMaturityTime(Calendar value)

getUnderlyingCouponPaymentDate

public Calendar getUnderlyingCouponPaymentDate()

setUnderlyingCouponPaymentDate

public void setUnderlyingCouponPaymentDate(Calendar value)

getUnderlyingIssueDate

public Calendar getUnderlyingIssueDate()

setUnderlyingIssueDate

public void setUnderlyingIssueDate(Calendar value)

getUnderlyingRepoCollateralSecurityType

public String getUnderlyingRepoCollateralSecurityType()

setUnderlyingRepoCollateralSecurityType

public void setUnderlyingRepoCollateralSecurityType(String value)

getUnderlyingRepurchaseTerm

public Long getUnderlyingRepurchaseTerm()

setUnderlyingRepurchaseTerm

public void setUnderlyingRepurchaseTerm(Long value)

getUnderlyingRepurchaseRate

public Double getUnderlyingRepurchaseRate()

setUnderlyingRepurchaseRate

public void setUnderlyingRepurchaseRate(Double value)

getUnderlyingFactor
```
public Double getUnderlyingFactor()
```

setUnderlyingFactor

public void setUnderlyingFactor(Double value)

getUnderlyingCreditRating

public String getUnderlyingCreditRating()

setUnderlyingCreditRating

public void setUnderlyingCreditRating(String value)

getUnderlyingInstrRegistry

public String getUnderlyingInstrRegistry()

setUnderlyingInstrRegistry

public void setUnderlyingInstrRegistry(String value)

getUnderlyingCountryOfIssue

public String getUnderlyingCountryOfIssue()

setUnderlyingCountryOfIssue

public void setUnderlyingCountryOfIssue(String value)

getUnderlyingStateOrProvinceOfIssue

public String getUnderlyingStateOrProvinceOfIssue()

setUnderlyingStateOrProvinceOfIssue

public void setUnderlyingStateOrProvinceOfIssue(String value)

getUnderlyingLocaleOfIssue

public String getUnderlyingLocaleOfIssue()

setUnderlyingLocaleOfIssue

public void setUnderlyingLocaleOfIssue(String value)

getUnderlyingRedemptionDate

public Calendar getUnderlyingRedemptionDate()

setUnderlyingRedemptionDate

public void setUnderlyingRedemptionDate(Calendar value)

getUnderlyingStrikePrice

public Double getUnderlyingStrikePrice()

setUnderlyingStrikePrice

public void setUnderlyingStrikePrice(Double value)

getUnderlyingStrikeCurrency

public String getUnderlyingStrikeCurrency()

setUnderlyingStrikeCurrency

public void setUnderlyingStrikeCurrency(String value)

getUnderlyingOptAttribute

public Character getUnderlyingOptAttribute()

setUnderlyingOptAttribute

public void setUnderlyingOptAttribute(Character value)

getUnderlyingContractMultiplier

public Double getUnderlyingContractMultiplier()

setUnderlyingContractMultiplier

public void setUnderlyingContractMultiplier(Double value)

getUnderlyingUnitOfMeasure

public String getUnderlyingUnitOfMeasure()

setUnderlyingUnitOfMeasure

public void setUnderlyingUnitOfMeasure(String value)

getUnderlyingUnitOfMeasureQty

public Double getUnderlyingUnitOfMeasureQty()

setUnderlyingUnitOfMeasureQty

public void setUnderlyingUnitOfMeasureQty(Double value)

getUnderlyingPriceUnitOfMeasure

public String getUnderlyingPriceUnitOfMeasure()

setUnderlyingPriceUnitOfMeasure

public void setUnderlyingPriceUnitOfMeasure(String value)

getUnderlyingPriceUnitOfMeasureQty

public Double getUnderlyingPriceUnitOfMeasureQty()

setUnderlyingPriceUnitOfMeasureQty

public void setUnderlyingPriceUnitOfMeasureQty(Double value)

getUnderlyingTimeUnit
```
public String getUnderlyingTimeUnit()
```

setUnderlyingTimeUnit

public void setUnderlyingTimeUnit(String value)

getUnderlyingExerciseStyle

public Long getUnderlyingExerciseStyle()

setUnderlyingExerciseStyle

public void setUnderlyingExerciseStyle(Long value)

getUnderlyingCouponRate

public Double getUnderlyingCouponRate()

setUnderlyingCouponRate

public void setUnderlyingCouponRate(Double value)

getUnderlyingSecurityExchange

public String getUnderlyingSecurityExchange()

setUnderlyingSecurityExchange

public void setUnderlyingSecurityExchange(String value)

getUnderlyingIssuer
```
public String getUnderlyingIssuer()
```

setUnderlyingIssuer

public void setUnderlyingIssuer(String value)

getEncodedUnderlyingIssuerLen

public Long getEncodedUnderlyingIssuerLen()

setEncodedUnderlyingIssuerLen

public void setEncodedUnderlyingIssuerLen(Long value)

getEncodedUnderlyingIssuer

public String getEncodedUnderlyingIssuer()

setEncodedUnderlyingIssuer

public void setEncodedUnderlyingIssuer(String value)

getUnderlyingSecurityDesc

public String getUnderlyingSecurityDesc()

setUnderlyingSecurityDesc

public void setUnderlyingSecurityDesc(String value)

getEncodedUnderlyingSecurityDescLen

public Long getEncodedUnderlyingSecurityDescLen()

setEncodedUnderlyingSecurityDescLen

public void setEncodedUnderlyingSecurityDescLen(Long value)

getEncodedUnderlyingSecurityDesc

public String getEncodedUnderlyingSecurityDesc()

setEncodedUnderlyingSecurityDesc

public void setEncodedUnderlyingSecurityDesc(String value)

getUnderlyingCPProgram

public String getUnderlyingCPProgram()

setUnderlyingCPProgram

public void setUnderlyingCPProgram(String value)

getUnderlyingCPRegType

public String getUnderlyingCPRegType()

setUnderlyingCPRegType

public void setUnderlyingCPRegType(String value)

getUnderlyingAllocationPercent

public Double getUnderlyingAllocationPercent()

setUnderlyingAllocationPercent

public void setUnderlyingAllocationPercent(Double value)

getUnderlyingCurrency
```
public String getUnderlyingCurrency()
```

setUnderlyingCurrency

public void setUnderlyingCurrency(String value)

getUnderlyingQty
```
public Double getUnderlyingQty()
```

setUnderlyingQty

public void setUnderlyingQty(Double value)

getUnderlyingSettlementType

public Long getUnderlyingSettlementType()

setUnderlyingSettlementType

public void setUnderlyingSettlementType(Long value)

getUnderlyingCashAmount

public Double getUnderlyingCashAmount()

setUnderlyingCashAmount

public void setUnderlyingCashAmount(Double value)

getUnderlyingCashType
```
public String getUnderlyingCashType()
```

setUnderlyingCashType

public void setUnderlyingCashType(String value)

getUnderlyingPx
```
public Double getUnderlyingPx()
```

setUnderlyingPx

public void setUnderlyingPx(Double value)

getUnderlyingDirtyPrice

public Double getUnderlyingDirtyPrice()

setUnderlyingDirtyPrice

public void setUnderlyingDirtyPrice(Double value)

getUnderlyingEndPrice
```
public Double getUnderlyingEndPrice()
```

setUnderlyingEndPrice

public void setUnderlyingEndPrice(Double value)

getUnderlyingStartValue

public Double getUnderlyingStartValue()

setUnderlyingStartValue

public void setUnderlyingStartValue(Double value)

getUnderlyingCurrentValue

public Double getUnderlyingCurrentValue()

setUnderlyingCurrentValue

public void setUnderlyingCurrentValue(Double value)

getUnderlyingEndValue
```
public Double getUnderlyingEndValue()
```

setUnderlyingEndValue

public void setUnderlyingEndValue(Double value)

getUnderlyingStipulations

public UnderlyingStipulationsBlock getUnderlyingStipulations()

setUnderlyingStipulations

public void setUnderlyingStipulations(UnderlyingStipulationsBlock value)

getUnderlyingAdjustedQuantity

public Double getUnderlyingAdjustedQuantity()

setUnderlyingAdjustedQuantity

public void setUnderlyingAdjustedQuantity(Double value)

getUnderlyingFXRate
```
public Double getUnderlyingFXRate()
```

setUnderlyingFXRate

public void setUnderlyingFXRate(Double value)

getUnderlyingFXRateCalc

public Character getUnderlyingFXRateCalc()

setUnderlyingFXRateCalc

public void setUnderlyingFXRateCalc(Character value)

getUnderlyingCapValue
```
public Double getUnderlyingCapValue()
```

setUnderlyingCapValue

public void setUnderlyingCapValue(Double value)

getUndlyInstrumentParties

public UndlyInstrumentPartiesBlock getUndlyInstrumentParties()

setUndlyInstrumentParties

public void setUndlyInstrumentParties(UndlyInstrumentPartiesBlock value)

getUnderlyingSettlMethod

public String getUnderlyingSettlMethod()

setUnderlyingSettlMethod

public void setUnderlyingSettlMethod(String value)

getUnderlyingPutOrCall
```
public Long getUnderlyingPutOrCall()
```

setUnderlyingPutOrCall

public void setUnderlyingPutOrCall(Long value)

toFIX
```
public void toFIX(FIXFieldList l)
```
Specified by:

toFIX in interface com.epam.fix.model.Block

fromFIX
```
public void fromFIX(FIXFieldList l)
```
Specified by:

fromFIX in interface com.epam.fix.model.Block

Class UnderlyingInstrumentBlock

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UnderlyingInstrumentBlock

Method Detail

getUnderlyingSymbol

setUnderlyingSymbol

getUnderlyingSymbolSfx

setUnderlyingSymbolSfx

getUnderlyingSecurityID

setUnderlyingSecurityID

getUnderlyingSecurityIDSource

setUnderlyingSecurityIDSource

getNoUnderlyingSecurityAltID

setNoUnderlyingSecurityAltID

getUnderlyingSecurityAltIDGroup

setUnderlyingSecurityAltIDGroup

getUnderlyingProduct

setUnderlyingProduct

getUnderlyingCFICode

setUnderlyingCFICode

getUnderlyingSecurityType

setUnderlyingSecurityType

getUnderlyingSecuritySubType

setUnderlyingSecuritySubType

getUnderlyingMaturityMonthYear

setUnderlyingMaturityMonthYear

getUnderlyingMaturityDate

setUnderlyingMaturityDate

getUnderlyingMaturityTime

setUnderlyingMaturityTime

getUnderlyingCouponPaymentDate

setUnderlyingCouponPaymentDate

getUnderlyingIssueDate

setUnderlyingIssueDate

getUnderlyingRepoCollateralSecurityType

setUnderlyingRepoCollateralSecurityType

getUnderlyingRepurchaseTerm

setUnderlyingRepurchaseTerm

getUnderlyingRepurchaseRate

setUnderlyingRepurchaseRate

getUnderlyingFactor

setUnderlyingFactor

getUnderlyingCreditRating

setUnderlyingCreditRating

getUnderlyingInstrRegistry

setUnderlyingInstrRegistry

getUnderlyingCountryOfIssue

setUnderlyingCountryOfIssue

getUnderlyingStateOrProvinceOfIssue

setUnderlyingStateOrProvinceOfIssue

getUnderlyingLocaleOfIssue

setUnderlyingLocaleOfIssue

getUnderlyingRedemptionDate

setUnderlyingRedemptionDate

getUnderlyingStrikePrice

setUnderlyingStrikePrice

getUnderlyingStrikeCurrency

setUnderlyingStrikeCurrency

getUnderlyingOptAttribute

setUnderlyingOptAttribute

getUnderlyingContractMultiplier

setUnderlyingContractMultiplier

getUnderlyingUnitOfMeasure

setUnderlyingUnitOfMeasure

getUnderlyingUnitOfMeasureQty

setUnderlyingUnitOfMeasureQty

getUnderlyingPriceUnitOfMeasure

setUnderlyingPriceUnitOfMeasure

getUnderlyingPriceUnitOfMeasureQty

setUnderlyingPriceUnitOfMeasureQty

getUnderlyingTimeUnit

setUnderlyingTimeUnit

getUnderlyingExerciseStyle

setUnderlyingExerciseStyle

getUnderlyingCouponRate

setUnderlyingCouponRate