Package org.drip.param.definition

Class ProductQuote

java.lang.Object
org.drip.param.definition.ProductQuote
Direct Known Subclasses:
ProductMultiMeasure
public abstract class ProductQuote
extends java.lang.Object
ProductQuote abstract class holds the different types of quotes for a given product. It contains a single market field/quote pair, but multiple alternate named quotes (to accommodate quotes on different measures for the component).

Author:
Lakshmi Krishnamurthy

  • Constructor Summary

    Constructors
    Constructor Description
    ProductQuote()  

  • Method Summary

    Modifier and Type Method Description
    abstract void addQuote​(java.lang.String strQuoteField, Quote q, boolean bIsMarketQuote)
    Add a regular or a market quote for the component
    abstract boolean containsQuote​(java.lang.String strQuoteField)
    Indicate if the named quote is available
    abstract Quote marketQuote()
    Return the market quote object
    abstract java.lang.String marketQuoteField()
    Retrieve the market quote field
    abstract Quote quote​(java.lang.String strQuoteField)
    Get the Quote for the given Field
    abstract boolean removeMarketQuote()
    Remove the market quote
    abstract boolean removeQuote​(java.lang.String strQuoteField)
    Remove the named Quote
    abstract boolean setMarketQuote​(java.lang.String strMarketQuoteField, Quote q)
    Set the market quote for the component

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ProductQuote

      public ProductQuote()

  • Method Details

    • addQuote

      public abstract void addQuote​(java.lang.String strQuoteField, Quote q, boolean bIsMarketQuote)
      Add a regular or a market quote for the component
      Parameters:
      strQuoteField - The quote field
      q - Quote to be added
      bIsMarketQuote - Whether the quote is a market quote

    • setMarketQuote

      public abstract boolean setMarketQuote​(java.lang.String strMarketQuoteField, Quote q)
      Set the market quote for the component
      Parameters:
      strMarketQuoteField - Market Quote field
      q - Quote
      Returns:
      True if successfully added

    • removeMarketQuote

      public abstract boolean removeMarketQuote()
      Remove the market quote
      Returns:
      TRUE - The Market Quote has been removed

    • quote

      public abstract Quote quote​(java.lang.String strQuoteField)
      Get the Quote for the given Field
      Parameters:
      strQuoteField - Field Name
      Returns:
      Quote object

    • marketQuote

      public abstract Quote marketQuote()
      Return the market quote object
      Returns:
      Quote object

    • marketQuoteField

      public abstract java.lang.String marketQuoteField()
      Retrieve the market quote field
      Returns:
      Field name

    • removeQuote

      public abstract boolean removeQuote​(java.lang.String strQuoteField)
      Remove the named Quote
      Parameters:
      strQuoteField - Named Quote Field
      Returns:
      Success (true) or failure (false)

    • containsQuote

      public abstract boolean containsQuote​(java.lang.String strQuoteField)
      Indicate if the named quote is available
      Parameters:
      strQuoteField - The Quote Name
      Returns:
      TRUE - Named Quote is present