BasketSideAllocExtGrpElem (OnixS Eurex ETI Handler 1.9.0 API)

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

public class BasketSideAllocExtGrpElem
extends Object

Basket Side Alloc Ext Group Element

Constructor Summary

Constructors
Constructor and Description

BasketSideAllocExtGrpElem()
Create new object.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CharSequence`	`getAccount()` Account to book trades and keep positions on.
`long`	`getAllocId()` Unique identifier for a TES Trade side.
`long`	`getAllocQty()` Quantity of the particular trade side in the TES trade.
`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.
`OrderAttributeLiquidityProvision`	`getOrderAttributeLiquidityProvision()` Order attribute liquidity provision.
`OrderAttributeRiskReduction`	`getOrderAttributeRiskReduction()` Order attribute risk reduction.
`OrderOrigination`	`getOrderOrigination()` Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
`long`	`getPackageId()` Identifier for a Trade Entry Service trade, i.e TES trade ID.
`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.
`Side`	`getSide()` Side of the order.
`int`	`getSideMarketSegmentId()` Product ID.
`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.
`void`	`setAccount(CharSequence value)`
`void`	`setAllocId(long value)`
`void`	`setAllocQty(long value)`
`void`	`setComplianceText(CharSequence value)`
`void`	`setCustOrderHandlingInst(CustOrderHandlingInst value)`
`void`	`setExecutingTrader(long value)`
`void`	`setExecutingTraderQualifier(ExecutingTraderQualifier value)`
`void`	`setFreeText1(CharSequence value)`
`void`	`setFreeText2(CharSequence value)`
`void`	`setFreeText3(CharSequence value)`
`void`	`setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)`
`void`	`setOrderAttributeRiskReduction(OrderAttributeRiskReduction value)`
`void`	`setOrderOrigination(OrderOrigination value)`
`void`	`setPackageId(long value)`
`void`	`setPartyExecutingFirm(CharSequence value)`
`void`	`setPartyExecutingTrader(CharSequence value)`
`void`	`setPartyIdBeneficiary(CharSequence value)`
`void`	`setPartyIdClientId(long value)`
`void`	`setPartyIdInvestmentDecisionMaker(long value)`
`void`	`setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)`
`void`	`setPartyIdLocationId(CharSequence value)`
`void`	`setPartyIdOrderOriginationFirm(CharSequence value)`
`void`	`setPartyIdPositionAccount(CharSequence value)`
`void`	`setPartyIdTakeUpTradingFirm(CharSequence value)`
`void`	`setPositionEffect(PositionEffect value)`
`void`	`setSide(Side value)`
`void`	`setSideMarketSegmentId(int value)`
`void`	`setTradingCapacity(TradingCapacity 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
  - BasketSideAllocExtGrpElem
```
public BasketSideAllocExtGrpElem()
```
    Create new object.
- Method Detail
  - toString
```
public String toString()
```
    Returns a string representation.
    
    Overrides:
    
    toString in class Object
  - getAllocQty
```
public long getAllocQty()
```
    Quantity of the particular trade side in the TES trade.
  - setAllocQty
```
public void setAllocQty(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 void 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 void 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 void setExecutingTrader(long value)
```
  - getPackageId
```
public long getPackageId()
```
    Identifier for a Trade Entry Service trade, i.e TES trade ID.
  - setPackageId
```
public void setPackageId(long value)
```
  - getSideMarketSegmentId
```
public int getSideMarketSegmentId()
```
    Product ID.
  - setSideMarketSegmentId
```
public void setSideMarketSegmentId(int value)
```
  - getAllocId
```
public long getAllocId()
```
    Unique identifier for a TES Trade side.
  - setAllocId
```
public void setAllocId(long value)
```
  - getSide
```
public Side getSide()
```
    Side of the order.
  - setSide
```
public void setSide(Side 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 void setPositionEffect(PositionEffect 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 void setTradingCapacity(TradingCapacity value)
```
  - getOrderAttributeLiquidityProvision
```
public OrderAttributeLiquidityProvision getOrderAttributeLiquidityProvision()
```
    Order attribute liquidity provision.
  - setOrderAttributeLiquidityProvision
```
public void setOrderAttributeLiquidityProvision(OrderAttributeLiquidityProvision value)
```
  - getExecutingTraderQualifier
```
public ExecutingTraderQualifier getExecutingTraderQualifier()
```
    Qualifier for field ExecutingTrader. It is required to distinguish between natural persons and Algos.
  - setExecutingTraderQualifier
```
public void setExecutingTraderQualifier(ExecutingTraderQualifier value)
```
  - getPartyIdInvestmentDecisionMakerQualifier
```
public PartyIdInvestmentDecisionMakerQualifier getPartyIdInvestmentDecisionMakerQualifier()
```
    Party ID investment decision maker qualifier.
  - setPartyIdInvestmentDecisionMakerQualifier
```
public void setPartyIdInvestmentDecisionMakerQualifier(PartyIdInvestmentDecisionMakerQualifier value)
```
  - getOrderAttributeRiskReduction
```
public OrderAttributeRiskReduction getOrderAttributeRiskReduction()
```
    Order attribute risk reduction.
  - setOrderAttributeRiskReduction
```
public void setOrderAttributeRiskReduction(OrderAttributeRiskReduction value)
```
  - getOrderOrigination
```
public OrderOrigination getOrderOrigination()
```
    Order origination, MiFID field - to indicate order received from a direct access or sponsored access customer.
  - setOrderOrigination
```
public void setOrderOrigination(OrderOrigination value)
```
  - getPartyExecutingFirm
```
public CharSequence getPartyExecutingFirm()
```
    Owning business unit name.
  - setPartyExecutingFirm
```
public void setPartyExecutingFirm(CharSequence value)
```
  - getPartyExecutingTrader
```
public CharSequence getPartyExecutingTrader()
```
    Owning user name.
  - setPartyExecutingTrader
```
public void setPartyExecutingTrader(CharSequence value)
```
  - getAccount
```
public CharSequence getAccount()
```
    Account to book trades and keep positions on.
  - setAccount
```
public void setAccount(CharSequence value)
```
  - getFreeText1
```
public CharSequence getFreeText1()
```
    First free-format text field for trader-specific or customer-related comments.
  - setFreeText1
```
public void setFreeText1(CharSequence value)
```
  - getFreeText2
```
public CharSequence getFreeText2()
```
    Second free-format text field for trader-specific or customer-related comments.
  - setFreeText2
```
public void setFreeText2(CharSequence value)
```
  - getFreeText3
```
public CharSequence getFreeText3()
```
    Third free-format text field for trader-specific or customer-related comments.
  - setFreeText3
```
public void setFreeText3(CharSequence value)
```
  - getPartyIdTakeUpTradingFirm
```
public CharSequence getPartyIdTakeUpTradingFirm()
```
    Indicates the name of a member institution to which a give-up is designated.
  - setPartyIdTakeUpTradingFirm
```
public void setPartyIdTakeUpTradingFirm(CharSequence value)
```
  - getPartyIdOrderOriginationFirm
```
public CharSequence getPartyIdOrderOriginationFirm()
```
    Partner identification at the Korea Exchange is required for orders in KRX products.
  - setPartyIdOrderOriginationFirm
```
public void setPartyIdOrderOriginationFirm(CharSequence value)
```
  - getPartyIdBeneficiary
```
public CharSequence getPartyIdBeneficiary()
```
    Mandatory final KRX beneficiary account required for orders in KRX products.
  - setPartyIdBeneficiary
```
public void setPartyIdBeneficiary(CharSequence value)
```
  - getPartyIdPositionAccount
```
public CharSequence getPartyIdPositionAccount()
```
    Flex Account information.
  - setPartyIdPositionAccount
```
public void setPartyIdPositionAccount(CharSequence value)
```
  - getPartyIdLocationId
```
public CharSequence getPartyIdLocationId()
```
    Country code. Valid characters: 0x01-0x7E.
  - setPartyIdLocationId
```
public void 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 void 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 void setComplianceText(CharSequence value)
```

Class BasketSideAllocExtGrpElem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasketSideAllocExtGrpElem

Method Detail

toString

getAllocQty

setAllocQty

getPartyIdClientId

setPartyIdClientId

getPartyIdInvestmentDecisionMaker

setPartyIdInvestmentDecisionMaker

getExecutingTrader

setExecutingTrader

getPackageId

setPackageId

getSideMarketSegmentId

setSideMarketSegmentId

getAllocId

setAllocId

getSide

setSide

getPositionEffect

setPositionEffect

getTradingCapacity

setTradingCapacity

getOrderAttributeLiquidityProvision

setOrderAttributeLiquidityProvision

getExecutingTraderQualifier

setExecutingTraderQualifier

getPartyIdInvestmentDecisionMakerQualifier

setPartyIdInvestmentDecisionMakerQualifier

getOrderAttributeRiskReduction

setOrderAttributeRiskReduction

getOrderOrigination

setOrderOrigination

getPartyExecutingFirm

setPartyExecutingFirm

getPartyExecutingTrader

setPartyExecutingTrader

getAccount

setAccount

getFreeText1

setFreeText1

getFreeText2

setFreeText2

getFreeText3

setFreeText3

getPartyIdTakeUpTradingFirm

setPartyIdTakeUpTradingFirm

getPartyIdOrderOriginationFirm

setPartyIdOrderOriginationFirm

getPartyIdBeneficiary

setPartyIdBeneficiary

getPartyIdPositionAccount

setPartyIdPositionAccount

getPartyIdLocationId

setPartyIdLocationId

getCustOrderHandlingInst

setCustOrderHandlingInst

getComplianceText

setComplianceText