Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.trading.restoration

TradeRestoreEvent

An event which is fired before and after a trade is restored.

Constructor Summary

Attributes Name and Description
caplin.trading.restoration.TradeRestoreEvent(caplin.trading.trademodel.Trade oTrade, String sPreviousState, String sRestoreState, Map mPreviousFieldData, Map mRestoredFieldData)

Method Summary

Attributes Name and Description
Map getPreviousFieldData()

Returns the data of the trade prior to being restored.
String getPreviousState()

Returns the previous state that the trade was in.
Map getRestoredFieldData()

Returns the data that the trade will be restored with.
String getRestoreState()

Returns the state that the trade is restoring into.
caplin.trading.trademodel.Trade getTrade()

Returns the trade that is being restored.

Constructor Detail

► caplin.trading.restoration.TradeRestoreEvent(caplin.trading.trademodel.Trade oTrade, String sPreviousState, String sRestoreState, Map mPreviousFieldData, Map mRestoredFieldData)

Parameters
caplin.trading.trademodel.Trade oTrade The trade that was restored.
String sPreviousState The state that the trade was in before restoring.
String sRestoreState The state that the trade is restoring to.
Map mPreviousFieldData The data of the trade before the trade was restored.
Map mRestoredFieldData The data of the trade after the trade was restored.
See
caplin.trading.restoration.TradeRestoredListener

Method Detail

► Map getPreviousFieldData()

Returns the data of the trade prior to being restored. This includes previous leg data (prefixed with 'L<legId>_' eg 'L1_').

Returns
{Map} The previous trade data.

► String getPreviousState()

Returns the previous state that the trade was in.

Returns
{String} The previous state.
See
#getRestoreState

► Map getRestoredFieldData()

Returns the data that the trade will be restored with.

Returns
{Map} The restored trade data.

► String getRestoreState()

Returns the state that the trade is restoring into.

Returns
{String} The state the trade is restoring into.
See
#getPreviousState

► caplin.trading.trademodel.Trade getTrade()

Returns the trade that is being restored. This may be null if this is a caplin.trading.restoration.TradeRestoredListener#beforeTradeRestored event and the trade currently does not exist on the client.

Returns
{caplin.trading.trademodel.Trade} The restored trade.