com.caplin.motif.trading

Class MotifTrade

java.lang.Object

com.caplin.motif.trading.MotifTrade

Direct Known Subclasses:

BulkOrderActionTrade, CancelRequest, ChangeActiveState, EditStrategyRequest, FXTrade, MotifOrderStrategy, PostTradeAllocationList

public class MotifTrade
extends Object

Top level trade object used within the Integration API which all trade objects should extend.

The MotifTrade wraps around the Trade object from the underlying trading datasource library, and provides convenience methods to obtain fields and send messages.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.caplin.trading.Trade	trade

Constructor Summary

Constructors

Constructor and Description
MotifTrade(com.caplin.trading.Trade trade) Constructs a MotifTrade that wraps around the trade object and provides convenience methods.

Method Summary

Modifier and Type	Method and Description
com.caplin.trading.TradeEvent	createEvent(String eventName)
String	getCurrentState() Returns the current state name as defined in the state model xml that the trade is in.
String	getField(String fieldName) Returns the field value with the specified field name.
String	getRequestID() Returns the ID generated from the client.
String	getTradeChannelSubject() Returns the subject of the trade channel that this trade was created on.
String	getUsername() Returns the username of the logged in user that created this trade.
void	sendEvent(com.caplin.trading.TradeEvent event)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

trade

protected final com.caplin.trading.Trade trade

Constructor Detail

MotifTrade

public MotifTrade(com.caplin.trading.Trade trade)

Constructs a MotifTrade that wraps around the trade object and provides convenience methods.

Parameters:

trade - The trade object that the MotifTrade wraps around

Method Detail

getRequestID

public String getRequestID()

Returns the ID generated from the client. The combination of user and trade is unique.

Returns:

the request ID.

getUsername

public String getUsername()

Returns the username of the logged in user that created this trade.

Returns:

the username of the logged in user.

getTradeChannelSubject

public String getTradeChannelSubject()

Returns the subject of the trade channel that this trade was created on.

Returns:

The trade channel subject.

getCurrentState

public String getCurrentState()

Returns the current state name as defined in the state model xml that the trade is in.

Returns:

The current state.

getField

public String getField(String fieldName)

Returns the field value with the specified field name.

Parameters:

fieldName - The name of the field.

Returns:

The field value.

createEvent

public com.caplin.trading.TradeEvent createEvent(String eventName)
                                          throws com.caplin.trading.TradeException

Throws:

com.caplin.trading.TradeException

sendEvent

public void sendEvent(com.caplin.trading.TradeEvent event)
               throws com.caplin.trading.TradeException

Throws:

com.caplin.trading.TradeException

toString

public String toString()

Overrides:

toString in class Object