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

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

```
public class TradeCaptureReportRequestAcknowledgment
extends Object
```
The Request Acknowledgment will only be sent to deliver error messages.

Constructor Summary

Constructors
Constructor and Description
`TradeCaptureReportRequestAcknowledgment()` Default constructor.
`TradeCaptureReportRequestAcknowledgment(String xml)` Constructs an instance of `TradeCaptureReportRequestAcknowledgment`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getSenderCompID()` Gets the value used to identify the customer firm sending the message.
`String`	`getSenderSubID()` Gets the CME-assigned user role used to identify a specific role (traderadmin or clearingadmin).
`SubscriptionRequestType`	`getSubscriptionRequestType()` Gets Subscription Request Type
`String`	`getTargetCompID()` Gets the entity to whom the message is being sent.
`String`	`getTargetSubID()` Gets the value used to identify the specific message recipient (user, etc.).
`String`	`getText()` Gets a free-format text string for error messaging.
`String`	`getTradeRequestID()`
`TradeRequestResult`	`getTradeRequestResult()` Gets result of Trade Request
`TradeRequestStatus`	`getTradeRequestStatus()` Gets status of Trade Request.
`TradeRequestType`	`getTradeRequestType()` Gets type of Trade Capture Report.
`void`	`setSenderCompID(String value)` Sets the value used to identify the customer firm sending the message.
`void`	`setSenderSubID(String value)` Sets the CME-assigned user role used to identify a specific role (traderadmin or clearingadmin).
`void`	`setSubscriptionRequestType(SubscriptionRequestType value)` Gets Subscription Request Type
`void`	`setTargetCompID(String value)` Sets the entity to whom the message is being sent.
`void`	`setTargetSubID(String value)` Sets the value used to identify the specific message recipient (user, etc.).
`void`	`setText(String value)` Sets a free-format text string for error messaging.
`void`	`setTradeRequestID(String value)`
`void`	`setTradeRequestResult(TradeRequestResult value)` Gets result of Trade Request
`void`	`setTradeRequestStatus(TradeRequestStatus value)` Gets status of Trade Request.
`void`	`setTradeRequestType(TradeRequestType value)` Gets type of Trade Capture Report.
`String`	`toString()`

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

- Constructor Detail
  - TradeCaptureReportRequestAcknowledgment
```
public TradeCaptureReportRequestAcknowledgment()
```
    Default constructor.
  - TradeCaptureReportRequestAcknowledgment
```
public TradeCaptureReportRequestAcknowledgment(String xml)
                                        throws ParserConfigurationException,
                                               SAXException,
                                               IOException
```
    Constructs an instance of TradeCaptureReportRequestAcknowledgment.
    
    Parameters:
    
    xml - FIXML string
    
    Throws:
    
    ParserConfigurationException - if a parser configuration error occurs
    
    SAXException - if an XML parsing error occurs
    
    IOException - if an I/O error occurs
- Method Detail
  - getSenderCompID
```
public final String getSenderCompID()
```
    Gets the value used to identify the customer firm sending the message.
    
    Returns:
    
    the sender company ID
  - setSenderCompID
```
public final void setSenderCompID(String value)
```
    Sets the value used to identify the customer firm sending the message.
    
    Parameters:
    
    value - the sender company ID
  - getTargetSubID
```
public final String getTargetSubID()
```
    Gets the value used to identify the specific message recipient (user, etc.). This echoes the SenderSubID sent on the request.
    
    Returns:
    
    the target sub ID
  - setTargetSubID
```
public final void setTargetSubID(String value)
```
    Sets the value used to identify the specific message recipient (user, etc.). This echoes the SenderSubID sent on the request.
    
    Parameters:
    
    value - the target sub ID
  - getSenderSubID
```
public final String getSenderSubID()
```
    Gets the CME-assigned user role used to identify a specific role (traderadmin or clearingadmin). If not specified, it defaults to the highest assigned role.
    
    Returns:
    
    the sender sub ID
  - setSenderSubID
```
public final void setSenderSubID(String value)
```
    Sets the CME-assigned user role used to identify a specific role (traderadmin or clearingadmin). If not specified, it defaults to the highest assigned role.
    
    Parameters:
    
    value - the sender sub ID
  - getTargetCompID
```
public final String getTargetCompID()
```
    Gets the entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
    
    Returns:
    
    the target company ID
  - setTargetCompID
```
public final void setTargetCompID(String value)
```
    Sets the entity to whom the message is being sent. This echoes the SenderCompID sent on the request.
    
    Parameters:
    
    value - the target company ID
  - getText
```
public final String getText()
```
    Gets a free-format text string for error messaging. (Note: this field does not have a specified maximum length).
    
    Returns:
    
    the text message
  - setText
```
public final void setText(String value)
```
    Sets a free-format text string for error messaging. (Note: this field does not have a specified maximum length).
    
    Parameters:
    
    value - the text message
  - getSubscriptionRequestType
```
public final SubscriptionRequestType getSubscriptionRequestType()
```
    Gets Subscription Request Type
    Supported Values:
    - 0 = Snapshot (Query)
    - 1 = Subscribe
    Returns:
    
    Subscription Request Type
  - setSubscriptionRequestType
```
public final void setSubscriptionRequestType(SubscriptionRequestType value)
```
    Gets Subscription Request Type
    Supported Values:
    - 0 = Snapshot (Query)
    - 1 = Subscribe
    Parameters:
    
    value - Subscription Request Type
  - getTradeRequestID
```
public final String getTradeRequestID()
```
    Returns:
    
    unique ID from client.
  - setTradeRequestID
```
public final void setTradeRequestID(String value)
```
    Parameters:
    
    value - unique ID from client.
  - getTradeRequestType
```
public final TradeRequestType getTradeRequestType()
```
    Gets type of Trade Capture Report.
    Supported Values:
    - 0 = All trades (subscribe only)
    - 1 =Initial request for results matching Criteria provided on request (filtered subscription or query snapshot)
    - 2 = (Not supported)
    - 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)
```
    Gets type of Trade Capture Report.
    Supported Values:
    - 0 = All trades (subscribe only)
    - 1 =Initial request for results matching Criteria provided on request (filtered subscription or query snapshot)
    - 2 = (Not supported)
    - 3 = Continue sending results of query snapshot/subscription polling (TradeRequestID must match original request)
    Parameters:
    
    value - type of Trade Capture Report
  - getTradeRequestResult
```
public final TradeRequestResult getTradeRequestResult()
```
    Gets result of Trade Request
    Supported Values:
    - 0 = Successful (Default)
    - 1 = Invalid or unknown instrument
    - 2 = Invalid type of trade requested
    - 3 = Invalid parties
    - 4 = Invalid Transport Type requested
    - 5 = Invalid Destination requested
    - 8 = TradeRequestType not supported
    - 9 = Unauthorized for Trade Capture Report Request
    Returns:
    
    Trade Request Result
  - setTradeRequestResult
```
public final void setTradeRequestResult(TradeRequestResult value)
```
    Gets result of Trade Request
    Supported Values:
    - 0 = Successful (Default)
    - 1 = Invalid or unknown instrument
    - 2 = Invalid type of trade requested
    - 3 = Invalid parties
    - 4 = Invalid Transport Type requested
    - 5 = Invalid Destination requested
    - 8 = TradeRequestType not supported
    - 9 = Unauthorized for Trade Capture Report Request
    Parameters:
    
    value - Trade Request Result
  - getTradeRequestStatus
```
public final TradeRequestStatus getTradeRequestStatus()
```
    Gets status of Trade Request.
    Supported Values:
    - 0 = Accepted
    - 1 = Completed
    - 2 = Rejected
    Returns:
    
    Trade Request Status
  - setTradeRequestStatus
```
public final void setTradeRequestStatus(TradeRequestStatus value)
```
    Gets status of Trade Request.
    Supported Values:
    - 0 = Accepted
    - 1 = Completed
    - 2 = Rejected
    Parameters:
    
    value - Trade Request Status
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TradeCaptureReportRequestAcknowledgment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TradeCaptureReportRequestAcknowledgment

TradeCaptureReportRequestAcknowledgment

Method Detail

getSenderCompID

setSenderCompID

getTargetSubID

setTargetSubID

getSenderSubID

setSenderSubID

getTargetCompID

setTargetCompID

getText

setText

getSubscriptionRequestType

setSubscriptionRequestType

getTradeRequestID

setTradeRequestID

getTradeRequestType

setTradeRequestType

getTradeRequestResult

setTradeRequestResult

getTradeRequestStatus

setTradeRequestStatus

toString