Caplin Systems - PickUpTradeEvent (FX Integration API Documentation)

java.lang.Object
- com.caplin.generated.motif.fx.trading.salesintervention.events.client.PickUpTradeEvent

All Implemented Interfaces:

LeggedMessage, LeggedMessageRoot, Message
```
public class PickUpTradeEvent
extends Object
implements LeggedMessageRoot
```
A single event acting on a SalesInterventionTrade.

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

A SalesInterventionTradeEvent is created using the SalesInterventionTrade it relates to.

A SalesInterventionTradeEvent typically represents a message received from the client or sent by the server. A message contains a set of fields and values which can be accessed using the Message.getField(String) method.

Constructor Summary

Constructors
Constructor Description

PickUpTradeEvent(com.caplin.trading.TradeEvent tradeEvent)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.caplin.trading.TradeEvent`	`getBackingEvent()`
`Map<String,String>`	`getFields()`	Gets the fields of this TradeEvent as a Map
`String`	`getTradeRequestID()`
`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.LeggedMessageRoot
getId, getIndex

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

- Constructor Detail
  - PickUpTradeEvent
```
public PickUpTradeEvent(com.caplin.trading.TradeEvent tradeEvent)
```
- Method Detail
  - getFields
```
public Map<String,String> getFields()
```
    Gets the fields of this TradeEvent as a Map
    
    Specified by:
    
    getFields in interface Message
    
    Returns:
    
    a map of the fields;
  - getTradeRequestID
```
public String getTradeRequestID()
```
    Returns:
    
    The unique id identifying the trade to be picked up.
  - getBackingEvent
```
public com.caplin.trading.TradeEvent getBackingEvent()
```
    Returns:
    
    Get the TradeEvent backing this event
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object