com.lmax.api.orderbook
Interface CommercialInfo


public interface CommercialInfo

Hold information pertaining to the commercial detail of this instrument.


Method Summary
 FixedPointNumber getAggressiveCommissionPerContract()
          Get the aggressive commission per contract, may be null if commission is charged using a rate.
 FixedPointNumber getAggressiveCommissionRate()
          Get the aggressive commission rate, may be null if commission is charged per contract.
 int getDailyInterestRateBasis()
          Get the number of days per year used to calculate the daily interest charged for funding.
 java.lang.String getFundingBaseRate()
          Get the base rate used for funding this instrument.
 FixedPointNumber getFundingPremiumPercentage()
          Get the percentage premium added to the funding base rate for overnight funding of long positions on non-FX instruments.
 FixedPointNumber getFundingRate()
          Deprecated. this method always returns null as the funding rate applied varies in ways that a single rate figure cannot encapsulate.
 FixedPointNumber getFundingReductionPercentage()
          Get the percentage reduction applied to the funding base rate for overnight funding of short positions on non-FX instruments.
 FixedPointNumber getLongSwapPoints()
          Get the swap points used to calculate overnight interest swap charges for long positions on FX instruments.
 FixedPointNumber getMinimumCommission()
          Get the minimum commission applied for a trade on this instrument.
 FixedPointNumber getPassiveCommissionPerContract()
          Get the passive commission per contract, may be null if commission is charged using a rate.
 FixedPointNumber getPassiveCommissionRate()
          Get the passive commission rate, may be null if commission is charged per contract.
 FixedPointNumber getShortSwapPoints()
          Get the swap points used to calculate overnight interest swap charges for short positions on FX instruments.
 

Method Detail

getMinimumCommission

FixedPointNumber getMinimumCommission()
Get the minimum commission applied for a trade on this instrument.

Returns:
minimum commission.

getAggressiveCommissionRate

FixedPointNumber getAggressiveCommissionRate()
Get the aggressive commission rate, may be null if commission is charged per contract. The commission charge when the order is on the aggressive side of the trade.

Returns:
aggressive commission rate.

getPassiveCommissionRate

FixedPointNumber getPassiveCommissionRate()
Get the passive commission rate, may be null if commission is charged per contract. The commission charge when the order is on the passive side of the trade.

Returns:
passive commission rate.

getAggressiveCommissionPerContract

FixedPointNumber getAggressiveCommissionPerContract()
Get the aggressive commission per contract, may be null if commission is charged using a rate. The commission charge when the order is on the aggressive side of the trade.

Returns:
aggressive commission per contract.

getPassiveCommissionPerContract

FixedPointNumber getPassiveCommissionPerContract()
Get the passive commission per contract, may be null if commission is charged using a rate. The commission charge when the order is on the passive side of the trade.

Returns:
passive commission per contract.

getFundingBaseRate

java.lang.String getFundingBaseRate()
Get the base rate used for funding this instrument.

Returns:
funding base rate.

getFundingPremiumPercentage

FixedPointNumber getFundingPremiumPercentage()
Get the percentage premium added to the funding base rate for overnight funding of long positions on non-FX instruments.

Returns:
funding rate premium for long positions
See Also:
getFundingBaseRate()

getFundingReductionPercentage

FixedPointNumber getFundingReductionPercentage()
Get the percentage reduction applied to the funding base rate for overnight funding of short positions on non-FX instruments.

Returns:
funding rate reduction for short positions
See Also:
getFundingBaseRate()

getDailyInterestRateBasis

int getDailyInterestRateBasis()
Get the number of days per year used to calculate the daily interest charged for funding.

Returns:
interest rate day basis.

getLongSwapPoints

FixedPointNumber getLongSwapPoints()
Get the swap points used to calculate overnight interest swap charges for long positions on FX instruments.

Returns:
swap points for long positions

getShortSwapPoints

FixedPointNumber getShortSwapPoints()
Get the swap points used to calculate overnight interest swap charges for short positions on FX instruments.

Returns:
swap points for short positions

getFundingRate

@Deprecated
FixedPointNumber getFundingRate()
Deprecated. this method always returns null as the funding rate applied varies in ways that a single rate figure cannot encapsulate.

Get the rate used for overnight funding.

Returns:
funding rate.
See Also:
getFundingBaseRate(), getFundingPremiumPercentage(), getFundingReductionPercentage()