com.caplin.motif.fx.rates

Class FXSubjectInfo

java.lang.Object

com.caplin.motif.fx.rates.AbstractSubjectInfo

com.caplin.motif.fx.rates.FXSubjectInfo

All Implemented Interfaces:

SubjectInfo

public class FXSubjectInfo
extends AbstractSubjectInfo

A domain object representing a subscription to streaming FX rates for a currency pair, such as USDJPY.

You do not need to construct instances of this class yourself. They are generated from incoming requests by the FXSubjectParser and passed to your implementation of CachedDataProvider.onRequest(SubjectInfo)}.

Constructor Summary

Constructors

Constructor and Description
FXSubjectInfo(String subject, String baseCurrency, String termCurrency, String dealtCurrency, String tenor, String amount, String marginBand) Creates an instance of FXSubjectInfo with the default subject prefix "FX" and the provided parameters.
FXSubjectInfo(String subject, String subjectPrefix, String baseCurrency, String termCurrency, String dealtCurrency, String tenor, String amount, String marginBand) Creates an instance of FXSubjectInfo with a specified subject prefix and the provided parameters.

Method Summary

Modifier and Type	Method and Description
String	getDealtCurrency() A proxy method that calls the underlying method AbstractSubjectInfo.getAmountIn().
boolean	isBaseDealt() Returns a value indicating whether the dealt currency is the base currency or the term currency.
boolean	isMetal() Returns false.

Methods inherited from class com.caplin.motif.fx.rates.AbstractSubjectInfo

equals, getAmount, getAmountIn, getBaseCurrency, getBrokenDate, getCurrencyPair, getMarginBand, getSubject, getSubjectPrefix, getTenor, getTermCurrency, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FXSubjectInfo

public FXSubjectInfo(String subject,
                     String baseCurrency,
                     String termCurrency,
                     String dealtCurrency,
                     String tenor,
                     String amount,
                     String marginBand)

Creates an instance of FXSubjectInfo with the default subject prefix "FX" and the provided parameters.

Parameters:

subject - The full subject.

baseCurrency - The first currency in the pair. For example, for USDJPY the base currency is USD.

termCurrency - The second currency in the pair. For example, for USDJPY the term currency is JPY.

dealtCurrency - The currency that the amount is specified in. This can be either the base or term currency.

tenor - The tenor for the subscription.

amount - The amount, specified in a quantity of the dealt currency.

marginBand - The margin band or price tier for the subscription.

FXSubjectInfo

public FXSubjectInfo(String subject,
                     String subjectPrefix,
                     String baseCurrency,
                     String termCurrency,
                     String dealtCurrency,
                     String tenor,
                     String amount,
                     String marginBand)

Creates an instance of FXSubjectInfo with a specified subject prefix and the provided parameters.

Calling this constructor is not recommended unless you are aware of all the client-side and configuration modifications required to support changing the expected format for subscription requests.

Parameters:

subject - The full subject.

subjectPrefix - The subject prefix. This will be used instead of the default prefix "FX".

baseCurrency - The first currency in the pair. For example, for USDJPY the base currency is USD.

termCurrency - The second currency in the pair. For example, for USDJPY the term currency is JPY.

dealtCurrency - The currency that the amount is specified in. This can be either the base or term currency.

tenor - The tenor for the subscription.

amount - The amount, specified in a quantity of the dealt currency.

marginBand - The margin band or price tier for the subscription.

Method Detail

isMetal

public boolean isMetal()

Returns false.

Specified by:

isMetal in class AbstractSubjectInfo

Returns:

True if this class represents a metal subscription, otherwise false.

isBaseDealt

public boolean isBaseDealt()

Returns a value indicating whether the dealt currency is the base currency or the term currency. For example:

• If the currency pair is USDJPY and the dealt currency is USD, this method returns true.
• If the currency pair is USDJPY and the dealt currency is JPY, this method returns false.

Returns:

True if the dealt currency is the base currency, false if the dealt currency is the term currency.

getDealtCurrency

public String getDealtCurrency()

A proxy method that calls the underlying method AbstractSubjectInfo.getAmountIn().

Returns:

The currency that the amount is specified in.