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

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

public class TradeCaptureReportRequest
extends Object

Trade Capture Report Request message.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TradeCaptureReportRequest.Parties` Encapsulates the list of Parties
`static class`	`TradeCaptureReportRequest.TradeCaptureDates` Encapsulates the list of TradeCaptureDates

Constructor Summary

Constructors
Constructor and Description

TradeCaptureReportRequest()
Default constructor.

Constructors
Constructor and Description
`TradeCaptureReportRequest()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocalDate`	`getClearingBusinessDate()` To request trades for a specific clearing business date.
`String`	`getClientOrderID()`
`ZonedDateTime`	`getEndTime()` Gets the ending time of the query.
`IncludeCollateralIndicator`	`getIncludeCollateralIndicator()` Gets indicator if collateral should be returned in request result.
`RequestInstrument`	`getInstrument()`
`ZonedDateTime`	`getLastUpdateTime()` Date/time which subscription should start pull data from.
`ManualOrderIndicator`	`getManualOrderIndicator()` Used to subscribe to tickets based on origination either from API or manually created trades.
`MultiLegReportingType`	`getMultiLegReportingType()` Gets if trades are to be returned for the individual legs of a multi-leg instrument (2) or for the overall instrument (3).
`NonDisclosedIndicator`	`getNonDisclosedIndicator()` Used to subscribe to tickets based on disclosed or non-disclosed status of the trade.
`ArrayList<RequestParty>`	`getParties()`
`PostTradeType`	`getPostTradeType()` Used to filter for / subscribe to tickets based on the ticket type.
`String`	`getSenderCompID()`
`String`	`getSenderSubID()`
`ZonedDateTime`	`getStartTime()` Gets the starting time of the subscription or query.
`SubscriptionRequestType`	`getSubscriptionRequestType()` Gets Subscription Request Type Supported Values:
`String`	`getTargetCompID()`
`String`	`getTargetSubID()`
`TradeCaptureReportRequest.TradeCaptureDates`	`getTradeCaptureDates()`
`String`	`getTradeID()`
`String`	`getTradeID2()`
`String`	`getTradeInputSource()` CME Defined Supported Values: CPC = CME ClearPort® Clearing CPT = CME ClearPort® Trading CXPIT = COMEX Trading Floor EBSD = EBS Direct GLBX = CME Globex® NXPIT = NYMEX Trading Floor
`TradePartyType`	`getTradePartyType()` When used in conjunction with `PartyRole` R=7 (Trading Firm) provides further context of the role played by that trading firm.
`String`	`getTradeRequestID()`
`TradeRequestType`	`getTradeRequestType()` Gets type of Trade Capture Report.
`VenueType`	`getVenueType()` Used to subscribe to trades based on the venue where the trade was executed.
`void`	`setClearingBusinessDate(LocalDate value)` To request trades for a specific clearing business date.
`void`	`setClientOrderID(String value)`
`void`	`setEndTime(ZonedDateTime value)` Gets the ending time of the query.
`void`	`setIncludeCollateralIndicator(IncludeCollateralIndicator value)` Gets indicator if collateral should be returned in request result.
`void`	`setLastUpdateTime(ZonedDateTime value)` Date/time which subscription should start pull data from.
`void`	`setManualOrderIndicator(ManualOrderIndicator value)` Used to subscribe to tickets based on origination either from API or manually created trades.
`void`	`setMultiLegReportingType(MultiLegReportingType value)` Sets if trades are to be returned for the individual legs of a multi-leg instrument (2) or for the overall instrument (3).
`void`	`setNonDisclosedIndicator(NonDisclosedIndicator value)` Used to subscribe to tickets based on disclosed or non-disclosed status of the trade.
`void`	`setPostTradeType(PostTradeType value)` Used to filter for / subscribe to tickets based on the ticket type.
`void`	`setSenderCompID(String value)`
`void`	`setSenderSubID(String value)`
`void`	`setStartTime(ZonedDateTime value)` Sets the starting time of the subscription or query.
`void`	`setSubscriptionRequestType(SubscriptionRequestType value)` Sets Subscription Request Type Supported Values:
`void`	`setTargetCompID(String value)`
`void`	`setTargetSubID(String value)`
`void`	`setTradeID(String value)`
`void`	`setTradeID2(String value)`
`void`	`setTradeInputSource(String value)` CME Defined Supported Values: CPC = CME ClearPort® Clearing CPT = CME ClearPort® Trading CXPIT = COMEX Trading Floor EBSD = EBS Direct GLBX = CME Globex® NXPIT = NYMEX Trading Floor
`void`	`setTradePartyType(TradePartyType value)` When used in conjunction with `PartyRole` R=7 (Trading Firm) provides further context of the role played by that trading firm.
`void`	`setTradeRequestID(String value)`
`void`	`setTradeRequestType(TradeRequestType value)` Sets type of Trade Capture Report.
`void`	`setVenueType(VenueType value)` Used to subscribe to trades based on the venue where the trade was executed.
`String`	`toXmlString()` FIXML string representation of the TradeCaptureReportRequest.

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

- Constructor Detail
  - TradeCaptureReportRequest
```
public TradeCaptureReportRequest()
```
    Default constructor.
- Method Detail
  - getSenderCompID
```
public final String getSenderCompID()
```
    Returns:
    
    value used to identify firm sending message.
  - setSenderCompID
```
public final void setSenderCompID(String value)
```
    Parameters:
    
    value - value used to identify firm sending message.
  - getSenderSubID
```
public final String getSenderSubID()
```
    Returns:
    
    CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
  - setSenderSubID
```
public final void setSenderSubID(String value)
```
    Parameters:
    
    value - CME assigned user role used to identify specific role (traderadmin or clearingadmin). If not specified will default to highest assigned role.
  - getTargetCompID
```
public final String getTargetCompID()
```
    Returns:
    
    value 'CME' or CME Firm ID.
  - setTargetCompID
```
public final void setTargetCompID(String value)
```
    Parameters:
    
    value - value 'CME' or CME Firm ID.
  - getTargetSubID
```
public final String getTargetSubID()
```
    Returns:
    
    value 'STP' or CME Venue ID.
  - setTargetSubID
```
public final void setTargetSubID(String value)
```
    Parameters:
    
    value - value 'STP' or CME Venue ID.
  - getTradeRequestID
```
public final String getTradeRequestID()
```
    Returns:
    
    Unique ID from client.
  - setTradeRequestID
```
public final void setTradeRequestID(String value)
```
    Parameters:
    
    value - Unique ID from client.
  - 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 Trade Secondary 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 Trade Secondary ID. TrdID2 does not match across buy/sell side.
  - getTradeRequestType
```
public final TradeRequestType getTradeRequestType()
```
    Gets type of Trade Capture Report.
    Supported Values:
    - 1 =Initial request for results matching Criteria provided on request (filtered subscription or query snapshot)
    - 3 = Continue sending results of query snapshot/subscription polling (TradeRequestID must match original request)
    Returns:
    
    type of Trade Capture Report
  - setTradeRequestType
```
public final void setTradeRequestType(TradeRequestType value)
```
    Sets type of Trade Capture Report.
    Supported Values:
    - 1 =Initial request for results matching Criteria provided on request (filtered subscription or query snapshot)
    - 3 = Continue sending results of query snapshot/subscription polling (TradeRequestID must match original request)
    Parameters:
    
    value - type of Trade Capture Report
  - getSubscriptionRequestType
```
public final SubscriptionRequestType getSubscriptionRequestType()
```
    Gets Subscription Request Type Supported Values:
    
    Returns:
    
    Subscription Request Type
  - setSubscriptionRequestType
```
public final void setSubscriptionRequestType(SubscriptionRequestType value)
```
    Sets Subscription Request Type Supported Values:
    
    Parameters:
    
    value - Subscription Request Type
  - 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.
  - getClearingBusinessDate
```
public final LocalDate getClearingBusinessDate()
```
    To request trades for a specific clearing business date.
    
    Returns:
    
    clearing business date
  - setClearingBusinessDate
```
public final void setClearingBusinessDate(LocalDate value)
```
    To request trades for a specific clearing business date.
    
    Parameters:
    
    value - clearing business date
  - getMultiLegReportingType
```
public final MultiLegReportingType getMultiLegReportingType()
```
    Gets if trades are to be returned for the individual legs of a multi-leg instrument (2) or for the overall instrument (3).
    Required
    
    Returns:
    
    MultiLeg Reporting Type
  - setMultiLegReportingType
```
public final void setMultiLegReportingType(MultiLegReportingType value)
```
    Sets if trades are to be returned for the individual legs of a multi-leg instrument (2) or for the overall instrument (3).
    Required
    
    Parameters:
    
    value - MultiLeg Reporting Type
  - getTradeInputSource
```
public final String getTradeInputSource()
```
    CME Defined Supported Values:
    - CPC = CME ClearPort® Clearing
    - CPT = CME ClearPort® Trading
    - CXPIT = COMEX Trading Floor
    - EBSD = EBS Direct
    - 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
    - EBSD = EBS Direct
    - GLBX = CME Globex®
    - NXPIT = NYMEX Trading Floor
    Parameters:
    
    value - Trade Input Source
  - getLastUpdateTime
```
public ZonedDateTime getLastUpdateTime()
```
    Date/time which subscription should start pull data from. Format: YYYYMMDD-HH:MM:SS (UTC time zone) Request without tag 779-LastUpdateTime will default to current date and time. This tag is not used for Snapshot requests and will be ignored if present. Example: 20200514-06:20:37
    
    Returns:
    
    Date/time which subscription should start pull data from
  - setLastUpdateTime
```
public void setLastUpdateTime(ZonedDateTime value)
```
    Date/time which subscription should start pull data from. Format: YYYYMMDD-HH:MM:SS (UTC time zone) Request without tag 779-LastUpdateTime will default to current date and time. This tag is not used for Snapshot requests and will be ignored if present. Example: 20200514-06:20:37
    
    Parameters:
    
    value - Date/time which subscription should start pull data from
  - getStartTime
```
public final ZonedDateTime getStartTime()
```
    Gets the starting time of the subscription or query. For a subscription, the default is to start at the current time. This field is required for a query. In UTC.
    
    Returns:
    
    start time for query filter
  - setStartTime
```
public final void setStartTime(ZonedDateTime value)
```
    Sets the starting time of the subscription or query. For a subscription, the default is to start at the current time. This field is required for a query. In UTC.
    
    Parameters:
    
    value - start time for query filter
  - getEndTime
```
public final ZonedDateTime getEndTime()
```
    Gets the ending time of the query. In UTC.
    
    Returns:
    
    ending time of the query filter
  - setEndTime
```
public final void setEndTime(ZonedDateTime value)
```
    Gets the ending time of the query. In UTC.
    
    Parameters:
    
    value - ending time of the query filter
  - getPostTradeType
```
public final PostTradeType getPostTradeType()
```
    Used to filter for / subscribe to tickets based on the ticket type. Typically only valid for use by Prime Brokers. Prime Give Up tickets are also known as synthetic tickets representing the back to back deal with the prime Customer.
    
    Returns:
    
    Post Trade Type filter
  - setPostTradeType
```
public final void setPostTradeType(PostTradeType value)
```
    Used to filter for / subscribe to tickets based on the ticket type. Typically only valid for use by Prime Brokers. Prime Give Up tickets are also known as synthetic tickets representing the back to back deal with the prime Customer.
    
    Parameters:
    
    value - Post Trade Type filter
  - getManualOrderIndicator
```
public final ManualOrderIndicator getManualOrderIndicator()
```
    Used to subscribe to tickets based on origination either from API or manually created trades.
    
    Returns:
    
    Manual Order Indicator filter
  - setManualOrderIndicator
```
public final void setManualOrderIndicator(ManualOrderIndicator value)
```
    Used to subscribe to tickets based on origination either from API or manually created trades.
    
    Parameters:
    
    value - Manual Order Indicator filter
  - getNonDisclosedIndicator
```
public final NonDisclosedIndicator getNonDisclosedIndicator()
```
    Used to subscribe to tickets based on disclosed or non-disclosed status of the trade. Only applies to EBS Direct trades, ignored for Globex trades.
    
    Returns:
    
    Non Disclosed Indicator filter
  - setNonDisclosedIndicator
```
public final void setNonDisclosedIndicator(NonDisclosedIndicator value)
```
    Used to subscribe to tickets based on disclosed or non-disclosed status of the trade. Only applies to EBS Direct trades, ignored for Globex trades.
    
    Parameters:
    
    value - Non Disclosed Indicator filter
  - getVenueType
```
public final VenueType getVenueType()
```
    Used to subscribe to trades based on the venue where the trade was executed. For Globex Venue Type is set to 'E'. For EBS Direct Venue Type is set to 'Q'.
    
    Returns:
    
    Venue Type filter
  - setVenueType
```
public final void setVenueType(VenueType value)
```
    Used to subscribe to trades based on the venue where the trade was executed. For Globex Venue Type is set to 'E'. For EBS Direct Venue Type is set to 'Q'.
    
    Parameters:
    
    value - Venue Type filter
  - getTradePartyType
```
public final TradePartyType getTradePartyType()
```
    When used in conjunction with PartyRole R=7 (Trading Firm) provides further context of the role played by that trading firm.
    
    Returns:
    
    Party Type filter
  - setTradePartyType
```
public final void setTradePartyType(TradePartyType value)
```
    When used in conjunction with PartyRole R=7 (Trading Firm) provides further context of the role played by that trading firm.
    
    Parameters:
    
    value - Party Type filter
  - getIncludeCollateralIndicator
```
public final IncludeCollateralIndicator getIncludeCollateralIndicator()
```
    Gets indicator if collateral should be returned in request result.
    
    Returns:
    
    Collateral Indicator filter
  - setIncludeCollateralIndicator
```
public final void setIncludeCollateralIndicator(IncludeCollateralIndicator value)
```
    Gets indicator if collateral should be returned in request result.
    
    Parameters:
    
    value - Collateral Indicator filter
  - getInstrument
```
public final RequestInstrument getInstrument()
```
    Returns:
    
    description of requested instrument filter
  - getParties
```
public final ArrayList<RequestParty> getParties()
```
    Returns:
    
    list of requested parties.
  - getTradeCaptureDates
```
public final TradeCaptureReportRequest.TradeCaptureDates getTradeCaptureDates()
```
    Returns:
    
    list of Trade Capture Dates
  - toXmlString
```
public String toXmlString()
                   throws ParserConfigurationException,
                          TransformerException
```
    FIXML string representation of the TradeCaptureReportRequest.
    
    Returns:
    
    xml string.
    
    Throws:
    
    ParserConfigurationException - for incorrect configuration of the parser
    
    TransformerException - when object cannot be converted to FIXML string

Class TradeCaptureReportRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TradeCaptureReportRequest

Method Detail

getSenderCompID

setSenderCompID

getSenderSubID

setSenderSubID

getTargetCompID

setTargetCompID

getTargetSubID

setTargetSubID

getTradeRequestID

setTradeRequestID

getTradeID

setTradeID

getTradeID2

setTradeID2

getTradeRequestType

setTradeRequestType

getSubscriptionRequestType

setSubscriptionRequestType

getClientOrderID

setClientOrderID

getClearingBusinessDate

setClearingBusinessDate

getMultiLegReportingType

setMultiLegReportingType

getTradeInputSource

setTradeInputSource

getLastUpdateTime

setLastUpdateTime

getStartTime

setStartTime

getEndTime

setEndTime

getPostTradeType

setPostTradeType

getManualOrderIndicator

setManualOrderIndicator

getNonDisclosedIndicator

setNonDisclosedIndicator

getVenueType

setVenueType

getTradePartyType

setTradePartyType

getIncludeCollateralIndicator

setIncludeCollateralIndicator

getInstrument

getParties

getTradeCaptureDates

toXmlString