Package com.caplin.motif.mm.rates

Class RateSubjectInfo

  • All Implemented Interfaces:
    SubjectInfo
    @Beta
public class RateSubjectInfo
extends java.lang.Object
implements SubjectInfo
    BETA - May change significantly.

    • Constructor Summary

      Constructors 
      Constructor Description
      RateSubjectInfo​(java.lang.String subject, java.lang.String currency, java.lang.String tenor, java.lang.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​(java.lang.Object o)  
      java.lang.String getBrokenDate()
      The settlement date, if the request is for a broken date.
      java.lang.String getCurrency()
      Returns the currency pair for the subscription.
      java.lang.String getMarginBand()
      Returns the margin band for the subscription.
      java.lang.String getSubject()
      Returns the original subject that was parsed to create this SubjectInfo
      java.lang.String getTenor()
      Returns the tenor for the subscription.
      int hashCode()  
      boolean isBrokenDate()
      Whether the request is for a broken date.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RateSubjectInfo

        public RateSubjectInfo​(java.lang.String subject,
                       java.lang.String currency,
                       java.lang.String tenor,
                       java.lang.String marginBand)
        Constructs an RateSubjectInfo based on the provided subscription parameters.
        Parameters:
        subject - The full requested subject
        currency - 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 java.lang.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 java.lang.String getTenor()
        Returns the tenor for the subscription.
        Returns:
        The tenor.

      • getBrokenDate

        public java.lang.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 java.lang.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 java.lang.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.

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object