MassOrder (OnixS Eurex ETI Handler 1.9.0 API)

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

All Implemented Interfaces:: ApplicationMessage, Message

public class MassOrder
extends Object
implements ApplicationMessage

Mass Order 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

MassOrder()
Create new object.

Constructors
Constructor and Description
`MassOrder()` 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`	`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.
`long`	`getMassOrderRequestId()` Customer defined mass order identifier.
`long`	`getMsgSeqNum()` Message sequence number used by the participant for requests sent to the gateway.
`OrderAttributeLiquidityProvision`	`getOrderAttributeLiquidityProvision()` Order attribute liquidity provision.
`OrderAttributeRiskReduction`	`getOrderAttributeRiskReduction()` Order attribute risk reduction.
`List<OrderEntryGrpElem>`	`getOrderEntryGrp()` Order Entry Group.
`OrderOrigination`	`getOrderOrigination()` Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
`CharSequence`	`getPartyEndClientIdentification()` End client identifier.
`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.
`PriceValidityCheckType`	`getPriceValidityCheckType()` Indicator how price validity check should be performed by the exchange.
`long`	`getSenderSubId()` User ID.
`TemplateId`	`getTemplateId()` Returns message TemplateID.
`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.
`TradingSessionSubId`	`getTradingSessionSubId()` Marks a a certain order as a closing auction one.
`ValueCheckTypeValue`	`getValueCheckTypeValue()` Indicator for checking the maximum order/quote value by the exchange.
`void`	`notify(MessageListener listener)` Notify message listener.
`void`	`serialize(SerializerHelpers serializerHelpers)` Serialize message to Eurex ETI binary format.
`MassOrder`	`setAccount(CharSequence value)`
`MassOrder`	`setComplianceText(CharSequence value)`
`MassOrder`	`setCustOrderHandlingInst(CustOrderHandlingInst value)`
`MassOrder`	`setExecutingTrader(long value)`
`MassOrder`	`setExecutingTraderQualifier(ExecutingTraderQualifier value)`
`MassOrder`	`setFreeText1(CharSequence value)`
`MassOrder`	`setFreeText2(CharSequence value)`
`MassOrder`	`setFreeText3(CharSequence value)`
`MassOrder`	`setMassOrderRequestId(long value)`
`void`	`setMsgSeqNum(long value)` Set message sequence number.
`MassOrder`	`setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)`
`MassOrder`	`setOrderAttributeRiskReduction(OrderAttributeRiskReduction value)`
`MassOrder`	`setOrderEntryGrp(List<OrderEntryGrpElem> value)`
`MassOrder`	`setOrderOrigination(OrderOrigination value)`
`MassOrder`	`setPartyEndClientIdentification(CharSequence value)`
`MassOrder`	`setPartyIdBeneficiary(CharSequence value)`
`MassOrder`	`setPartyIdClientId(long value)`
`MassOrder`	`setPartyIdInvestmentDecisionMaker(long value)`
`MassOrder`	`setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)`
`MassOrder`	`setPartyIdLocationId(CharSequence value)`
`MassOrder`	`setPartyIdOrderOriginationFirm(CharSequence value)`
`MassOrder`	`setPartyIdPositionAccount(CharSequence value)`
`MassOrder`	`setPartyIdTakeUpTradingFirm(CharSequence value)`
`MassOrder`	`setPositionEffect(PositionEffect value)`
`MassOrder`	`setPriceValidityCheckType(PriceValidityCheckType value)`
`MassOrder`	`setSenderSubId(long value)`
`MassOrder`	`setTradingCapacity(TradingCapacity value)`
`MassOrder`	`setTradingSessionSubId(TradingSessionSubId value)`
`MassOrder`	`setValueCheckTypeValue(ValueCheckTypeValue 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
  - MassOrder
```
public MassOrder()
```
    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 MassOrder setSenderSubId(long value)
```
  - getMassOrderRequestId
```
public long getMassOrderRequestId()
```
    Customer defined mass order identifier.
  - setMassOrderRequestId
```
public MassOrder setMassOrderRequestId(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 MassOrder 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 MassOrder 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 MassOrder setExecutingTrader(long value)
```
  - getPartyIdTakeUpTradingFirm
```
public CharSequence getPartyIdTakeUpTradingFirm()
```
    Indicates the name of a member institution to which a give-up is designated.
  - setPartyIdTakeUpTradingFirm
```
public MassOrder setPartyIdTakeUpTradingFirm(CharSequence value)
```
  - getPartyIdOrderOriginationFirm
```
public CharSequence getPartyIdOrderOriginationFirm()
```
    Partner identification at the Korea Exchange is required for orders in KRX products.
  - setPartyIdOrderOriginationFirm
```
public MassOrder setPartyIdOrderOriginationFirm(CharSequence value)
```
  - getPartyIdBeneficiary
```
public CharSequence getPartyIdBeneficiary()
```
    Mandatory final KRX beneficiary account required for orders in KRX products.
  - setPartyIdBeneficiary
```
public MassOrder setPartyIdBeneficiary(CharSequence value)
```
  - getPriceValidityCheckType
```
public PriceValidityCheckType getPriceValidityCheckType()
```
    Indicator how price validity check should be performed by the exchange.
  - setPriceValidityCheckType
```
public MassOrder setPriceValidityCheckType(PriceValidityCheckType value)
```
  - getValueCheckTypeValue
```
public ValueCheckTypeValue getValueCheckTypeValue()
```
    Indicator for checking the maximum order/quote value by the exchange.
  - setValueCheckTypeValue
```
public MassOrder setValueCheckTypeValue(ValueCheckTypeValue value)
```
  - getOrderAttributeLiquidityProvision
```
public OrderAttributeLiquidityProvision getOrderAttributeLiquidityProvision()
```
    Order attribute liquidity provision.
  - setOrderAttributeLiquidityProvision
```
public MassOrder setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)
```
  - getOrderAttributeRiskReduction
```
public OrderAttributeRiskReduction getOrderAttributeRiskReduction()
```
    Order attribute risk reduction.
  - setOrderAttributeRiskReduction
```
public MassOrder setOrderAttributeRiskReduction(OrderAttributeRiskReduction value)
```
  - getTradingSessionSubId
```
public TradingSessionSubId getTradingSessionSubId()
```
    Marks a a certain order as a closing auction one.
  - setTradingSessionSubId
```
public MassOrder setTradingSessionSubId(TradingSessionSubId 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 MassOrder setTradingCapacity(TradingCapacity value)
```
  - getOrderOrigination
```
public OrderOrigination getOrderOrigination()
```
    Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
  - setOrderOrigination
```
public MassOrder setOrderOrigination(OrderOrigination value)
```
  - getPartyIdInvestmentDecisionMakerQualifier
```
public PartyIdInvestmentDecisionMakerQualifier getPartyIdInvestmentDecisionMakerQualifier()
```
    Party ID investment decision maker qualifier.
  - setPartyIdInvestmentDecisionMakerQualifier
```
public MassOrder setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)
```
  - getExecutingTraderQualifier
```
public ExecutingTraderQualifier getExecutingTraderQualifier()
```
    Qualifier for field ExecutingTrader. It is required to distinguish between natural persons and Algos.
  - setExecutingTraderQualifier
```
public MassOrder setExecutingTraderQualifier(ExecutingTraderQualifier value)
```
  - getAccount
```
public CharSequence getAccount()
```
    Account to book trades and keep positions on.
  - setAccount
```
public MassOrder setAccount(CharSequence value)
```
  - getPartyIdPositionAccount
```
public CharSequence getPartyIdPositionAccount()
```
    Flex Account information.
  - setPartyIdPositionAccount
```
public MassOrder setPartyIdPositionAccount(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 MassOrder setPositionEffect(PositionEffect value)
```
  - getPartyIdLocationId
```
public CharSequence getPartyIdLocationId()
```
    Country code. Valid characters: 0x01-0x7E.
  - setPartyIdLocationId
```
public MassOrder setPartyIdLocationId(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 MassOrder setCustOrderHandlingInst(CustOrderHandlingInst 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 MassOrder setComplianceText(CharSequence value)
```
  - getFreeText1
```
public CharSequence getFreeText1()
```
    First free-format text field for trader-specific or customer-related comments.
  - setFreeText1
```
public MassOrder setFreeText1(CharSequence value)
```
  - getFreeText2
```
public CharSequence getFreeText2()
```
    Second free-format text field for trader-specific or customer-related comments.
  - setFreeText2
```
public MassOrder setFreeText2(CharSequence value)
```
  - getFreeText3
```
public CharSequence getFreeText3()
```
    Third free-format text field for trader-specific or customer-related comments.
  - setFreeText3
```
public MassOrder setFreeText3(CharSequence value)
```
  - getPartyEndClientIdentification
```
public CharSequence getPartyEndClientIdentification()
```
    End client identifier.
  - setPartyEndClientIdentification
```
public MassOrder setPartyEndClientIdentification(CharSequence value)
```
  - getOrderEntryGrp
```
public List<OrderEntryGrpElem> getOrderEntryGrp()
```
    Order Entry Group.
  - setOrderEntryGrp
```
public MassOrder setOrderEntryGrp(List<OrderEntryGrpElem> value)
```

Class MassOrder

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

MassOrder

Method Detail

toString

getTemplateId

serialize

deserialize

notify

getMsgSeqNum

setMsgSeqNum

getSenderSubId

setSenderSubId

getMassOrderRequestId

setMassOrderRequestId

getPartyIdClientId

setPartyIdClientId

getPartyIdInvestmentDecisionMaker

setPartyIdInvestmentDecisionMaker

getExecutingTrader

setExecutingTrader

getPartyIdTakeUpTradingFirm

setPartyIdTakeUpTradingFirm

getPartyIdOrderOriginationFirm

setPartyIdOrderOriginationFirm

getPartyIdBeneficiary

setPartyIdBeneficiary

getPriceValidityCheckType

setPriceValidityCheckType

getValueCheckTypeValue

setValueCheckTypeValue

getOrderAttributeLiquidityProvision

setOrderAttributeLiquidityProvision

getOrderAttributeRiskReduction

setOrderAttributeRiskReduction

getTradingSessionSubId

setTradingSessionSubId

getTradingCapacity

setTradingCapacity

getOrderOrigination

setOrderOrigination

getPartyIdInvestmentDecisionMakerQualifier

setPartyIdInvestmentDecisionMakerQualifier

getExecutingTraderQualifier

setExecutingTraderQualifier

getAccount

setAccount

getPartyIdPositionAccount

setPartyIdPositionAccount

getPositionEffect

setPositionEffect

getPartyIdLocationId

setPartyIdLocationId

getCustOrderHandlingInst

setCustOrderHandlingInst

getComplianceText

setComplianceText

getFreeText1

setFreeText1

getFreeText2

setFreeText2

getFreeText3

setFreeText3

getPartyEndClientIdentification

setPartyEndClientIdentification

getOrderEntryGrp

setOrderEntryGrp