Package com.caplin.motif.mm.rates
Class RateSubjectInfo
- java.lang.Object
-
- com.caplin.motif.mm.rates.RateSubjectInfo
-
- All Implemented Interfaces:
SubjectInfo
@Beta public class RateSubjectInfo extends Object implements SubjectInfo
BETA - May change significantly.
-
-
Constructor Summary
Constructors Constructor Description RateSubjectInfo(String subject, String currency, String tenor, String marginBand)
Constructs an RateSubjectInfo based on the provided subscription parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
String
getBrokenDate()
The settlement date, if the request is for a broken date.String
getCurrency()
Returns the currency pair for the subscription.String
getMarginBand()
Returns the margin band for the subscription.String
getSubject()
Returns the original subject that was parsed to create this SubjectInfoString
getTenor()
Returns the tenor for the subscription.int
hashCode()
boolean
isBrokenDate()
Whether the request is for a broken date.String
toString()
-
-
-
Constructor Detail
-
RateSubjectInfo
public RateSubjectInfo(String subject, String currency, String tenor, String marginBand)
Constructs an RateSubjectInfo based on the provided subscription parameters.- Parameters:
subject
- The full requested subjectcurrency
- The requested currency pair.tenor
- The tenor for the subscription.marginBand
- The margin band for the subscription. Sometimes referred to as the price tier.
-
-
Method Detail
-
getCurrency
public String getCurrency()
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".
-
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.
-
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.
-
isBrokenDate
public boolean isBrokenDate()
Whether the request is for a broken date.- Returns:
true
if the request is for a broken date,false
otherwise
-
getSubject
public String getSubject()
Description copied from interface:SubjectInfo
Returns the original subject that was parsed to create this SubjectInfo- Specified by:
getSubject
in interfaceSubjectInfo
- Returns:
- The original subject.
-
-