biz.onixs.cme.stp.handler

Class ReportSide

java.lang.Object

biz.onixs.cme.stp.handler.ReportSide

public class ReportSide
extends Object

Information about sides.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportSide.CommissionDatas Encapsulates the list of CommissionData
static class	ReportSide.Parties Encapsulates the list of Parties
static class	ReportSide.RelatedTrades Encapsulates the list of RelatedTrades
static class	ReportSide.SideRegulatoryTrades Encapsulates the list of SideRegulatoryTrades
static class	ReportSide.TradeTimeStamps Encapsulates the list of TradeTimeStamps

Constructor Summary

Constructors

Constructor and Description
ReportSide() Default constructor.

Method Summary

Modifier and Type	Method and Description
ScaledDecimal	getAccruedInterestRate() The amount the buyer compensates the seller for the portion of the next coupon interest payment the seller has earned but will not receive from the issuer because the issuer will send the next coupon payment to the buyer.
boolean	getAggressorIndicator()
AllocationIndicator	getAllocationIndicator()
AveragePricingIndicator	getAveragePricingIndicator()
String	getClientOrderID()
String	getClientOrderID2()
ReportSide.CommissionDatas	getCommissionData()
String	getCompressionGroupID() Identifies all trades in a netting or compression group, including both terminating trades and any remnant trades that result from the operation
String	getCurrency() Gets the currency used for price.
CustomerCapacity	getCustomerCapacity()
String	getCustomerOrderHandlingInstruction()
ScaledDecimal	getEndCash()
String	getFundDesignation()
LiquidityFlag	getLiquidityFlag() Indicates if an order was submitted for market making obligation as required for MiFID.
boolean	getManualOrderIndicator()
String	getMemoField()
String	getOrderID()
ReportSide.Parties	getParties()
ReportSide.RelatedTrades	getRelatedTrades()
String	getSecondaryAllocationGroupID() Gets clearing assigned identifier used for the allocation group.
Side	getSide() Gets the side of the order
String	getSideOrigTradeID() Used to capture the original trade id for each side of a trade undergoing novation to a standardized model.
ReportSide.SideRegulatoryTrades	getSideRegulatoryTrades()
ScaledDecimal	getStartCash()
String	getStrategyLinkID()
String	getText()
String	getTradeInputSource() CME Defined Supported Values: CPC = CME ClearPort® Clearing CPT = CME ClearPort® Trading CXPIT = COMEX Trading Floor GLBX = CME Globex® NXPIT = NYMEX Trading Floor
ReportSide.TradeTimeStamps	getTradeTimeStamps()
void	setAccruedInterestRate(ScaledDecimal value) The amount the buyer compensates the seller for the portion of the next coupon interest payment the seller has earned but will not receive from the issuer because the issuer will send the next coupon payment to the buyer.
void	setAggressorIndicator(boolean value)
void	setAllocationIndicator(AllocationIndicator value)
void	setAveragePricingIndicator(AveragePricingIndicator value)
void	setClientOrderID(String value)
void	setClientOrderID2(String value)
void	setCompressionGroupID(String value) Identifies all trades in a netting or compression group, including both terminating trades and any remnant trades that result from the operation
void	setCurrency(String value) Sets the currency used for price.
void	setCustomerCapacity(CustomerCapacity value)
void	setCustomerOrderHandlingInstruction(String value)
void	setEndCash(ScaledDecimal value)
void	setFundDesignation(String value)
void	setLiquidityFlag(LiquidityFlag value) Indicates if an order was submitted for market making obligation as required for MiFID.
void	setManualOrderIndicator(boolean value)
void	setMemoField(String value)
void	setOrderID(String value)
void	setSecondaryAllocationGroupID(String value) Sets clearing assigned identifier used for the allocation group.
void	setSide(Side value) Sets the side of the order
void	setSideOrigTradeID(String value) Used to capture the original trade id for each side of a trade undergoing novation to a standardized model.
void	setStartCash(ScaledDecimal value)
void	setStrategyLinkID(String value)
void	setText(String value)
void	setTradeInputSource(String value) CME Defined Supported Values: CPC = CME ClearPort® Clearing CPT = CME ClearPort® Trading CXPIT = COMEX Trading Floor GLBX = CME Globex® NXPIT = NYMEX Trading Floor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportSide

public ReportSide()

Default constructor.

Method Detail

getSide

public final Side getSide()

Gets the side of the order

Supported Values:

• 1 = Buy
• 2 = Sell

Returns:

the side of the order

setSide

public final void setSide(Side value)

Sets the side of the order

Supported Values:

• 1 = Buy
• 2 = Sell

Parameters:

value - the side of the order

getClientOrderID2

public String getClientOrderID2()

Returns:

Secondary Client Order ID.

setClientOrderID2

public void setClientOrderID2(String value)

Parameters:

value - Secondary Client Order ID.

getClientOrderID

public final String getClientOrderID()

Returns:

the TON number provided for CME Globex® trades and the Order ID for Pit trades. Format = Alphanumeric

setClientOrderID

public final void setClientOrderID(String value)

Parameters:

value - the TON number provided for CME Globex® trades and the Order ID for Pit trades. Format = Alphanumeric

getCurrency

public final String getCurrency()

Gets the currency used for price. It is recommended that systems provide the currency value whenever possible. Currency codes used in FIX are those defined in ISO 4217 standard. To obtain the current valid list: ISO 4217

Returns:

currency used for price.

setCurrency

public final void setCurrency(String value)

Sets the currency used for price. It is recommended that systems provide the currency value whenever possible. Currency codes used in FIX are those defined in ISO 4217 standard. To obtain the current valid list: ISO 4217

Parameters:

value - currency used for price.

getTradeInputSource

public final String getTradeInputSource()

CME Defined Supported Values:

• CPC = CME ClearPort® Clearing
• CPT = CME ClearPort® Trading
• CXPIT = COMEX Trading Floor
• GLBX = CME Globex®
• NXPIT = NYMEX Trading Floor

Returns:

trade input source

setTradeInputSource

public final void setTradeInputSource(String value)

CME Defined Supported Values:

• CPC = CME ClearPort® Clearing
• CPT = CME ClearPort® Trading
• CXPIT = COMEX Trading Floor
• GLBX = CME Globex®
• NXPIT = NYMEX Trading Floor

Parameters:

value - trade input source

getCustomerCapacity

public final CustomerCapacity getCustomerCapacity()

Returns:

the customer capacity for this trade.

setCustomerCapacity

public final void setCustomerCapacity(CustomerCapacity value)

Parameters:

value - the customer capacity for this trade.

getStartCash

public ScaledDecimal getStartCash()

Returns:

Starting dirty cash consideration of a financing deal, i.e. paid to the seller on the Start Date.

setStartCash

public void setStartCash(ScaledDecimal value)

Parameters:

value - Starting dirty cash consideration of a financing deal, i.e. paid to the seller on the Start Date.

getEndCash

public ScaledDecimal getEndCash()

Returns:

Ending dirty cash consideration of a financing deal. i.e. reimbursed to the buyer on the End Date.

setEndCash

public void setEndCash(ScaledDecimal value)

Parameters:

value - Ending dirty cash consideration of a financing deal. i.e. reimbursed to the buyer on the End Date.

getText

public String getText()

Returns:

Free format text string.

setText

public void setText(String value)

Parameters:

value - Free format text string.

getAllocationIndicator

public final AllocationIndicator getAllocationIndicator()

Returns:

indicator if the trade is marked for allocation.

setAllocationIndicator

public final void setAllocationIndicator(AllocationIndicator value)

Parameters:

value - indicator if the trade is marked for allocation.

getAveragePricingIndicator

public final AveragePricingIndicator getAveragePricingIndicator()

Returns:

indicator if the trade is marked for average pricing allocation.

setAveragePricingIndicator

public final void setAveragePricingIndicator(AveragePricingIndicator value)

Parameters:

value - indicator if the trade is marked for average pricing allocation.

getAggressorIndicator

public boolean getAggressorIndicator()

Returns:

indicator whether or not the order initiator is an aggressor in the trade.

setAggressorIndicator

public void setAggressorIndicator(boolean value)

Parameters:

value - indicator whether or not the order initiator is an aggressor in the trade.

getSideOrigTradeID

public String getSideOrigTradeID()

Used to capture the original trade id for each side of a trade undergoing novation to a standardized model.

Returns:

original trade id for each side of a trade undergoing novation to a standardized model

setSideOrigTradeID

public void setSideOrigTradeID(String value)

Used to capture the original trade id for each side of a trade undergoing novation to a standardized model.

Parameters:

value - original trade id for each side of a trade undergoing novation to a standardized model

getStrategyLinkID

public final String getStrategyLinkID()

Returns:

unique ID linking all individual legs of a spread or strategy together. It can also link individual legs to the parent multi-leg trade.

setStrategyLinkID

public final void setStrategyLinkID(String value)

Parameters:

value - unique ID linking all individual legs of a spread or strategy together. It can also link individual legs to the parent multi-leg trade.

getCustomerOrderHandlingInstruction

public String getCustomerOrderHandlingInstruction()

Returns:

the source of original order.

setCustomerOrderHandlingInstruction

public void setCustomerOrderHandlingInstruction(String value)

Parameters:

value - the source of original order.

getOrderID

public String getOrderID()

Returns:

Order ID.

setOrderID

public void setOrderID(String value)

Parameters:

value - Order ID.

getSecondaryAllocationGroupID

public final String getSecondaryAllocationGroupID()

Gets clearing assigned identifier used for the allocation group. This links trades marked for allocation that are part of the same group, as well as offset trades once allocations from that group are claimed.

Returns:

the clearing assigned identifier used for the allocation group.

setSecondaryAllocationGroupID

public final void setSecondaryAllocationGroupID(String value)

Sets clearing assigned identifier used for the allocation group. This links trades marked for allocation that are part of the same group, as well as offset trades once allocations from that group are claimed.

Parameters:

value - the clearing assigned identifier used for the allocation group.

getCompressionGroupID

public String getCompressionGroupID()

Identifies all trades in a netting or compression group, including both terminating trades and any remnant trades that result from the operation

Returns:

ID for trades in a netting or compression group

setCompressionGroupID

public void setCompressionGroupID(String value)

Identifies all trades in a netting or compression group, including both terminating trades and any remnant trades that result from the operation

Parameters:

value - ID for trades in a netting or compression group

getLiquidityFlag

public LiquidityFlag getLiquidityFlag()

Indicates if an order was submitted for market making obligation as required for MiFID. Applicable only for EU fixed income markets.

Returns:

flag specifying if an order was submitted for market making obligation as required for MiFID

setLiquidityFlag

public void setLiquidityFlag(LiquidityFlag value)

Indicates if an order was submitted for market making obligation as required for MiFID. Applicable only for EU fixed income markets.

Parameters:

value - flag specifying if an order was submitted for market making obligation as required for MiFID

getMemoField

public String getMemoField()

Returns:

Free format memo text field.

setMemoField

public void setMemoField(String value)

Parameters:

value - Free format memo text field.

getAccruedInterestRate

public ScaledDecimal getAccruedInterestRate()

The amount the buyer compensates the seller for the portion of the next coupon interest payment the seller has earned but will not receive from the issuer because the issuer will send the next coupon payment to the buyer. Accrued Interest Rate is the annualized Accrued Interest amount divided by the purchase price of the bond.

Returns:

annualized Accrued Interest amount divided by the purchase price of the bond

setAccruedInterestRate

public void setAccruedInterestRate(ScaledDecimal value)

The amount the buyer compensates the seller for the portion of the next coupon interest payment the seller has earned but will not receive from the issuer because the issuer will send the next coupon payment to the buyer. Accrued Interest Rate is the annualized Accrued Interest amount divided by the purchase price of the bond.

Parameters:

value - annualized Accrued Interest amount divided by the purchase price of the bond

getFundDesignation

public String getFundDesignation()

Returns:

Fund Designation as specified at order submission time.

setFundDesignation

public void setFundDesignation(String value)

Parameters:

value - Fund Designation as specified at order submission time.

getManualOrderIndicator

public final boolean getManualOrderIndicator()

Returns:

indicator if the order was created manually or through API.

setManualOrderIndicator

public final void setManualOrderIndicator(boolean value)

Parameters:

value - indicator if the order was created manually, or through API.

getParties

public final ReportSide.Parties getParties()

Returns:

list of parties.

getSideRegulatoryTrades

public final ReportSide.SideRegulatoryTrades getSideRegulatoryTrades()

Returns:

information about Side Regulatory Trades.

getCommissionData

public final ReportSide.CommissionDatas getCommissionData()

Returns:

information about Commission Data.

getTradeTimeStamps

public final ReportSide.TradeTimeStamps getTradeTimeStamps()

Returns:

the list of trade timestamps.

getRelatedTrades

public final ReportSide.RelatedTrades getRelatedTrades()

Returns:

list of related trades.