com.caplin.motif.fx.trading

Class FXExecution<T extends FXTradeLeg>

java.lang.Object

com.caplin.motif.trading.MotifTrade

com.caplin.motif.fx.trading.FXTrade

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

Type Parameters:

T - An object that extends FXTradeLeg.

Direct Known Subclasses:

BlockTradeExecution, ESPTrade, RFSTrade

public abstract class FXExecution<T extends FXTradeLeg>
extends FXTrade

Base class for trade objects within the FX Integration API.

All FX trades which can be executed extend this class.

Field Summary

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

trade

Constructor Summary

Constructors

Constructor and Description
FXExecution(com.caplin.trading.Trade trade, T nearLeg, T farLeg) Constructs the FXExecution that extends wraps around the trade object and provides convenience methods for obtaining fields and sending messages.

Method Summary

Modifier and Type	Method and Description
Account	getAccount() Returns the account that this trade should be booked against.
String	getBaseCurrency() Returns the base currency of the currency pair.
String	getCaption() Returns the caption for the currency pair
String	getCurrencyPair() Returns the currency pair that this trade should be executed against.
String	getDealtCurrency() Returns the currency that the amount denominates.
T	getFarLeg() Returns the far leg for swap trades, or null if this is not a swap trade.
T	getNearLeg() Returns the near leg of the trade.
FXSwapType	getSwapType() If the submitted trade is a swap trade, this method will return the swap type (either Spot Fwd Swap or Fwd Fwd Swap).
String	getTermCurrency() Returns the term currency of the currency pair.
FXTradingType	getTradingType() Returns the type of trade that should be executed.
String	toString()

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

getTradingProtocol, getTradingSubProtocol

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

createEvent, getCurrentState, getField, getRequestID, getTradeChannelSubject, getUsername, sendEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

FXExecution

public FXExecution(com.caplin.trading.Trade trade,
                   T nearLeg,
                   T farLeg)

Constructs the FXExecution that extends wraps around the trade object and provides convenience methods for obtaining fields and sending messages.

Parameters:

trade - The underlying trading datasource trade object.

nearLeg - The near leg of the trade.

farLeg - The far leg of the trade.

Method Detail

getNearLeg

public T getNearLeg()

Returns the near leg of the trade. All trade types will have a near leg.

Returns:

The near leg.

getFarLeg

public T getFarLeg()

Returns the far leg for swap trades, or null if this is not a swap trade.

Returns:

The far leg, or null if one does not exist.

getTradingType

public FXTradingType getTradingType()

Returns the type of trade that should be executed.

Returns:

The trade type.

getSwapType

public FXSwapType getSwapType()

If the submitted trade is a swap trade, this method will return the swap type (either Spot Fwd Swap or Fwd Fwd Swap).

Returns:

The swap type of the trade or null if the trade is not a swap trade.

getCurrencyPair

public String getCurrencyPair()

Returns the currency pair that this trade should be executed against.

Returns:

The currency pair in the format XXXYYY.

getCaption

public String getCaption()

Returns the caption for the currency pair

Returns:

The caption for the currency pair

getBaseCurrency

public String getBaseCurrency()

Returns the base currency of the currency pair.

Returns:

The base currency in the format XXX.

getTermCurrency

public String getTermCurrency()

Returns the term currency of the currency pair.

Returns:

The term currency in the format YYY.

getDealtCurrency

public String getDealtCurrency()

Returns the currency that the amount denominates.

Returns:

The dealt currency, which may contain sub decimals.

getAccount

public Account getAccount()

Returns the account that this trade should be booked against.

Returns:

The account.

toString

public String toString()

Overrides:

toString in class MotifTrade