Caplin Systems - ChangeStateTradeEvent (FX Integration API Documentation)

java.lang.Object
- com.caplin.generated.motif.fx.orders.orderchangestate.events.client.ChangeStateTradeEvent

All Implemented Interfaces:

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

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 OrderChangeStateTradeEvent is created using the OrderChangeStateTrade it relates to.

A OrderChangeStateTradeEvent 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

ChangeStateTradeEvent(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`	`getNewState()`
`String`	`getOrderID()`
`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
  - ChangeStateTradeEvent
```
public ChangeStateTradeEvent(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;
  - getOrderID
```
public String getOrderID()
```
    Returns:
    
    The ID of the order to be activated/deactivated
  - getNewState
```
public String getNewState()
```
    Returns:
    
    The new state that we would like the order to switch to, e.g. Active, Inactive
  - getBackingEvent
```
public com.caplin.trading.TradeEvent getBackingEvent()
```
    Returns:
    
    Get the TradeEvent backing this event
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object