TradeCaptureReport (CME STP (Straight Through Processing) Handler Parent 3.1.1 API)

java.lang.Object
- biz.onixs.cme.stp.handler.TradeCaptureReport

public class TradeCaptureReport
extends Object

Trade Capture Report Message

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TradeCaptureReport.Payments` Encapsulates list of Payments
`static class`	`TradeCaptureReport.PositionAmountDatas` Encapsulates list of PositionAmountDatas
`static class`	`TradeCaptureReport.ReportSides` Encapsulates list of ReportSides
`static class`	`TradeCaptureReport.RootParties` Encapsulates the list of RootParties
`static class`	`TradeCaptureReport.TradeLegs` Encapsulates list of TradeLegs
`static class`	`TradeCaptureReport.TradeRegulationPublications` Encapsulates the list of TradeRegulationPublications
`static class`	`TradeCaptureReport.UnderlyingInstruments` Encapsulates list of UnderlyingInstruments

Constructor Summary

Constructors
Constructor and Description

TradeCaptureReport()
Default Constructor

TradeCaptureReport(String xml)
Converts XML string to a parsed FIXML object.

Constructors
Constructor and Description
`TradeCaptureReport()` Default Constructor
`TradeCaptureReport(String xml)` Converts XML string to a parsed FIXML object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScaledDecimal`	`getAlternatePrice()`
`ScaledDecimal`	`getAveragePrice()`
`String`	`getBlockID()`
`ScaledDecimal`	`getCalculationCurrencyLastQuantity()` Used in calculating the quantity of the other side of the currency trade.
`ClearedIndicator`	`getClearedIndicator()`
`LocalDate`	`getClearingBusinessDate()`
`ClearingIntention`	`getClearingIntention()`
`ClearingRequirementException`	`getClearingRequirementException()`
`ClearingTransformationType`	`getClearingTransformationType()` Indicates the type of Clearing Transformation that generated this Trade.
`String`	`getClientOrderID()` Only provided on tickets resulting from an API Order, this is the ClOrdId from the order.
`String`	`getConfirmHubTradeType()`
`boolean`	`getContraryInstructionIndicator()` Used to indicate when a contrary instruction for exercise or abandonment is being submitted.
`String`	`getDealID()`
`ScaledDecimal`	`getDifferentialPrice()`
`DifferentialPriceType`	`getDifferentialPriceType()`
`String`	`getExecID()` Gets exchanged assigned Execution ID (Trade Identifier).
`String`	`getExecID2()`
`ExecutionMethod`	`getExecutionMethod()`
`ScaledDecimal`	`getFeeMultiplier()`
`FeeQuantityThresholdIndicator`	`getFeeQuantityThresholdIndicator()`
`FinancingDetails`	`getFinancingDetails()`
`ReportInstrument`	`getInstrument()`
`String`	`getLastMkt()`
`ScaledDecimal`	`getLastPrice()` Gets Overall Trade Price per contract for regular cleared trades.
`ScaledDecimal`	`getLastQty()` Gets Total Quantity based on user permissible allocation quantity.
`HighResolutionTimestamp`	`getLastUpdateTime()`
`int`	`getMarketDataTradeEntryID()` Unique Trade Identifier that will match to a CME Globex order execution, associated market data message and STP messaging.
`String`	`getMDStreamID()`
`MultiLegReportingType`	`getMultiLegReportingType()` Gets what a Multi-leg Report represents (e.g.
`boolean`	`getNonDisclosedIndicator()` Get flag indicating if this was a non-disclosed trade.
`OffsetInstruction`	`getOffsetInstruction()`
`OptionExerciseTimeFrame`	`getOptionExerciseTimeFrame()` For Exercise/Assignment Transformation, this indicates whether or not the resulting Future was the result of an Early Exercise Instruction (Prior to Settlement Date).
`String`	`getOrderID()` For Globex, this is the iLink OrderID.
`OriginalTimeUnit`	`getOriginalTimeUnit()`
`String`	`getPackageID()`
`ScaledDecimal`	`getPaymentAmount()`
`TradeCaptureReport.Payments`	`getPayments()`
`TradeCaptureReport.PositionAmountDatas`	`getPositionAmountData()`
`PostTradeType`	`getPostTradeType()` Identifies the type of ticket.
`PriceType`	`getPriceType()`
`QtyType`	`getQtyType()` Gets type of quantity specified in a quantity field.
`TradeCaptureReport.ReportSides`	`getReportSides()`
`TradeCaptureReport.RootParties`	`getRootParties()`
`String`	`getSenderCompID()`
`String`	`getSenderSubID()` Gets the CME assigned user role used to identify specific role (traderadmin or clearingadmin).
`String`	`getSettlCurrency()`
`LocalDate`	`getSettlDate()` Specific date of trade settlement (SettlementDate) in YYYYMMDD format.
`String`	`getSettlementTradeID()`
`String`	`getSettlType()` Gets settlement Type of trade.
`SplitIndicator`	`getSplitIndicator()`
`LocalDate`	`getSpotDate()` For FXNDF, the associated SPOT settlement date.
`String`	`getTargetCompID()`
`String`	`getTargetSubID()`
`TradeCollateralization`	`getTradeCollateralization()` If a swap is not cleared, an indication of whether a swap is Uncollateralized, Partially Collateralized, One-Way Collateralize, Fully Collateralized.
`LocalDate`	`getTradeDate()`
`String`	`getTradeID()`
`String`	`getTradeID2()`
`TradeCaptureReport.TradeLegs`	`getTradeLegs()`
`String`	`getTradeLinkID()` Used to link a group of trades together.
`String`	`getTradeMatchID()` Gets Trade Match ID is assigned by the matching engine or clearing system and used to correlate a cleared trade with a match event.
`String`	`getTradeNumber()`
`TradePriceNegotiationMethod`	`getTradePriceNegotiationMethod()`
`TradePriceStatus`	`getTradePriceStatus()`
`ArrayList<TradeRegulationPublication>`	`getTradeRegulationPublications()`
`String`	`getTradeReportID()`
`TradeReportTransType`	`getTradeReportTransType()` Gets type of Execution being reported.
`TradeReportType`	`getTradeReportType()` Gets the purpose of the trade within the workflow and determines the action of the receiver of the trade.
`String`	`getTradeRequestID()`
`TradeStatus`	`getTradeStatus()` Gets the status of the trade in clearing.
`TradeSubType`	`getTradeSubType()`
`TradeType`	`getTradeType()`
`ScaledDecimal`	`getTradingQuantity()` Indicates the trading quantity entered, in unit terms (e.g.
`HighResolutionTimestamp`	`getTransactTime()`
`String`	`getTransferReason()`
`TradeCaptureReport.UnderlyingInstruments`	`getUnderlyingInstruments()`
`VenueSubType`	`getVenueSubType()`
`VenueType`	`getVenueType()`
`Yield`	`getYield()`
`void`	`setAlternatePrice(ScaledDecimal value)`
`void`	`setAveragePrice(ScaledDecimal value)`
`void`	`setBlockID(String privateBlockID)`
`void`	`setCalculationCurrencyLastQuantity(ScaledDecimal value)` Used in calculating the quantity of the other side of the currency trade.
`void`	`setClearedIndicator(ClearedIndicator value)`
`void`	`setClearingBusinessDate(LocalDate value)`
`void`	`setClearingIntention(ClearingIntention value)`
`void`	`setClearingRequirementException(ClearingRequirementException value)`
`void`	`setClearingTransformationType(ClearingTransformationType value)` Indicates the type of Clearing Transformation that generated this Trade.
`void`	`setClientOrderID(String value)` Only provided on tickets resulting from an API Order, this is the ClOrdId from the order.
`void`	`setConfirmHubTradeType(String value)`
`void`	`setContraryInstructionIndicator(boolean value)` Used to indicate when a contrary instruction for exercise or abandonment is being submitted.
`void`	`setDealID(String value)`
`void`	`setDifferentialPrice(ScaledDecimal value)`
`void`	`setDifferentialPriceType(DifferentialPriceType value)`
`void`	`setExecID(String value)` Sets exchanged assigned Execution ID (Trade Identifier).
`void`	`setExecID2(String value)`
`void`	`setExecutionMethod(ExecutionMethod value)`
`void`	`setFeeMultiplier(ScaledDecimal value)`
`void`	`setFeeQuantityThresholdIndicator(FeeQuantityThresholdIndicator value)`
`void`	`setLastMkt(String value)`
`void`	`setLastPrice(ScaledDecimal value)` Sets Overall Trade Price per contract for regular cleared trades.
`void`	`setLastQty(ScaledDecimal value)` Sets Total Quantity based on user permissible allocation quantity.
`void`	`setLastUpdateTime(HighResolutionTimestamp value)`
`void`	`setMarketDataTradeEntryID(int value)` Unique Trade Identifier that will match to a CME Globex order execution, associated market data message and STP messaging.
`void`	`setMDStreamID(String value)`
`void`	`setMultiLegReportingType(MultiLegReportingType value)` Gets what a Multi-leg Report represents (e.g.
`void`	`setNonDisclosedIndicator(boolean value)` Set flag indicating if this was a non-disclosed trade.
`void`	`setOffsetInstruction(OffsetInstruction value)`
`void`	`setOptionExerciseTimeFrame(OptionExerciseTimeFrame value)` For Exercise/Assignment Transformation, this indicates whether or not the resulting Future was the result of an Early Exercise Instruction (Prior to Settlement Date).
`void`	`setOrderID(String value)` For Globex, this is the iLink OrderID.
`void`	`setOriginalTimeUnit(OriginalTimeUnit value)`
`void`	`setPackageID(String privatePackageID)`
`void`	`setPaymentAmount(ScaledDecimal value)`
`void`	`setPostTradeType(PostTradeType value)` Identifies the type of ticket.
`void`	`setPriceType(PriceType value)`
`void`	`setQtyType(QtyType value)` Gets type of quantity specified in a quantity field.
`void`	`setSenderCompID(String value)`
`void`	`setSenderSubID(String value)` Gets the CME assigned user role used to identify specific role (traderadmin or clearingadmin).
`void`	`setSettlCurrency(String value)`
`void`	`setSettlDate(LocalDate value)` Specific date of trade settlement (SettlementDate) in YYYYMMDD format.
`void`	`setSettlementTradeID(String value)`
`void`	`setSettlType(String value)` Sets settlement Type of trade.
`void`	`setSplitIndicator(SplitIndicator value)`
`void`	`setSpotDate(LocalDate value)` For FXNDF, the associated SPOT settlement date.
`void`	`setTargetCompID(String value)`
`void`	`setTargetSubID(String value)`
`void`	`setTradeCollateralization(TradeCollateralization value)` If a swap is not cleared, an indication of whether a swap is Uncollateralized, Partially Collateralized, One-Way Collateralize, Fully Collateralized.
`void`	`setTradeDate(LocalDate value)`
`void`	`setTradeID(String value)`
`void`	`setTradeID2(String value)`
`void`	`setTradeLinkID(String value)` Used to link a group of trades together.
`void`	`setTradeMatchID(String value)` Gets Trade Match ID is assigned by the matching engine or clearing system and used to correlate a cleared trade with a match event.
`void`	`setTradeNumber(String value)`
`void`	`setTradePriceNegotiationMethod(TradePriceNegotiationMethod value)`
`void`	`setTradePriceStatus(TradePriceStatus value)`
`void`	`setTradeReportID(String value)`
`void`	`setTradeReportTransType(TradeReportTransType value)` Gets type of Execution being reported.
`void`	`setTradeReportType(TradeReportType value)` Sets the purpose of the trade within the workflow and determines the action of the receiver of the trade.
`void`	`setTradeRequestID(String value)`
`void`	`setTradeStatus(TradeStatus value)` Gets the status of the trade in clearing.
`void`	`setTradeSubType(TradeSubType value)`
`void`	`setTradeType(TradeType value)`
`void`	`setTradingQuantity(ScaledDecimal value)` Indicates the trading quantity entered, in unit terms (e.g.
`void`	`setTransactTime(HighResolutionTimestamp value)`
`void`	`setTransferReason(String value)`
`void`	`setVenueSubType(VenueSubType value)`
`void`	`setVenueType(VenueType value)`

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

- Constructor Detail
  - TradeCaptureReport
```
public TradeCaptureReport()
```
    Default Constructor
  - TradeCaptureReport
```
public TradeCaptureReport(String xml)
                   throws ParserConfigurationException,
                          SAXException,
                          IOException
```
    Converts XML string to a parsed FIXML object.
    
    Parameters:
    
    xml - XML string
    
    Throws:
    
    ParserConfigurationException - for incorrect parser settings
    
    SAXException - when XML data cannot be parsed
    
    IOException - for I/O issues
- Method Detail
  - getSenderCompID
```
public final String getSenderCompID()
```
    Returns:
    
    the value used to identify customer firm sending message.
  - setSenderCompID
```
public final void setSenderCompID(String value)
```
    Parameters:
    
    value - the value used to identify customer firm sending message.
  - getTargetSubID
```
public final String getTargetSubID()
```
    Returns:
    
    the value used to identify specific message recipient (user, etc.). This echoes the SenderSubID sent on the request.
  - setTargetSubID
```
public final void setTargetSubID(String value)
```
    Parameters:
    
    value - the value used to identify specific message recipient (user, etc.). This echoes the SenderSubID sent on the request.
  - getSenderSubID
```
public final String getSenderSubID()
```
    Gets the CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
    
    Returns:
    
    CME assigned user role.
  - setSenderSubID
```
public final void setSenderSubID(String value)
```
    Gets the CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
    
    Parameters:
    
    value - CME assigned user role.
  - getTargetCompID
```
public final String getTargetCompID()
```
    Returns:
    
    the entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
  - setTargetCompID
```
public final void setTargetCompID(String value)
```
    Parameters:
    
    value - the entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
  - getTradeReportID
```
public final String getTradeReportID()
```
    Returns:
    
    the unique identifier for the Trade Capture Report. Maximum of 50 Characters.
  - setTradeReportID
```
public final void setTradeReportID(String value)
```
    Parameters:
    
    value - the unique identifier for the Trade Capture Report. Maximum of 50 Characters.
  - getTradeID
```
public final String getTradeID()
```
    Returns:
    
    the CME Front End Clearing (FEC) Firm Trade ID. TrdID does not match across buy/sell side.
  - setTradeID
```
public final void setTradeID(String value)
```
    Parameters:
    
    value - the CME Front End Clearing (FEC) Firm Trade ID. TrdID does not match across buy/sell side.
  - getTradeID2
```
public final String getTradeID2()
```
    Returns:
    
    the CME Front End Clearing (FEC) Firm Secondary Trade ID. TrdID2 does not match across buy/sell side.
  - setTradeID2
```
public final void setTradeID2(String value)
```
    Parameters:
    
    value - the CME Front End Clearing (FEC) Firm Secondary Trade ID. TrdID2 does not match across buy/sell side.
  - getPackageID
```
public String getPackageID()
```
    Returns:
    
    a value that identifies the group of trades or a portfolio of trades cleared simultaneously under the one Package ID.
  - setPackageID
```
public void setPackageID(String privatePackageID)
```
    Parameters:
    
    privatePackageID - a value that identifies the group of trades or a portfolio of trades cleared simultaneously under the one Package ID.
  - getTradeReportTransType
```
public final TradeReportTransType getTradeReportTransType()
```
    Gets type of Execution being reported.
    Supported Values:
    - 0 = New
    - 1 = Cancel (Void)
    - 2 = Replace (Correction/ Re-allocation)
    - 4 = Reverse
    Returns:
    
    the type of Execution being reported
  - setTradeReportTransType
```
public final void setTradeReportTransType(TradeReportTransType value)
```
    Gets type of Execution being reported.
    Supported Values:
    - 0 = New
    - 1 = Cancel (Void)
    - 2 = Replace (Correction/ Re-allocation)
    - 4 = Reverse
    Parameters:
    
    value - the type of Execution being reported
  - getTradeReportType
```
public final TradeReportType getTradeReportType()
```
    Gets the purpose of the trade within the workflow and determines the action of the receiver of the trade.
    Supported Values:
    - 101 = Notification
    Returns:
    
    the purpose of the trade within the workflow
  - setTradeReportType
```
public final void setTradeReportType(TradeReportType value)
```
    Sets the purpose of the trade within the workflow and determines the action of the receiver of the trade.
    Supported Values:
    - 101 = Notification
    Parameters:
    
    value - the purpose of the trade within the workflow
  - getTradeStatus
```
public final TradeStatus getTradeStatus()
```
    Gets the status of the trade in clearing.
    Supported Values:
    - 0 = Accepted
    - 7 = Terminated
    Returns:
    
    the status of the trade in clearing
  - setTradeStatus
```
public final void setTradeStatus(TradeStatus value)
```
    Gets the status of the trade in clearing.
    Supported Values:
    - 0 = Accepted
    - 7 = Terminated
    Parameters:
    
    value - the status of the trade in clearing
  - getTradeRequestID
```
public final String getTradeRequestID()
```
    Returns:
    
    the original RequestID from the Trade Capture Report Request will be returned.
  - setTradeRequestID
```
public final void setTradeRequestID(String value)
```
    Parameters:
    
    value - the original RequestID from the Trade Capture Report Request will be returned.
  - getTradeType
```
public final TradeType getTradeType()
```
    Returns:
    
    CME Trade Type && Trade Transfer Flag.
  - setTradeType
```
public final void setTradeType(TradeType value)
```
    Parameters:
    
    value - CME Trade Type && Trade Transfer Flag.
  - getTradeSubType
```
public final TradeSubType getTradeSubType()
```
    Returns:
    
    the CME Trade Type Subset, TAS Flag & the APS Offset and Onset Flag.
  - setTradeSubType
```
public final void setTradeSubType(TradeSubType value)
```
    Parameters:
    
    value - the CME Trade Type Subset, TAS Flag & the APS Offset and Onset Flag.
  - getOffsetInstruction
```
public final OffsetInstruction getOffsetInstruction()
```
    Returns:
    
    offset or onset due to allocation.
  - setOffsetInstruction
```
public final void setOffsetInstruction(OffsetInstruction value)
```
    Parameters:
    
    value - offset or onset due to allocation.
  - getTransferReason
```
public String getTransferReason()
```
    Returns:
    
    Reason trade is being transferred.
  - setTransferReason
```
public void setTransferReason(String value)
```
    Parameters:
    
    value - Reason trade is being transferred.
  - getTradeMatchID
```
public final String getTradeMatchID()
```
    Gets Trade Match ID is assigned by the matching engine or clearing system and used to correlate a cleared trade with a match event. Should be common for all trade sides included in a match event. For CME ClearPort, this represents the deal number and always links strategies. For CME Globex and Floor, this links calendar spreads only.
    
    Returns:
    
    Trade Match ID is assigned by the matching engine or clearing system
  - setTradeMatchID
```
public final void setTradeMatchID(String value)
```
    Gets Trade Match ID is assigned by the matching engine or clearing system and used to correlate a cleared trade with a match event. Should be common for all trade sides included in a match event. For CME ClearPort, this represents the deal number and always links strategies. For CME Globex and Floor, this links calendar spreads only.
    
    Parameters:
    
    value - Trade Match ID is assigned by the matching engine or clearing system
  - getTradeLinkID
```
public String getTradeLinkID()
```
    Used to link a group of trades together. Useful for linking a group of trades together for average price calculations.
    
    Returns:
    
    trade link ID
  - setTradeLinkID
```
public void setTradeLinkID(String value)
```
    Used to link a group of trades together. Useful for linking a group of trades together for average price calculations.
    
    Parameters:
    
    value - trade link ID
  - getTradeNumber
```
public String getTradeNumber()
```
    Returns:
    
    Trade Number
  - setTradeNumber
```
public void setTradeNumber(String value)
```
    Parameters:
    
    value - Trade Number
  - getDealID
```
public String getDealID()
```
    Returns:
    
    BrokerTec Deal ID, common to all participants within an entire trade (not only a match)
  - setDealID
```
public void setDealID(String value)
```
    Parameters:
    
    value - BrokerTec Deal ID, common to all participants within an entire trade (not only a match)
  - getExecID
```
public final String getExecID()
```
    Gets exchanged assigned Execution ID (Trade Identifier). Unique ID for each side of each leg and will now have a length of a maximum 26 characters long. ExecID does not match across buy/sell side.
    
    Returns:
    
    exchanged assigned Execution ID (Trade Identifier)
  - setExecID
```
public final void setExecID(String value)
```
    Sets exchanged assigned Execution ID (Trade Identifier). Unique ID for each side of each leg and will now have a length of a maximum 26 characters long. ExecID does not match across buy/sell side.
    
    Parameters:
    
    value - exchanged assigned Execution ID (Trade Identifier)
  - getExecID2
```
public final String getExecID2()
```
    Returns:
    
    value used to communicate the execution ID of the originating platform, e.g. the ClearPort execution ID.
  - setExecID2
```
public final void setExecID2(String value)
```
    Parameters:
    
    value - value used to communicate the execution ID of the originating platform, e.g. the ClearPort execution ID.
  - getBlockID
```
public String getBlockID()
```
    Returns:
    
    platform-assigned block ID for the trade.
  - setBlockID
```
public void setBlockID(String privateBlockID)
```
    Parameters:
    
    privateBlockID - platform-assigned block ID for the trade.
  - getPriceType
```
public final PriceType getPriceType()
```
    Returns:
    
    Settlement Price indicator for TAS, EFM and EFP’s priced off settlement.
  - setPriceType
```
public final void setPriceType(PriceType value)
```
    Parameters:
    
    value - Settlement Price indicator for TAS, EFM and EFP’s priced off settlement.
  - getVenueType
```
public final VenueType getVenueType()
```
    Returns:
    
    the type of venue where a trade was executed.
  - setVenueType
```
public final void setVenueType(VenueType value)
```
    Parameters:
    
    value - the type of venue where a trade was executed.
  - getQtyType
```
public final QtyType getQtyType()
```
    Gets type of quantity specified in a quantity field.
    Supported Value:
    - 0 = Notional / Units
    - 1 = Contracts (Default - should specify ContractMultiplier)
    Returns:
    
    type of quantity specified in a quantity field
  - setQtyType
```
public final void setQtyType(QtyType value)
```
    Gets type of quantity specified in a quantity field.
    Supported Value:
    - 0 = Notional / Units
    - 1 = Contracts (Default - should specify ContractMultiplier)
    Parameters:
    
    value - type of quantity specified in a quantity field
  - getLastQty
```
public final ScaledDecimal getLastQty()
```
    Gets Total Quantity based on user permissible allocation quantity. Note: Zero ("0") will appear when a trade is reallocated out to a different account owner or Clearing Member.
    
    Returns:
    
    Total Quantity based on user permissible allocation quantity
  - setLastQty
```
public final void setLastQty(ScaledDecimal value)
```
    Sets Total Quantity based on user permissible allocation quantity. Note: Zero ("0") will appear when a trade is reallocated out to a different account owner or Clearing Member.
    
    Parameters:
    
    value - Total Quantity based on user permissible allocation quantity
  - getLastPrice
```
public final ScaledDecimal getLastPrice()
```
    Gets Overall Trade Price per contract for regular cleared trades. For Average Price (APS): the Rounded Price will be placed in LastPx.
    
    Returns:
    
    Overall Trade Price
  - setLastPrice
```
public final void setLastPrice(ScaledDecimal value)
```
    Sets Overall Trade Price per contract for regular cleared trades. For Average Price (APS): the Rounded Price will be placed in LastPx.
    
    Parameters:
    
    value - Overall Trade Price
  - getCalculationCurrencyLastQuantity
```
public ScaledDecimal getCalculationCurrencyLastQuantity()
```
    Used in calculating the quantity of the other side of the currency trade.
    
    Returns:
    
    Calculation Currency Last Quantity
  - setCalculationCurrencyLastQuantity
```
public void setCalculationCurrencyLastQuantity(ScaledDecimal value)
```
    Used in calculating the quantity of the other side of the currency trade.
    
    Parameters:
    
    value - Calculation Currency Last Quantity
  - getTradeDate
```
public final LocalDate getTradeDate()
```
    Returns:
    
    Trade Date
  - setTradeDate
```
public final void setTradeDate(LocalDate value)
```
    Parameters:
    
    value - Trade Date
  - getClearingBusinessDate
```
public final LocalDate getClearingBusinessDate()
```
    Returns:
    
    the "Clearing Business Date" referred to by this report.
  - setClearingBusinessDate
```
public final void setClearingBusinessDate(LocalDate value)
```
    Parameters:
    
    value - the "Clearing Business Date" referred to by this report.
  - getAveragePrice
```
public final ScaledDecimal getAveragePrice()
```
    Returns:
    
    calculated average price of all fills on this order. Will be populated for Average Price System (APS) transactions only.
  - setAveragePrice
```
public final void setAveragePrice(ScaledDecimal value)
```
    Parameters:
    
    value - calculated average price of all fills on this order. Will be populated for Average Price System (APS) transactions only.
  - getMultiLegReportingType
```
public final MultiLegReportingType getMultiLegReportingType()
```
    Gets what a Multi-leg Report represents (e.g. used with multi-leg trades, such as option call, puts, spreads, etc.).
    Supported Values:
    - 1 = Single side (default if not specified)
    - 2 = Individual leg of a multi-leg trade
    - 3 = Multi leg of a multi-leg trade
    Returns:
    
    MultiLeg Reporting Type
  - setMultiLegReportingType
```
public final void setMultiLegReportingType(MultiLegReportingType value)
```
    Gets what a Multi-leg Report represents (e.g. used with multi-leg trades, such as option call, puts, spreads, etc.).
    Supported Values:
    - 1 = Single side (default if not specified)
    - 2 = Individual leg of a multi-leg trade
    - 3 = Multi leg of a multi-leg trade
    Parameters:
    
    value - MultiLeg Reporting Type
  - getTransactTime
```
public final HighResolutionTimestamp getTransactTime()
```
    Returns:
    
    date and time when the trade was executed.
  - setTransactTime
```
public final void setTransactTime(HighResolutionTimestamp value)
```
    Parameters:
    
    value - date and time when the trade was executed.
  - getExecutionMethod
```
public ExecutionMethod getExecutionMethod()
```
    Returns:
    
    whether the transaction was executed via an automated execution platform or other method.
  - setExecutionMethod
```
public void setExecutionMethod(ExecutionMethod value)
```
    Parameters:
    
    value - whether the transaction was executed via an automated execution platform or other method.
  - getSettlDate
```
public LocalDate getSettlDate()
```
    Specific date of trade settlement (SettlementDate) in YYYYMMDD format. If present, this field overrides SettlType. This field is required if the value of SettlType is 6 (Future) or 8 (Sellers Option). This field must be omitted if the value of SettlType is 7 (When and If Issued) (expressed in local time at place of settlement).
    
    Returns:
    
    date of trade settlement
  - setSettlDate
```
public void setSettlDate(LocalDate value)
```
    Specific date of trade settlement (SettlementDate) in YYYYMMDD format. If present, this field overrides SettlType. This field is required if the value of SettlType is 6 (Future) or 8 (Sellers Option). This field must be omitted if the value of SettlType is 7 (When and If Issued) (expressed in local time at place of settlement).
    
    Parameters:
    
    value - date of trade settlement
  - getLastUpdateTime
```
public final HighResolutionTimestamp getLastUpdateTime()
```
    Returns:
    
    last modification date and time of the trade/allocation information. Timestamp of last update to data item (or creation if no updates made since creation).
  - setLastUpdateTime
```
public final void setLastUpdateTime(HighResolutionTimestamp value)
```
    Parameters:
    
    value - last modification date and time of the trade/allocation information. Timestamp of last update to data item (or creation if no updates made since creation).
  - getClearedIndicator
```
public ClearedIndicator getClearedIndicator()
```
    Returns:
    
    An indication of whether or not a reportable swap transaction is cleared by a derivatives clearing organization.
  - setClearedIndicator
```
public void setClearedIndicator(ClearedIndicator value)
```
    Parameters:
    
    value - An indication of whether or not a reportable swap transaction is cleared by a derivatives clearing organization.
  - getClearingIntention
```
public ClearingIntention getClearingIntention()
```
    Returns:
    
    An indication of whether or not a reportable swap transaction is intended to clear.
  - setClearingIntention
```
public void setClearingIntention(ClearingIntention value)
```
    Parameters:
    
    value - An indication of whether or not a reportable swap transaction is intended to clear.
  - getClearingRequirementException
```
public ClearingRequirementException getClearingRequirementException()
```
    Returns:
    
    An indication of whether a party to a swap is using the end-user exception.
  - setClearingRequirementException
```
public void setClearingRequirementException(ClearingRequirementException value)
```
    Parameters:
    
    value - An indication of whether a party to a swap is using the end-user exception.
  - getTradeCollateralization
```
public TradeCollateralization getTradeCollateralization()
```
    If a swap is not cleared, an indication of whether a swap is Uncollateralized, Partially Collateralized, One-Way Collateralize, Fully Collateralized.
    
    Returns:
    
    Trade Collateralization
  - setTradeCollateralization
```
public void setTradeCollateralization(TradeCollateralization value)
```
    If a swap is not cleared, an indication of whether a swap is Uncollateralized, Partially Collateralized, One-Way Collateralize, Fully Collateralized.
    
    Parameters:
    
    value - Trade Collateralization
  - getDifferentialPrice
```
public final ScaledDecimal getDifferentialPrice()
```
    Returns:
    
    the differential price for spreads, or a TAS or TAM differential price.
  - setDifferentialPrice
```
public final void setDifferentialPrice(ScaledDecimal value)
```
    Parameters:
    
    value - the differential price for spreads, or a TAS or TAM differential price.
  - getDifferentialPriceType
```
public final DifferentialPriceType getDifferentialPriceType()
```
    Returns:
    
    the type of differential price represented in the Differential Price attribute.
  - setDifferentialPriceType
```
public final void setDifferentialPriceType(DifferentialPriceType value)
```
    Parameters:
    
    value - the type of differential price represented in the Differential Price attribute.
  - getOriginalTimeUnit
```
public final OriginalTimeUnit getOriginalTimeUnit()
```
    Returns:
    
    the Time Unit of the original trade, e.g. whether it was entered as contracts per day or per month.
  - setOriginalTimeUnit
```
public final void setOriginalTimeUnit(OriginalTimeUnit value)
```
    Parameters:
    
    value - the Time Unit of the original trade, e.g. whether it was entered as contracts per day or per month.
  - getTradingQuantity
```
public ScaledDecimal getTradingQuantity()
```
    Indicates the trading quantity entered, in unit terms (e.g. in MWh), for a trade. This may differ from the cleared quantity, especially in the case of contracts like electricity that follow delivery schedules.
    
    Returns:
    
    trading quantity entered, in unit terms (e.g. in MWh), for a trade
  - setTradingQuantity
```
public void setTradingQuantity(ScaledDecimal value)
```
    Indicates the trading quantity entered, in unit terms (e.g. in MWh), for a trade. This may differ from the cleared quantity, especially in the case of contracts like electricity that follow delivery schedules.
    
    Parameters:
    
    value - trading quantity entered, in unit terms (e.g. in MWh), for a trade
  - getConfirmHubTradeType
```
public String getConfirmHubTradeType()
```
    Returns:
    
    custom field to represent specific Confirm Hub Trade Types.
  - setConfirmHubTradeType
```
public void setConfirmHubTradeType(String value)
```
    Parameters:
    
    value - custom field to represent specific Confirm Hub Trade Types.
  - getMarketDataTradeEntryID
```
public int getMarketDataTradeEntryID()
```
    Unique Trade Identifier that will match to a CME Globex order execution, associated market data message and STP messaging.
    
    Returns:
    
    Unique Trade Identifier
  - setMarketDataTradeEntryID
```
public void setMarketDataTradeEntryID(int value)
```
    Unique Trade Identifier that will match to a CME Globex order execution, associated market data message and STP messaging.
    
    Parameters:
    
    value - Unique Trade Identifier
  - getFeeMultiplier
```
public ScaledDecimal getFeeMultiplier()
```
    Returns:
    
    Multiplier that Clearing (Fee system) will use to calculate fees and will be sent to the firms on their confirms.
  - setFeeMultiplier
```
public void setFeeMultiplier(ScaledDecimal value)
```
    Parameters:
    
    value - Multiplier that Clearing (Fee system) will use to calculate fees and will be sent to the firms on their confirms.
  - getSplitIndicator
```
public SplitIndicator getSplitIndicator()
```
    Returns:
    
    Indicator whether or not a trade is split.
  - setSplitIndicator
```
public void setSplitIndicator(SplitIndicator value)
```
    Parameters:
    
    value - Indicator whether or not a trade is split.
  - getAlternatePrice
```
public ScaledDecimal getAlternatePrice()
```
    Returns:
    
    Alternate price.
  - setAlternatePrice
```
public void setAlternatePrice(ScaledDecimal value)
```
    Parameters:
    
    value - Alternate price.
  - getSettlementTradeID
```
public String getSettlementTradeID()
```
    Returns:
    
    Trade identifier as assigned by BrokerTec Clearing.
  - setSettlementTradeID
```
public void setSettlementTradeID(String value)
```
    Parameters:
    
    value - Trade identifier as assigned by BrokerTec Clearing.
  - getClearingTransformationType
```
public ClearingTransformationType getClearingTransformationType()
```
    Indicates the type of Clearing Transformation that generated this Trade.
    
    Returns:
    
    type of Clearing Transformation
  - setClearingTransformationType
```
public void setClearingTransformationType(ClearingTransformationType value)
```
    Indicates the type of Clearing Transformation that generated this Trade.
    
    Parameters:
    
    value - type of Clearing Transformation
  - getContraryInstructionIndicator
```
public boolean getContraryInstructionIndicator()
```
    Used to indicate when a contrary instruction for exercise or abandonment is being submitted.
    
    Returns:
    
    Contrary Instruction Indicator
  - setContraryInstructionIndicator
```
public void setContraryInstructionIndicator(boolean value)
```
    Used to indicate when a contrary instruction for exercise or abandonment is being submitted.
    
    Parameters:
    
    value - Contrary Instruction Indicator
  - getOptionExerciseTimeFrame
```
public OptionExerciseTimeFrame getOptionExerciseTimeFrame()
```
    For Exercise/Assignment Transformation, this indicates whether or not the resulting Future was the result of an Early Exercise Instruction (Prior to Settlement Date).
    
    Returns:
    
    Option Exercise Time Frame
  - setOptionExerciseTimeFrame
```
public void setOptionExerciseTimeFrame(OptionExerciseTimeFrame value)
```
    For Exercise/Assignment Transformation, this indicates whether or not the resulting Future was the result of an Early Exercise Instruction (Prior to Settlement Date).
    
    Parameters:
    
    value - Option Exercise Time Frame
  - getLastMkt
```
public String getLastMkt()
```
    Returns:
    
    Market of execution for last fill, or an indication of the market where an order was routed.
  - setLastMkt
```
public void setLastMkt(String value)
```
    Parameters:
    
    value - Market of execution for last fill, or an indication of the market where an order was routed.
  - getNonDisclosedIndicator
```
public boolean getNonDisclosedIndicator()
```
    Get flag indicating if this was a non-disclosed trade. All non-disclosed trades will include this tag/attribute with "Y". All disclosed trades will not include this tag/attribute.
    
    Returns:
    
    Non Disclosed Indicator
  - setNonDisclosedIndicator
```
public void setNonDisclosedIndicator(boolean value)
```
    Set flag indicating if this was a non-disclosed trade. All non-disclosed trades will include this tag/attribute with "Y". All disclosed trades will not include this tag/attribute.
    
    Parameters:
    
    value - Non Disclosed Indicator
  - getVenueSubType
```
public VenueSubType getVenueSubType()
```
    Returns:
    
    the sub-type of the venue where a trade was executed.
  - setVenueSubType
```
public void setVenueSubType(VenueSubType value)
```
    Parameters:
    
    value - the sub-type of the venue where a trade was executed.
  - getMDStreamID
```
public String getMDStreamID()
```
    Returns:
    
    The identifier or name of the price stream.
  - setMDStreamID
```
public void setMDStreamID(String value)
```
    Parameters:
    
    value - The identifier or name of the price stream.
  - getPostTradeType
```
public final PostTradeType getPostTradeType()
```
    Identifies the type of ticket. Interdealer tickets(also known as Market tickets) are received by Bilateral GFIDs or Prime Broker GFIDs(when facing bilateral codes, ie not when facing their Prime Customer). Prime Give Up tickets are also known as synthetic tickets and are those in which either the Prime Broker or Prime of Prime Broker faces their Prime Client, OR when the Prime(or Prime of Prime) Client faces their credit parent broker. Prime of Prime Broker tickets are similar to Interdealer tickets in nature but are solely when the Prime of Prime Broker faces their credit parent broker.
    
    Returns:
    
    the type of ticket
  - setPostTradeType
```
public final void setPostTradeType(PostTradeType value)
```
    Identifies the type of ticket. Interdealer tickets(also known as Market tickets) are received by Bilateral GFIDs or Prime Broker GFIDs(when facing bilateral codes, ie not when facing their Prime Customer). Prime Give Up tickets are also known as synthetic tickets and are those in which either the Prime Broker or Prime of Prime Broker faces their Prime Client, OR when the Prime(or Prime of Prime) Client faces their credit parent broker. Prime of Prime Broker tickets are similar to Interdealer tickets in nature but are solely when the Prime of Prime Broker faces their credit parent broker.
    
    Parameters:
    
    value - the type of ticket
  - getTradePriceStatus
```
public final TradePriceStatus getTradePriceStatus()
```
    Returns:
    
    status of the price.
  - setTradePriceStatus
```
public final void setTradePriceStatus(TradePriceStatus value)
```
    Parameters:
    
    value - status of the price.
  - getFeeQuantityThresholdIndicator
```
public final FeeQuantityThresholdIndicator getFeeQuantityThresholdIndicator()
```
    Returns:
    
    indicator flag used to determine the eligibility of fee discount based on threshold level.
  - setFeeQuantityThresholdIndicator
```
public final void setFeeQuantityThresholdIndicator(FeeQuantityThresholdIndicator value)
```
    Parameters:
    
    value - indicator flag used to determine the eligibility of fee discount based on threshold level.
  - getSettlCurrency
```
public final String getSettlCurrency()
```
    Returns:
    
    currency code of settlement denomination. For non-ndfs this will be the same as contra currency. For NDFs this will be the deliverable currency.
  - setSettlCurrency
```
public final void setSettlCurrency(String value)
```
    Parameters:
    
    value - currency code of settlement denomination. For non-ndfs this will be the same as contra currency. For NDFs this will be the deliverable currency.
  - getSettlType
```
public final String getSettlType()
```
    Gets settlement Type of trade. Note: B represents broken date, actual settlement date is reflected in getSettlDate().
    
    Returns:
    
    settlement Type of trade.
  - setSettlType
```
public final void setSettlType(String value)
```
    Sets settlement Type of trade. Note: B represents broken date, actual settlement date is reflected in setSettlDate(LocalDate).
    
    Parameters:
    
    value - settlement Type of trade.
  - getSpotDate
```
public final LocalDate getSpotDate()
```
    For FXNDF, the associated SPOT settlement date. Note: Not provided for FXSPOT.
    
    Returns:
    
    Spot Date
  - setSpotDate
```
public final void setSpotDate(LocalDate value)
```
    For FXNDF, the associated SPOT settlement date. Note: Not provided for FXSPOT.
    
    Parameters:
    
    value - Spot Date
  - getOrderID
```
public final String getOrderID()
```
    For Globex, this is the iLink OrderID. For EBS Direct, this is the LC Tag 37 seen in the Execution Report received.Not provided for LP tickets.
    
    Returns:
    
    iLink OrderID
  - setOrderID
```
public final void setOrderID(String value)
```
    For Globex, this is the iLink OrderID. For EBS Direct, this is the LC Tag 37 seen in the Execution Report received.Not provided for LP tickets.
    
    Parameters:
    
    value - iLink OrderID
  - getClientOrderID
```
public final String getClientOrderID()
```
    Only provided on tickets resulting from an API Order, this is the ClOrdId from the order. Not provided for LPs on EBS Direct. Provided to PBs to see their Prime Client's ClOrdID on interdealer tickets only (not synthetic tickets).
    
    Returns:
    
    the ClOrdId from the order
  - setClientOrderID
```
public final void setClientOrderID(String value)
```
    Only provided on tickets resulting from an API Order, this is the ClOrdId from the order. Not provided for LPs on EBS Direct. Provided to PBs to see their Prime Client's ClOrdID on interdealer tickets only (not synthetic tickets).
    
    Parameters:
    
    value - the ClOrdId from the order
  - getRootParties
```
public final TradeCaptureReport.RootParties getRootParties()
```
    Returns:
    
    information about parties reported.
  - getInstrument
```
public final ReportInstrument getInstrument()
```
    Returns:
    
    information about Instrument reported.
  - getFinancingDetails
```
public final FinancingDetails getFinancingDetails()
```
    Returns:
    
    Information about financing details reported.
  - getPayments
```
public final TradeCaptureReport.Payments getPayments()
```
    Returns:
    
    information about payments.
  - getUnderlyingInstruments
```
public final TradeCaptureReport.UnderlyingInstruments getUnderlyingInstruments()
```
    Returns:
    
    information about Underlying Instruments reported.
  - getPositionAmountData
```
public final TradeCaptureReport.PositionAmountDatas getPositionAmountData()
```
    Returns:
    
    information about Position Amounts reported.
  - getTradeLegs
```
public final TradeCaptureReport.TradeLegs getTradeLegs()
```
    Returns:
    
    information about Position Amounts reported.
  - getReportSides
```
public final TradeCaptureReport.ReportSides getReportSides()
```
    Returns:
    
    information about Sides reported.
  - getTradeRegulationPublications
```
public final ArrayList<TradeRegulationPublication> getTradeRegulationPublications()
```
    Returns:
    
    information about trade regulations reported.
  - getTradePriceNegotiationMethod
```
public final TradePriceNegotiationMethod getTradePriceNegotiationMethod()
```
    Returns:
    
    the method used to negotiate the trade price. This is to support CDS trade negotiation where dealers can negotiate prices in deal spread or in percent of par.
  - setTradePriceNegotiationMethod
```
public final void setTradePriceNegotiationMethod(TradePriceNegotiationMethod value)
```
    Parameters:
    
    value - the method used to negotiate the trade price. This is to support CDS trade negotiation where dealers can negotiate prices in deal spread or in percent of par.
  - getPaymentAmount
```
public ScaledDecimal getPaymentAmount()
```
    Returns:
    
    The total payment amount.
  - setPaymentAmount
```
public void setPaymentAmount(ScaledDecimal value)
```
    Parameters:
    
    value - The total payment amount.
  - getYield
```
public final Yield getYield()
```
    Returns:
    
    information about yield reported.

Class TradeCaptureReport

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TradeCaptureReport

TradeCaptureReport

Method Detail

getSenderCompID

setSenderCompID

getTargetSubID

setTargetSubID

getSenderSubID

setSenderSubID

getTargetCompID

setTargetCompID

getTradeReportID

setTradeReportID

getTradeID

setTradeID

getTradeID2

setTradeID2

getPackageID

setPackageID

getTradeReportTransType

setTradeReportTransType

getTradeReportType

setTradeReportType

getTradeStatus

setTradeStatus

getTradeRequestID

setTradeRequestID

getTradeType

setTradeType

getTradeSubType

setTradeSubType

getOffsetInstruction

setOffsetInstruction

getTransferReason

setTransferReason

getTradeMatchID

setTradeMatchID

getTradeLinkID

setTradeLinkID

getTradeNumber

setTradeNumber

getDealID

setDealID

getExecID

setExecID

getExecID2

setExecID2

getBlockID

setBlockID

getPriceType

setPriceType

getVenueType

setVenueType

getQtyType

setQtyType

getLastQty

setLastQty

getLastPrice

setLastPrice

getCalculationCurrencyLastQuantity

setCalculationCurrencyLastQuantity

getTradeDate

setTradeDate

getClearingBusinessDate

setClearingBusinessDate

getAveragePrice

setAveragePrice

getMultiLegReportingType

setMultiLegReportingType

getTransactTime

setTransactTime

getExecutionMethod

setExecutionMethod

getSettlDate