com.caplin.motif.fx.trading.esp

Class ESPTrade

java.lang.Object

com.caplin.motif.trading.MotifTrade

com.caplin.motif.fx.trading.FXTrade

com.caplin.motif.fx.trading.FXExecution<FXExecutionTradeLeg>

com.caplin.motif.fx.trading.esp.ESPTrade

public class ESPTrade
extends FXExecution<FXExecutionTradeLeg>

An ESPTrade is a domain object that represents an Executable Streaming Price trade. These trades are generally executed from a trade tile.

You do not need to construct instances of this class yourself. Instances of this class are created by the FX Integration API in response to ESP trade requests from the client, and passed to your implementation of ESPTradeListenerFactory.createESPTradeListener(ESPTrade).

Field Summary

Fields inherited from class com.caplin.motif.trading.MotifTrade

trade

Method Summary

Methods

Modifier and Type	Method and Description
String	getAmount() Returns the amount at which the ESP trade should be executed.
ClientCloseSentResponder	getClientCloseSentResponder() Returns the responder used for sending events from the ClientCloseSent state.
PickedUpResponder	getPickedUpResponder() Returns the responder used for sending events from the PickedUp state.
QueuedResponder	getQueuedResponder() Returns the responder used for sending events from the Queued state.
SubmittedResponder	getSubmittedResponder() Returns the responder used for sending events from the Submitted state.
FXTradingProtocol	getTradingProtocol() Returns the FXTradingProtocol that was used to enter this trade.
TradingSubProtocol	getTradingSubProtocol() Returns the TradingSubProtocol that was used to enter this trade.

Methods inherited from class com.caplin.motif.fx.trading.FXExecution

getAccount, getBaseCurrency, getCaption, getCurrencyPair, getDealtCurrency, getFarLeg, getNearLeg, getSwapType, getTermCurrency, getTradingType, toString

Methods inherited from class com.caplin.motif.trading.MotifTrade

getCurrentState, getField, getRequestID, getTradeChannelSubject, getUsername

Methods inherited from class java.lang.Object

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

Method Detail

getAmount

public String getAmount()

Returns the amount at which the ESP trade should be executed.

Returns:

The amount, which may contain decimals.

getSubmittedResponder

public SubmittedResponder getSubmittedResponder()

Returns the responder used for sending events from the Submitted state.

This responder is the first one you should use after you receive the the ESPTradeListener.onSubmit(com.caplin.motif.fx.trading.esp.event.ESPSubmitEvent) callback, and you should use it to send an acknowledgement that you have received the trade request by calling SubmittedResponder.sendSubmitAck(com.caplin.motif.fx.trading.esp.event.ESPSubmitAckEvent).

This is typically done immediately on receiving the event, before submitting anything to the trading system.

Returns:

The Submitted responder.

getQueuedResponder

public QueuedResponder getQueuedResponder()

Returns the responder used for sending events from the Queued state.

When the backend system auto trader or a manual dealer picks up the trade, this responder should be used to transition to the PickedUp state by calling QueuedResponder.sendPickUp(com.caplin.motif.fx.trading.esp.event.ESPPickUpEvent).

Returns:

The Queued Responder.

getPickedUpResponder

public PickedUpResponder getPickedUpResponder()

Returns the responder used for sending events from the PickedUp state.

Once the trade has been confirmed or rejected, this responder should be used to represent those transitions.

Returns:

The PickedUp Responder

getClientCloseSentResponder

public ClientCloseSentResponder getClientCloseSentResponder()

Returns the responder used for sending events from the ClientCloseSent state.

If a client attempts to close a trade, probably from the Queued state, the current state will be ClientCloseSent. Once the trade cancelation request has been confirmed or rejected, this responder should be used to represent those transitions.

Returns:

The ClientClosedSent Responder. Note: in the next version, this method will return an instance of ClientCloseSentResponder instead of the deprecated class ClientCloseSentResponder.

getTradingProtocol

public FXTradingProtocol getTradingProtocol()

Description copied from class: FXTrade

Returns the FXTradingProtocol that was used to enter this trade.

Specified by:

getTradingProtocol in class FXTrade

Returns:

The FXTradingProtocol used to enter this trade.

getTradingSubProtocol

public TradingSubProtocol getTradingSubProtocol()

Description copied from class: FXTrade

Returns the TradingSubProtocol that was used to enter this trade. This defaults to TradingSubProtocol.NONE if no protocol was provided.

Specified by:

getTradingSubProtocol in class FXTrade

Returns:

The TradingSubProtocol that was use to enter this trade.