Package com.caplin.motif.fx.rates

Class RateSubjectInfo

java.lang.Object

com.caplin.motif.fx.rates.RateSubjectInfo

All Implemented Interfaces:

SubjectInfo

public class RateSubjectInfo
extends Object
implements SubjectInfo

Constructor Summary

Constructors

Constructor	Description
RateSubjectInfo(String subject, String currencyPair, String tenor, String amountQualifier, String amount, String marginBand)	Constructs an RateSubjectInfo based on the provided subscription parameters.
RateSubjectInfo(String subject, String currencyPair, String tenor, String amountQualifier, String amount, String marginBand, String parameters)	Constructs an RateSubjectInfo based on the provided subscription parameters.

Method Summary

Modifier and Type	Method	Description
LocalDate	_getFixingDate()
boolean	equals(Object o)
String	getAmount()	Returns the amount for the subscription, specified as a quantity of the unit returned by getAmountQualifier().
String	getAmountQualifier()	Returns the qualifier for the amount (e.g.
String	getBaseCurrency()	Returns the memoized base currency for the subscription.
String	getBrokenDate()	The settlement date, if the request is for a broken date.
String	getCurrencyPair()	Returns the currency pair for the subscription.
LocalDate	getFixingDate()
String	getMarginBand()	Returns the margin band for the subscription.
Map<String,String>	getParameters()
String	getSubject()	Returns the original subject that was parsed to create this SubjectInfo
String	getTenor()	Returns the tenor for the subscription.
String	getTermCurrency()	Returns the memoized term currency for the subscription.
int	hashCode()
boolean	isBrokenDate()	Whether the request is for a broken date.
boolean	isCoverTrade()
boolean	isNonDeliverable()
boolean	isOrder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RateSubjectInfo

public RateSubjectInfo(String subject,
                       String currencyPair,
                       String tenor,
                       String amountQualifier,
                       String amount,
                       String marginBand)

Constructs an RateSubjectInfo based on the provided subscription parameters.

Parameters:

subject - The full requested subject

currencyPair - The requested currency pair.

tenor - The tenor for the subscription.

amountQualifier - The qualifier for the amount, such as Dealt Currency or Unit.

amount - The amount for the subscription. Useful for volume banding.

marginBand - The margin band for the subscription. Sometimes referred to as the price tier.

RateSubjectInfo

public RateSubjectInfo(String subject,
                       String currencyPair,
                       String tenor,
                       String amountQualifier,
                       String amount,
                       String marginBand,
                       String parameters)

Constructs an RateSubjectInfo based on the provided subscription parameters.

Parameters:

subject - The full requested subject

currencyPair - The requested currency pair.

tenor - The tenor for the subscription.

amountQualifier - The qualifier for the amount, such as Dealt Currency or Unit.

amount - The amount for the subscription. Useful for volume banding.

marginBand - The margin band for the subscription. Sometimes referred to as the price tier.

parameters - Additional pricing parameters

Method Detail

getCurrencyPair

public String getCurrencyPair()

Returns the currency pair for the subscription.

Returns:

The currency pair in the format <base currency><term currency>. For example, if the base currency is "GBP" and the term currency is "USD" this method will return the string "GBPUSD".

getBaseCurrency

public String getBaseCurrency()

Returns the memoized base currency for the subscription.

Returns:

The base currency for the subscription, which is the first currency in the pair.

getTermCurrency

public String getTermCurrency()

Returns the memoized term currency for the subscription.

Returns:

The term currency for the subscription, which is the second currency in the pair.

getTenor

public String getTenor()

Returns the tenor for the subscription.

Returns:

The tenor.

getBrokenDate

public String getBrokenDate()

The settlement date, if the request is for a broken date. Returns null otherwise.

Returns:

The settlement date, if request was for a broken date.

isBrokenDate

public boolean isBrokenDate()

Whether the request is for a broken date.

Returns:

true if the request is for a broken date, false otherwise

getAmountQualifier

public String getAmountQualifier()

Returns the qualifier for the amount (e.g. Dealt Currency or Unit)

Returns:

The amount qualifier for the subscription (e.g. Dealt Currency or Unit).

getAmount

public String getAmount()

Returns the amount for the subscription, specified as a quantity of the unit returned by getAmountQualifier(). Generally used for determining which volume-banded price the subscription should be provided with.

Returns:

The amount for the subscription.

getMarginBand

public String getMarginBand()

Returns the margin band for the subscription. Sometimes referred to as the price tier. This is usually mapped on to the request by Liberator using the permissioning system rather than specified by the client, because clients are usually not in control of (or aware of) which price tier they have been assigned to.

Returns:

The margin band.

getSubject

public String getSubject()

Description copied from interface: SubjectInfo

Returns the original subject that was parsed to create this SubjectInfo

Specified by:

getSubject in interface SubjectInfo

Returns:

The original subject.

getParameters

public Map<String,String> getParameters()

isNonDeliverable

public boolean isNonDeliverable()

isCoverTrade

public boolean isCoverTrade()

getFixingDate

public LocalDate getFixingDate()

_getFixingDate

public LocalDate _getFixingDate()

isOrder

public boolean isOrder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object