Caplin Systems - CompleteTradeEvent (FX Integration API Documentation)

java.lang.Object
- com.caplin.generated.motif.fx.trading.settlement.events.server.CompleteTradeEvent

All Implemented Interfaces:

Message
```
public class CompleteTradeEvent
extends Object
implements Message
```
A single event acting on a SettlementTrade.

The event may be client generated and received through the respective RFSTradeListener interface or it may be generated by custom code to be sent to the client.

A SettlementTradeEvent is created using the SettlementTrade it relates to.

A SettlementTradeEvent represents a message sent by the server.

Constructor Summary

Constructors
Constructor Description

CompleteTradeEvent(SettlementTrade trade)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addField(String fieldName, Object value)`	Adds a field to this Event.
`void`	`addFields(Map<String,?> fields)`	Adds a map of fields and their values to this event
`com.caplin.trading.TradeEvent`	`getBackingEvent()`
`Map<String,String>`	`getFields()`
`void`	`setInitialTimestamp(Date date)`	Sets LTY_INIT_TS field to this TradeEvent.
`String`	`toString()`

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

Methods inherited from interface com.caplin.motif.datasource.Message
getField

- Constructor Detail
  - CompleteTradeEvent
```
public CompleteTradeEvent(SettlementTrade trade)
```
- Method Detail
  - getFields
```
public Map<String,String> getFields()
```
    Specified by:
    
    getFields in interface Message
  - addField
```
public void addField(String fieldName,
                     Object value)
```
    Adds a field to this Event.
    
    Parameters:
    
    fieldName - The name of the field to add.
    
    value - The value of the field to add. If the value is a BigDecimal then it will be converted to a String using BigDecimal.toPlainString()
  - addFields
```
public void addFields(Map<String,?> fields)
```
    Adds a map of fields and their values to this event
    
    Parameters:
    
    fields - A map of field names to values to be added to the event. If the value is a BigDecimal then it will be converted to a String using BigDecimal.toPlainString()
  - setInitialTimestamp
```
public void setInitialTimestamp(Date date)
```
    Sets LTY_INIT_TS field to this TradeEvent.
    
    Parameters:
    
    date - The time the LTY_INIT_TS field will be set to.
  - getBackingEvent
```
public com.caplin.trading.TradeEvent getBackingEvent()
```
    Returns:
    
    Get the TradeEvent backing this event
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object