Caplin Systems - ESPQuote (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.rates.ESPQuote<T>

Type Parameters:
T - A class that extends, AbstractSubjectInfo which encapsulates the parameters of the client's subscription.

All Implemented Interfaces:

FXQuote
```
public class ESPQuote<T extends AbstractSubjectInfo>
extends Object
implements FXQuote
```
An ESPQuote contains all values required for sending Executable Streaming Prices.

Constructor Summary

Constructors
Constructor and Description

ESPQuote(T info, FXQuote quote, String gfa)
Constructs the ESPQuote for the given subject info, quote and gfa.

Constructors
Constructor and Description
`ESPQuote(T info, FXQuote quote, String gfa)` Constructs the ESPQuote for the given subject info, quote and gfa.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAllInAskRate()` Returns the all in ask rate.
`String`	`getAllInBidRate()` Returns the all in bid rate.
`String`	`getAskPips()` Returns the ask pips.
`String`	`getAskPoints()` Returns the ask points.
`String`	`getAskQuoteId()` Returns the AskQuoteID
`String`	`getBidPips()` Returns the bid pips.
`String`	`getBidPoints()` Returns the bid points.
`String`	`getBidQuoteId()` Returns the Bid Quote ID
`String`	`getFwdAskPips()` Deprecated. use `getAskPips()` instead.
`String`	`getFwdAskPoints()` Deprecated. use `getAskPoints()` instead.
`String`	`getFwdBidPips()` Deprecated. use `getBidPips()` instead
`String`	`getFwdBidPoints()` Deprecated. use `getBidPoints()` instead
`String`	`getGFA()` Returns the "Good For Amount".
`String`	`getNumberOfDigitsBeforeDecimalPoint()` Returns the "number of digits before the decimal point".
`String`	`getNumberOfDigitsBeforePips()` Returns the "number of digits before the pips", this is a Precision-related field that tells the client how to display rates.
`String`	`getNumberOfFractionalPips()` Returns the "number of fractional pips", this is a Precision-related field that tells the client how to display rates.
`String`	`getNumberOfPips()` Returns the "number of pips", this is a Precision-related field that tells the client how to display rates.
`Map<String,String>`	`getQuoteFields()` Returns the fields that will be sent to the client for a Quote.
`String`	`getQuoteId()` The ID of this quote.
`String`	`getSpotAskRate()` Returns the spot ask rate.
`String`	`getSpotBidRate()` Returns the spot bid rate.
`String`	`getSubject()` Returns the subject of the original request
`T`	`getSubjectInfo()` Returns the AbstractSubjectInfo
`String`	`getSwapAskPips()` Deprecated. use `getAskPips()` instead.
`String`	`getSwapBidPips()` Deprecated. use `getBidPips()` instead.
`String`	`getSwapGFA()` Returns the "Good For Amount" for Forward and Swap quotes.
`String`	`getTimePriceReceived()` Returns the time of when the price was recieved.
`int`	`hashCode()`
`void`	`setAllInAskRate(String allInAskRate)` Sets the all in ask rate.
`void`	`setAllInBidRate(String allInBidRate)` Sets the all in bid rate.
`void`	`setAskPips(String askPips)` Sets the ask pips.
`void`	`setAskPoints(String askPoints)` Sets the ask points.
`void`	`setAskQuoteId(String askQuoteId)` Set the AskQuoteID
`void`	`setBidPips(String bidPips)` Sets the bid pips.
`void`	`setBidPoints(String bidPoints)` Sets the bid points.
`void`	`setBidQuoteId(String bidQuoteId)` sets the BidQuoteID
`void`	`setFwdAskPips(String fwdAskPips)` Deprecated. use `setAskPips(String)` instead.
`void`	`setFwdAskPoints(String fwdAskPoints)` Deprecated. use `setAskPoints(String)` instead.
`void`	`setFwdBidPips(String fwdBidPips)` Deprecated. use `setBidPips(String)` instead.
`void`	`setFwdBidPoints(String fwdBidPoints)` Deprecated. `setBidPoints(String)`
`void`	`setGFA(String gfa)` Sets the "Good For Amount".
`void`	`setNumberOfDigitsBeforeDecimalPoint(String numberOfDigitsBeforeDecimalPoint)` Sets the "number of digits before the decimal point", this is a Precision-related field that tells the client how to display rates.
`void`	`setNumberOfDigitsBeforePips(String numberOfDigitsBeforePips)` Sets the "number of digits before the pips", this is a Precision-related field that tells the client how to display rates.
`void`	`setNumberOfFractionalPips(String numberOfFractionalPips)` Sets the "number of fractional pips", this is a Precision-related field that tells the client how to display rates.
`void`	`setNumberOfPips(String numberOfPips)` Sets the "number of pips", this is a Precision-related field that tells the client how to display rates.
`void`	`setQuoteId(String quoteId)` Sets the ID of this quote
`void`	`setSpotAskRate(String spotAskRate)` Sets the spot ask rate.
`void`	`setSpotBidRate(String spotBidRate)` Sets the spot bid rate.
`void`	`setSwapAskPips(String fwdAskPips)` Deprecated. use `setAskPips(String)` instead.
`void`	`setSwapBidPips(String swapBidPips)` Deprecated. use `setBidPips(String)` instead.
`void`	`setSwapGFA(String swapGFA)` Sets the "Good for Amount" for Forward and Swap quotes.
`void`	`setTimePriceReceived(String timePriceReceived)` Sets the time the price was the received.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ESPQuote
```
public ESPQuote(T info,
        FXQuote quote,
        String gfa)
```
    Constructs the ESPQuote for the given subject info, quote and gfa.
    
    Parameters:
    info - The SubjectInfo containing the client request information.s
    quote - The quote containing some combination of a bid, ask and mid rate.
    gfa - The 'Good For Amount' denoting the maximum amount that can be traded as an ESP.
- Method Detail
  - getQuoteId
```
public String getQuoteId()
```
    The ID of this quote.
    
    Returns:
    The ID of this quote.
  - setQuoteId
```
public void setQuoteId(String quoteId)
```
    Sets the ID of this quote
    
    Parameters:
    quoteId - the ID of the quote
  - getSubjectInfo
```
public T getSubjectInfo()
```
    Returns the AbstractSubjectInfo
    
    Returns:
    The AbstractSubjectInfo
  - getSubject
```
public String getSubject()
```
    Returns the subject of the original request
    
    Returns:
    The subject of the original request
  - getQuoteFields
```
public Map<String,String> getQuoteFields()
```
    Description copied from interface: FXQuote
    
    Returns the fields that will be sent to the client for a Quote.
    
    Specified by:
    
    getQuoteFields in interface FXQuote
    
    Returns:
    The quote fields.
  - getBidQuoteId
```
public String getBidQuoteId()
```
    Returns the Bid Quote ID
    
    Returns:
    The quote ID.
  - setBidQuoteId
```
public void setBidQuoteId(String bidQuoteId)
```
    sets the BidQuoteID
    
    Parameters:
    bidQuoteId - The bid quote ID.
  - getAskQuoteId
```
public String getAskQuoteId()
```
    Returns the AskQuoteID
    
    Returns:
    The quote ID.
  - setAskQuoteId
```
public void setAskQuoteId(String askQuoteId)
```
    Set the AskQuoteID
    
    Parameters:
    askQuoteId - The ask quote ID.
  - getSpotBidRate
```
public String getSpotBidRate()
```
    Returns the spot bid rate.
    
    Returns:
    The spot bid rate.
  - setSpotBidRate
```
public void setSpotBidRate(String spotBidRate)
```
    Sets the spot bid rate.
    
    Parameters:
    spotBidRate - The spot bid rate.
  - getSpotAskRate
```
public String getSpotAskRate()
```
    Returns the spot ask rate.
    
    Returns:
    The spot ask rate.
  - setSpotAskRate
```
public void setSpotAskRate(String spotAskRate)
```
    Sets the spot ask rate.
    
    Parameters:
    spotAskRate - The spot ask rate.
  - getAllInBidRate
```
public String getAllInBidRate()
```
    Returns the all in bid rate.
    
    Returns:
    The all in bid rate.
  - setAllInBidRate
```
public void setAllInBidRate(String allInBidRate)
```
    Sets the all in bid rate.
    
    Parameters:
    allInBidRate - The all in bid rate.
  - getAllInAskRate
```
public String getAllInAskRate()
```
    Returns the all in ask rate.
    
    Returns:
    The all in ask rate.
  - setAllInAskRate
```
public void setAllInAskRate(String allInAskRate)
```
    Sets the all in ask rate.
    
    Parameters:
    allInAskRate - The all in ask rate.
  - getFwdBidPips
```
@Deprecated
public String getFwdBidPips()
```
    Deprecated. use getBidPips() instead
    
    Returns:
    The Bid Pips
  - getBidPips
```
public String getBidPips()
```
    Returns the bid pips.
    
    Returns:
    The bid pips.
  - setFwdBidPips
```
@Deprecated
public void setFwdBidPips(String fwdBidPips)
```
    Deprecated. use setBidPips(String) instead.
    
    Parameters:
    fwdBidPips - The forward bid pips
  - setBidPips
```
public void setBidPips(String bidPips)
```
    Sets the bid pips.
    
    Parameters:
    bidPips - The bid pips.
  - getFwdAskPips
```
@Deprecated
public String getFwdAskPips()
```
    Deprecated. use getAskPips() instead.
    
    Returns:
    The ask pips.
  - getAskPips
```
public String getAskPips()
```
    Returns the ask pips.
    
    Returns:
    The ask pips.
  - setFwdAskPips
```
@Deprecated
public void setFwdAskPips(String fwdAskPips)
```
    Deprecated. use setAskPips(String) instead.
    
    Parameters:
    fwdAskPips - The ask pips.
  - setAskPips
```
public void setAskPips(String askPips)
```
    Sets the ask pips.
    
    Parameters:
    askPips - The ask pips.
  - getFwdBidPoints
```
@Deprecated
public String getFwdBidPoints()
```
    Deprecated. use getBidPoints() instead
    
    Returns:
    the bid points
  - getBidPoints
```
public String getBidPoints()
```
    Returns the bid points.
    
    Returns:
    The bid points.
  - setFwdBidPoints
```
@Deprecated
public void setFwdBidPoints(String fwdBidPoints)
```
    Deprecated. setBidPoints(String)
    
    Parameters:
    fwdBidPoints - The bid points.
  - setBidPoints
```
public void setBidPoints(String bidPoints)
```
    Sets the bid points.
    
    Parameters:
    bidPoints - The bid points.
  - getFwdAskPoints
```
@Deprecated
public String getFwdAskPoints()
```
    Deprecated. use getAskPoints() instead.
    
    Returns:
    The ask points.
  - getAskPoints
```
public String getAskPoints()
```
    Returns the ask points.
    
    Returns:
    The ask points.
  - setFwdAskPoints
```
@Deprecated
public void setFwdAskPoints(String fwdAskPoints)
```
    Deprecated. use setAskPoints(String) instead.
    
    Parameters:
    fwdAskPoints - The ask points.
  - setAskPoints
```
public void setAskPoints(String askPoints)
```
    Sets the ask points.
    
    Parameters:
    askPoints - The ask points.
  - getSwapBidPips
```
@Deprecated
public String getSwapBidPips()
```
    Deprecated. use getBidPips() instead.
    
    Returns:
    The bid pips.
  - setSwapBidPips
```
@Deprecated
public void setSwapBidPips(String swapBidPips)
```
    Deprecated. use setBidPips(String) instead.
    
    Parameters:
    swapBidPips - The ask pips.
  - getSwapAskPips
```
@Deprecated
public String getSwapAskPips()
```
    Deprecated. use getAskPips() instead.
    
    Returns:
    The ask pips.
  - setSwapAskPips
```
@Deprecated
public void setSwapAskPips(String fwdAskPips)
```
    Deprecated. use setAskPips(String) instead.
    
    Parameters:
    fwdAskPips - The ask pips.
  - getNumberOfDigitsBeforeDecimalPoint
```
public String getNumberOfDigitsBeforeDecimalPoint()
```
    Returns the "number of digits before the decimal point". this is a Precision-related field that tells the client how to display rates.
    
    This is the maximum number of digits that can appear to the left of the decimal point, not the current number of digits left of the point for the current update. For example, EURJPY hovers around the 99.000 mark and can go over 100, so EURJPY rates will sometimes have 2 digits left of the point and sometimes 3. But the value of this DigitsBeforePoints field should always be 3.
    
    Returns:
    The Number of digits before the decimal point.
  - setNumberOfDigitsBeforeDecimalPoint
```
public void setNumberOfDigitsBeforeDecimalPoint(String numberOfDigitsBeforeDecimalPoint)
```
    Sets the "number of digits before the decimal point", this is a Precision-related field that tells the client how to display rates.
    
    This is the maximum number of digits that can appear to the left of the decimal point, not the current number of digits left of the point for the current update. For example, EURJPY hovers around the 99.000 mark and can go over 100, so EURJPY rates will sometimes have 2 digits left of the point and sometimes 3. But the value of this DigitsBeforePoints field should always be 3.
    
    Parameters:
    numberOfDigitsBeforeDecimalPoint - The number of digits before the decimal point that the client should display
  - getNumberOfDigitsBeforePips
```
public String getNumberOfDigitsBeforePips()
```
    Returns the "number of digits before the pips", this is a Precision-related field that tells the client how to display rates.
    
    This is the number of digits between the decimal point and the pips (i.e the "big digits" that the client wants to look at). For most currency pairs the value of this field will be 2, for example for a GBPUSD rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
    
    Returns:
    The number if digits that exist before the pips
  - setNumberOfDigitsBeforePips
```
public void setNumberOfDigitsBeforePips(String numberOfDigitsBeforePips)
```
    Sets the "number of digits before the pips", this is a Precision-related field that tells the client how to display rates.
    
    This is the number of digits between the decimal point and the pips (i.e the "big digits" that the client wants to look at). For most currency pairs the value of this field will be 2, for example for a GBPUSD rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.
    
    Parameters:
    numberOfDigitsBeforePips - The number of digits that exist before the pips.
  - getNumberOfPips
```
public String getNumberOfPips()
```
    Returns the "number of pips", this is a Precision-related field that tells the client how to display rates.
    
    This is the number of pips the client wants to look at. Normally this value is always 2.
    
    Returns:
    The number of pips
  - setNumberOfPips
```
public void setNumberOfPips(String numberOfPips)
```
    Sets the "number of pips", this is a Precision-related field that tells the client how to display rates.
    
    This is the number of pips the client wants to look at. Normally this value is always 2.
    
    Parameters:
    numberOfPips - The number of pips
  - getNumberOfFractionalPips
```
public String getNumberOfFractionalPips()
```
    Returns the "number of fractional pips", this is a Precision-related field that tells the client how to display rates. This is the number of digits after the pips.
    
    For example for a GBPUSD rate of 1.23456 the pips are the 45 and there is one digit (the 6) after the pips, so the value of the NumberOfFractionalPips field should be 1.
    
    There are typically more fractional pips on forward rates than spot rates.
    
    Returns:
    The number of fractional pips.
  - setNumberOfFractionalPips
```
public void setNumberOfFractionalPips(String numberOfFractionalPips)
```
    Sets the "number of fractional pips", this is a Precision-related field that tells the client how to display rates. This is the number of digits after the pips.
    
    For example for a GBPUSD rate of 1.23456 the pips are the 45 and there is one digit (the 6) after the pips, so the value of the NumberOfFractionalPips field should be 1.
    
    There are typically more fractional pips on forward rates than spot rates.
    
    Parameters:
    numberOfFractionalPips - The number of fractional pips.
  - getGFA
```
public String getGFA()
```
    Returns the "Good For Amount".
    
    Returns:
    The Good For Amount.
  - setGFA
```
public void setGFA(String gfa)
```
    Sets the "Good For Amount".
    
    Parameters:
    gfa - The Good For Amount.
  - getSwapGFA
```
public String getSwapGFA()
```
    Returns the "Good For Amount" for Forward and Swap quotes.
    
    Returns:
    The "Good For Amount" for Forward and Swap quotes.
  - setSwapGFA
```
public void setSwapGFA(String swapGFA)
```
    Sets the "Good for Amount" for Forward and Swap quotes.
    
    Parameters:
    swapGFA - The "Good For Amount" for Forward and Swap quotes.
  - getTimePriceReceived
```
public String getTimePriceReceived()
```
    Returns the time of when the price was recieved.
    
    Returns:
    The time the price was received.
  - setTimePriceReceived
```
public void setTimePriceReceived(String timePriceReceived)
```
    Sets the time the price was the received.
    
    Parameters:
    timePriceReceived - The time the price was received.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class ESPQuote<T extends AbstractSubjectInfo>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ESPQuote

Method Detail

getQuoteId

setQuoteId

getSubjectInfo

getSubject

getQuoteFields

getBidQuoteId

setBidQuoteId

getAskQuoteId

setAskQuoteId

getSpotBidRate

setSpotBidRate

getSpotAskRate

setSpotAskRate

getAllInBidRate

setAllInBidRate

getAllInAskRate

setAllInAskRate

getFwdBidPips

getBidPips

setFwdBidPips

setBidPips

getFwdAskPips

getAskPips

setFwdAskPips

setAskPips

getFwdBidPoints

getBidPoints

setFwdBidPoints

setBidPoints

getFwdAskPoints

getAskPoints

setFwdAskPoints

setAskPoints

getSwapBidPips

setSwapBidPips

getSwapAskPips

setSwapAskPips

getNumberOfDigitsBeforeDecimalPoint

setNumberOfDigitsBeforeDecimalPoint

getNumberOfDigitsBeforePips

setNumberOfDigitsBeforePips

getNumberOfPips

setNumberOfPips

getNumberOfFractionalPips

setNumberOfFractionalPips

getGFA

setGFA

getSwapGFA

setSwapGFA

getTimePriceReceived

setTimePriceReceived

hashCode

equals