SRQSHitQuoteRequest (OnixS Eurex ETI Handler 1.9.0 API)

java.lang.Object
- biz.onixs.eurex.eti.handler.message.SRQSHitQuoteRequest

All Implemented Interfaces:

ApplicationMessage, Message
```
public class SRQSHitQuoteRequest
extends Object
implements ApplicationMessage
```
SRQS Hit Quote Request Message

Field Summary
- Fields inherited from interface biz.onixs.eurex.eti.handler.message.Message
  SInt16NoValue, SInt32NoValue, SInt64NoValue, SInt8NoValue, UInt16NoValue, UInt32NoValue, UInt64NoValue, UInt8NoValue

Constructor Summary

Constructors
Constructor and Description

SRQSHitQuoteRequest()
Create new object.

Constructors
Constructor and Description
`SRQSHitQuoteRequest()` Create new object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deserialize(DeserializerHelpers deserializerHelpers)` Deserialize message from Eurex ETI binary format.
`CharSequence`	`getAccount()` Account to book trades and keep positions on.
`CharSequence`	`getComplianceText()` This field is used to provide additional regulatory information (according to respective rules and regs, circulars and bilateral coordination between participant and Trading Surveillance Office).
`CustOrderHandlingInst`	`getCustOrderHandlingInst()` Identifies the source of an order, in accordance with the FIA guidelines for a rate Identifier.
`long`	`getExecutingTrader()` Executing Trader data Field (ESMA Field 5 (Section A)) used to identify the person or algorithm within the member or participant of the trading venue who is responsible for the execution of the transaction resulting from the order.
`ExecutingTraderQualifier`	`getExecutingTraderQualifier()` Qualifier for field ExecutingTrader.
`CharSequence`	`getFirmTradeId()` User defined deal ID.
`CharSequence`	`getFreeText1()` First free-format text field for trader-specific or customer-related comments.
`CharSequence`	`getFreeText2()` Second free-format text field for trader-specific or customer-related comments.
`CharSequence`	`getFreeText3()` Third free-format text field for trader-specific or customer-related comments.
`CharSequence`	`getFreeText5()` Text field.
`HedgingInstruction`	`getHedgingInstruction()` Indication for the hedge transaction.
`int`	`getMarketSegmentId()` The product identifier uniquely identifies a Eurex product.
`long`	`getMsgSeqNum()` Message sequence number used by the participant for requests sent to the gateway.
`long`	`getNegotiationId()` ID of a SRQS negotiation.
`OrderAttributeLiquidityProvision`	`getOrderAttributeLiquidityProvision()` Order attribute liquidity provision.
`OrderOrigination`	`getOrderOrigination()` Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
`CharSequence`	`getPartyEndClientIdentification()` End client identifier.
`CharSequence`	`getPartyExecutingFirm()` Owning business unit name.
`CharSequence`	`getPartyExecutingTrader()` Owning user name.
`CharSequence`	`getPartyIdBeneficiary()` Mandatory final KRX beneficiary account required for orders in KRX products.
`long`	`getPartyIdClientId()` Client Identifier field (ESMA Field 3 (Section A)) used to identify the client of an order for agent account of the member or participant of the trading venue.
`long`	`getPartyIdInvestmentDecisionMaker()` Investment decision within firm (ESMA Field 4 (Section A)) is the code used to identify the person or the algorithm within the member or participant of the Trading Venue who is responsible for the investment decision.
`PartyIdInvestmentDecisionMakerQualifier`	`getPartyIdInvestmentDecisionMakerQualifier()` Party ID investment decision maker qualifier.
`CharSequence`	`getPartyIdLocationId()` Country code.
`CharSequence`	`getPartyIdOrderOriginationFirm()` Partner identification at the Korea Exchange is required for orders in KRX products.
`CharSequence`	`getPartyIdPositionAccount()` Flex Account information.
`CharSequence`	`getPartyIdTakeUpTradingFirm()` Indicates the name of a member institution to which a give-up is designated.
`PositionEffect`	`getPositionEffect()` Field is used for Eurex position management purposes and indicates whether the order is submitted to open or close a position.
`long`	`getSenderSubId()` User ID.
`List<SRQSHitQuoteGrpElem>`	`getSRQSHitQuoteGrp()` SRQS Hit Quote Group.
`TemplateId`	`getTemplateId()` Returns message TemplateID.
`TradePublishIndicator`	`getTradePublishIndicator()` Indicates if a trade should be reported via the market reporting service.
`TradingCapacity`	`getTradingCapacity()` This field designates if the trader is acting in the capacity of agent, trading for its own account or acting as a market maker.
`long`	`getUnderlyingPriceStipValue()` Value of stipulation.
`long`	`getUnderlyingQty()` Nominal value.
`long`	`getValidUntilTime()` Time until a message is valid.
`void`	`notify(MessageListener listener)` Notify message listener.
`void`	`serialize(SerializerHelpers serializerHelpers)` Serialize message to Eurex ETI binary format.
`SRQSHitQuoteRequest`	`setAccount(CharSequence value)`
`SRQSHitQuoteRequest`	`setComplianceText(CharSequence value)`
`SRQSHitQuoteRequest`	`setCustOrderHandlingInst(CustOrderHandlingInst value)`
`SRQSHitQuoteRequest`	`setExecutingTrader(long value)`
`SRQSHitQuoteRequest`	`setExecutingTraderQualifier(ExecutingTraderQualifier value)`
`SRQSHitQuoteRequest`	`setFirmTradeId(CharSequence value)`
`SRQSHitQuoteRequest`	`setFreeText1(CharSequence value)`
`SRQSHitQuoteRequest`	`setFreeText2(CharSequence value)`
`SRQSHitQuoteRequest`	`setFreeText3(CharSequence value)`
`SRQSHitQuoteRequest`	`setFreeText5(CharSequence value)`
`SRQSHitQuoteRequest`	`setHedgingInstruction(HedgingInstruction value)`
`SRQSHitQuoteRequest`	`setMarketSegmentId(int value)`
`void`	`setMsgSeqNum(long value)` Set message sequence number.
`SRQSHitQuoteRequest`	`setNegotiationId(long value)`
`SRQSHitQuoteRequest`	`setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)`
`SRQSHitQuoteRequest`	`setOrderOrigination(OrderOrigination value)`
`SRQSHitQuoteRequest`	`setPartyEndClientIdentification(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyExecutingFirm(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyExecutingTrader(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyIdBeneficiary(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyIdClientId(long value)`
`SRQSHitQuoteRequest`	`setPartyIdInvestmentDecisionMaker(long value)`
`SRQSHitQuoteRequest`	`setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)`
`SRQSHitQuoteRequest`	`setPartyIdLocationId(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyIdOrderOriginationFirm(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyIdPositionAccount(CharSequence value)`
`SRQSHitQuoteRequest`	`setPartyIdTakeUpTradingFirm(CharSequence value)`
`SRQSHitQuoteRequest`	`setPositionEffect(PositionEffect value)`
`SRQSHitQuoteRequest`	`setSenderSubId(long value)`
`SRQSHitQuoteRequest`	`setSRQSHitQuoteGrp(List<SRQSHitQuoteGrpElem> value)`
`SRQSHitQuoteRequest`	`setTradePublishIndicator(TradePublishIndicator value)`
`SRQSHitQuoteRequest`	`setTradingCapacity(TradingCapacity value)`
`SRQSHitQuoteRequest`	`setUnderlyingPriceStipValue(long value)`
`SRQSHitQuoteRequest`	`setUnderlyingQty(long value)`
`SRQSHitQuoteRequest`	`setValidUntilTime(long value)`
`String`	`toString()` Returns a string representation.

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

- Constructor Detail
  - SRQSHitQuoteRequest
```
public SRQSHitQuoteRequest()
```
    Create new object.
- Method Detail
  - toString
```
public String toString()
```
    Returns a string representation.
    
    Overrides:
    
    toString in class Object
  - getTemplateId
```
public TemplateId getTemplateId()
```
    Returns message TemplateID.
    
    Specified by:
    
    getTemplateId in interface Message
  - serialize
```
public void serialize(SerializerHelpers serializerHelpers)
               throws IOException
```
    Serialize message to Eurex ETI binary format.
    
    Specified by:
    
    serialize in interface Message
    
    Throws:
    
    IOException
  - deserialize
```
public void deserialize(DeserializerHelpers deserializerHelpers)
                 throws IOException
```
    Deserialize message from Eurex ETI binary format.
    
    Specified by:
    
    deserialize in interface Message
    
    Throws:
    
    IOException
  - notify
```
public void notify(MessageListener listener)
```
    Notify message listener.
    
    Specified by:
    
    notify in interface Message
  - getMsgSeqNum
```
public long getMsgSeqNum()
```
    Message sequence number used by the participant for requests sent to the gateway.
    
    Specified by:
    
    getMsgSeqNum in interface Message
  - setMsgSeqNum
```
public void setMsgSeqNum(long value)
```
    Description copied from interface: Message
    
    Set message sequence number.
    
    Specified by:
    
    setMsgSeqNum in interface Message
  - getSenderSubId
```
public long getSenderSubId()
```
    User ID.
  - setSenderSubId
```
public SRQSHitQuoteRequest setSenderSubId(long value)
```
  - getValidUntilTime
```
public long getValidUntilTime()
```
    Time until a message is valid.
  - setValidUntilTime
```
public SRQSHitQuoteRequest setValidUntilTime(long value)
```
  - getUnderlyingQty
```
public long getUnderlyingQty()
```
    Nominal value.
  - setUnderlyingQty
```
public SRQSHitQuoteRequest setUnderlyingQty(long value)
```
  - getUnderlyingPriceStipValue
```
public long getUnderlyingPriceStipValue()
```
    Value of stipulation.
  - setUnderlyingPriceStipValue
```
public SRQSHitQuoteRequest setUnderlyingPriceStipValue(long value)
```
  - getPartyIdClientId
```
public long getPartyIdClientId()
```
    Client Identifier field (ESMA Field 3 (Section A)) used to identify the client of an order for agent account of the member or participant of the trading venue.
  - setPartyIdClientId
```
public SRQSHitQuoteRequest setPartyIdClientId(long value)
```
  - getPartyIdInvestmentDecisionMaker
```
public long getPartyIdInvestmentDecisionMaker()
```
    Investment decision within firm (ESMA Field 4 (Section A)) is the code used to identify the person or the algorithm within the member or participant of the Trading Venue who is responsible for the investment decision.
  - setPartyIdInvestmentDecisionMaker
```
public SRQSHitQuoteRequest setPartyIdInvestmentDecisionMaker(long value)
```
  - getExecutingTrader
```
public long getExecutingTrader()
```
    Executing Trader data Field (ESMA Field 5 (Section A)) used to identify the person or algorithm within the member or participant of the trading venue who is responsible for the execution of the transaction resulting from the order.
  - setExecutingTrader
```
public SRQSHitQuoteRequest setExecutingTrader(long value)
```
  - getMarketSegmentId
```
public int getMarketSegmentId()
```
    The product identifier uniquely identifies a Eurex product.
  - setMarketSegmentId
```
public SRQSHitQuoteRequest setMarketSegmentId(int value)
```
  - getNegotiationId
```
public long getNegotiationId()
```
    ID of a SRQS negotiation.
  - setNegotiationId
```
public SRQSHitQuoteRequest setNegotiationId(long value)
```
  - getOrderAttributeLiquidityProvision
```
public OrderAttributeLiquidityProvision getOrderAttributeLiquidityProvision()
```
    Order attribute liquidity provision.
  - setOrderAttributeLiquidityProvision
```
public SRQSHitQuoteRequest setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)
```
  - getExecutingTraderQualifier
```
public ExecutingTraderQualifier getExecutingTraderQualifier()
```
    Qualifier for field ExecutingTrader. It is required to distinguish between natural persons and Algos.
  - setExecutingTraderQualifier
```
public SRQSHitQuoteRequest setExecutingTraderQualifier(ExecutingTraderQualifier value)
```
  - getPartyIdInvestmentDecisionMakerQualifier
```
public PartyIdInvestmentDecisionMakerQualifier getPartyIdInvestmentDecisionMakerQualifier()
```
    Party ID investment decision maker qualifier.
  - setPartyIdInvestmentDecisionMakerQualifier
```
public SRQSHitQuoteRequest setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)
```
  - getTradingCapacity
```
public TradingCapacity getTradingCapacity()
```
    This field designates if the trader is acting in the capacity of agent, trading for its own account or acting as a market maker.
  - setTradingCapacity
```
public SRQSHitQuoteRequest setTradingCapacity(TradingCapacity value)
```
  - getTradePublishIndicator
```
public TradePublishIndicator getTradePublishIndicator()
```
    Indicates if a trade should be reported via the market reporting service.
  - setTradePublishIndicator
```
public SRQSHitQuoteRequest setTradePublishIndicator(TradePublishIndicator value)
```
  - getOrderOrigination
```
public OrderOrigination getOrderOrigination()
```
    Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
  - setOrderOrigination
```
public SRQSHitQuoteRequest setOrderOrigination(OrderOrigination value)
```
  - getHedgingInstruction
```
public HedgingInstruction getHedgingInstruction()
```
    Indication for the hedge transaction.
  - setHedgingInstruction
```
public SRQSHitQuoteRequest setHedgingInstruction(HedgingInstruction value)
```
  - getPartyExecutingFirm
```
public CharSequence getPartyExecutingFirm()
```
    Owning business unit name.
  - setPartyExecutingFirm
```
public SRQSHitQuoteRequest setPartyExecutingFirm(CharSequence value)
```
  - getPartyExecutingTrader
```
public CharSequence getPartyExecutingTrader()
```
    Owning user name.
  - setPartyExecutingTrader
```
public SRQSHitQuoteRequest setPartyExecutingTrader(CharSequence value)
```
  - getFirmTradeId
```
public CharSequence getFirmTradeId()
```
    User defined deal ID.
  - setFirmTradeId
```
public SRQSHitQuoteRequest setFirmTradeId(CharSequence value)
```
  - getFreeText1
```
public CharSequence getFreeText1()
```
    First free-format text field for trader-specific or customer-related comments.
  - setFreeText1
```
public SRQSHitQuoteRequest setFreeText1(CharSequence value)
```
  - getFreeText2
```
public CharSequence getFreeText2()
```
    Second free-format text field for trader-specific or customer-related comments.
  - setFreeText2
```
public SRQSHitQuoteRequest setFreeText2(CharSequence value)
```
  - getFreeText3
```
public CharSequence getFreeText3()
```
    Third free-format text field for trader-specific or customer-related comments.
  - setFreeText3
```
public SRQSHitQuoteRequest setFreeText3(CharSequence value)
```
  - getFreeText5
```
public CharSequence getFreeText5()
```
    Text field.
  - setFreeText5
```
public SRQSHitQuoteRequest setFreeText5(CharSequence value)
```
  - getPositionEffect
```
public PositionEffect getPositionEffect()
```
    Field is used for Eurex position management purposes and indicates whether the order is submitted to open or close a position.
  - setPositionEffect
```
public SRQSHitQuoteRequest setPositionEffect(PositionEffect value)
```
  - getAccount
```
public CharSequence getAccount()
```
    Account to book trades and keep positions on.
  - setAccount
```
public SRQSHitQuoteRequest setAccount(CharSequence value)
```
  - getPartyIdBeneficiary
```
public CharSequence getPartyIdBeneficiary()
```
    Mandatory final KRX beneficiary account required for orders in KRX products.
  - setPartyIdBeneficiary
```
public SRQSHitQuoteRequest setPartyIdBeneficiary(CharSequence value)
```
  - getCustOrderHandlingInst
```
public CustOrderHandlingInst getCustOrderHandlingInst()
```
    Identifies the source of an order, in accordance with the FIA guidelines for a rate Identifier. The field is for participant use only. Valid characters: 0x20, 0x22-0x7B, 0x7D, 0x7E.
  - setCustOrderHandlingInst
```
public SRQSHitQuoteRequest setCustOrderHandlingInst(CustOrderHandlingInst value)
```
  - getPartyIdOrderOriginationFirm
```
public CharSequence getPartyIdOrderOriginationFirm()
```
    Partner identification at the Korea Exchange is required for orders in KRX products.
  - setPartyIdOrderOriginationFirm
```
public SRQSHitQuoteRequest setPartyIdOrderOriginationFirm(CharSequence value)
```
  - getPartyIdPositionAccount
```
public CharSequence getPartyIdPositionAccount()
```
    Flex Account information.
  - setPartyIdPositionAccount
```
public SRQSHitQuoteRequest setPartyIdPositionAccount(CharSequence value)
```
  - getPartyIdLocationId
```
public CharSequence getPartyIdLocationId()
```
    Country code. Valid characters: 0x01-0x7E.
  - setPartyIdLocationId
```
public SRQSHitQuoteRequest setPartyIdLocationId(CharSequence value)
```
  - getComplianceText
```
public CharSequence getComplianceText()
```
    This field is used to provide additional regulatory information (according to respective rules and regs, circulars and bilateral coordination between participant and Trading Surveillance Office).
  - setComplianceText
```
public SRQSHitQuoteRequest setComplianceText(CharSequence value)
```
  - getPartyIdTakeUpTradingFirm
```
public CharSequence getPartyIdTakeUpTradingFirm()
```
    Indicates the name of a member institution to which a give-up is designated.
  - setPartyIdTakeUpTradingFirm
```
public SRQSHitQuoteRequest setPartyIdTakeUpTradingFirm(CharSequence value)
```
  - getPartyEndClientIdentification
```
public CharSequence getPartyEndClientIdentification()
```
    End client identifier.
  - setPartyEndClientIdentification
```
public SRQSHitQuoteRequest setPartyEndClientIdentification(CharSequence value)
```
  - getSRQSHitQuoteGrp
```
public List<SRQSHitQuoteGrpElem> getSRQSHitQuoteGrp()
```
    SRQS Hit Quote Group.
  - setSRQSHitQuoteGrp
```
public SRQSHitQuoteRequest setSRQSHitQuoteGrp(List<SRQSHitQuoteGrpElem> value)
```

Class SRQSHitQuoteRequest

Field Summary

Fields inherited from interface biz.onixs.eurex.eti.handler.message.Message

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SRQSHitQuoteRequest

Method Detail

toString

getTemplateId

serialize

deserialize

notify

getMsgSeqNum

setMsgSeqNum

getSenderSubId

setSenderSubId

getValidUntilTime

setValidUntilTime

getUnderlyingQty

setUnderlyingQty

getUnderlyingPriceStipValue

setUnderlyingPriceStipValue

getPartyIdClientId

setPartyIdClientId

getPartyIdInvestmentDecisionMaker

setPartyIdInvestmentDecisionMaker

getExecutingTrader

setExecutingTrader

getMarketSegmentId

setMarketSegmentId

getNegotiationId

setNegotiationId

getOrderAttributeLiquidityProvision

setOrderAttributeLiquidityProvision

getExecutingTraderQualifier

setExecutingTraderQualifier

getPartyIdInvestmentDecisionMakerQualifier

setPartyIdInvestmentDecisionMakerQualifier

getTradingCapacity

setTradingCapacity

getTradePublishIndicator

setTradePublishIndicator

getOrderOrigination

setOrderOrigination

getHedgingInstruction

setHedgingInstruction

getPartyExecutingFirm

setPartyExecutingFirm

getPartyExecutingTrader

setPartyExecutingTrader

getFirmTradeId

setFirmTradeId

getFreeText1

setFreeText1

getFreeText2

setFreeText2

getFreeText3

setFreeText3

getFreeText5

setFreeText5

getPositionEffect

setPositionEffect

getAccount

setAccount

getPartyIdBeneficiary

setPartyIdBeneficiary

getCustOrderHandlingInst

setCustOrderHandlingInst

getPartyIdOrderOriginationFirm

setPartyIdOrderOriginationFirm

getPartyIdPositionAccount

setPartyIdPositionAccount

getPartyIdLocationId

setPartyIdLocationId

getComplianceText

setComplianceText

getPartyIdTakeUpTradingFirm

setPartyIdTakeUpTradingFirm