CapitalIndexedBondSecurity (OpenGamma Strata Product)

java.lang.Object
- com.opengamma.strata.product.bond.CapitalIndexedBondSecurity

All Implemented Interfaces:

LegalEntitySecurity, Security, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean
```
public final class CapitalIndexedBondSecurity
extends Object
implements LegalEntitySecurity, org.joda.beans.ImmutableBean, Serializable
```
A security representing a capital indexed bond.
A capital indexed bond is a financial instrument that represents a stream of inflation-adjusted payments.
Price
Strata uses decimal prices for bonds in the trade model, pricers and market data. For example, a price of 99.32% is represented in Strata by 0.9932.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CapitalIndexedBondSecurity.Builder` The bean-builder for `CapitalIndexedBondSecurity`.
`static class`	`CapitalIndexedBondSecurity.Meta` The meta-bean for `CapitalIndexedBondSecurity`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CapitalIndexedBondSecurity.Builder`	`builder()` Returns a builder used to create an instance of the bean.
`CapitalIndexedBondPosition`	`createPosition(PositionInfo positionInfo, double longQuantity, double shortQuantity, ReferenceData refData)` Creates a position based on this security from a long and short quantity.
`CapitalIndexedBondPosition`	`createPosition(PositionInfo positionInfo, double quantity, ReferenceData refData)` Creates a position based on this security from a net quantity.
`CapitalIndexedBond`	`createProduct(ReferenceData refData)` Creates the product associated with this security.
`CapitalIndexedBondTrade`	`createTrade(TradeInfo info, double quantity, double tradePrice, ReferenceData refData)` Creates a trade based on this security.
`boolean`	`equals(Object obj)`
`PeriodicSchedule`	`getAccrualSchedule()` Gets the accrual schedule.
`Currency`	`getCurrency()` Gets the currency that the bond is traded in.
`DayCount`	`getDayCount()` Gets the day count convention applicable.
`DaysAdjustment`	`getExCouponPeriod()` Gets ex-coupon period.
`double`	`getFirstIndexValue()` Gets the first index value
`SecurityInfo`	`getInfo()` Gets the standard security information.
`LegalEntityId`	`getLegalEntityId()` Gets the legal entity identifier.
`double`	`getNotional()` Gets the notional amount, must be positive.
`InflationRateCalculation`	`getRateCalculation()` Gets the inflation rate calculation.
`DaysAdjustment`	`getSettlementDateOffset()` Gets the number of days between valuation date and settlement date.
`ImmutableSet<SecurityId>`	`getUnderlyingIds()` Gets the set of underlying security identifiers.
`CapitalIndexedBondYieldConvention`	`getYieldConvention()` Gets yield convention.
`int`	`hashCode()`
`static CapitalIndexedBondSecurity.Meta`	`meta()` The meta-bean for `CapitalIndexedBondSecurity`.
`CapitalIndexedBondSecurity.Meta`	`metaBean()`
`CapitalIndexedBondSecurity.Builder`	`toBuilder()` Returns a builder that allows this bean to be mutated.
`String`	`toString()`
`CapitalIndexedBondSecurity`	`withInfo(SecurityInfo info)` Returns an instance with the specified info.

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

Methods inherited from interface com.opengamma.strata.product.Security
getSecurityId

Methods inherited from interface org.joda.beans.Bean
property, propertyNames

- Method Detail
  - getFirstIndexValue
```
public double getFirstIndexValue()
```
    Gets the first index value
    This is the price index value at the start of the bond.
    
    Returns:
    
    the first index value
  - getUnderlyingIds
```
public ImmutableSet<SecurityId> getUnderlyingIds()
```
    Description copied from interface: Security
    
    Gets the set of underlying security identifiers.
    The set must contain all the security identifiers that this security directly refers to. For example, a bond future will return the identifiers of the underlying basket of bonds, but a bond future option will only return the identifier of the underlying future, not the basket.
    
    Specified by:
    
    getUnderlyingIds in interface Security
    
    Returns:
    
    the underlying security identifiers
  - withInfo
```
public CapitalIndexedBondSecurity withInfo(SecurityInfo info)
```
    Description copied from interface: Security
    
    Returns an instance with the specified info.
    
    Specified by:
    
    withInfo in interface LegalEntitySecurity
    
    Specified by:
    
    withInfo in interface Security
    
    Parameters:
    
    info - the new info
    
    Returns:
    
    the instance with the specified info
  - createProduct
```
public CapitalIndexedBond createProduct(ReferenceData refData)
```
    Description copied from interface: Security
    
    Creates the product associated with this security.
    The product of a security is distinct from the security. The product includes the financial details from this security, but excludes the additional information. The product also includes the products of any underlying securities.
    
    Specified by:
    
    createProduct in interface Security
    
    Parameters:
    
    refData - the reference data used to find underlying securities
    
    Returns:
    
    the product
  - createTrade
```
public CapitalIndexedBondTrade createTrade(TradeInfo info,
                                           double quantity,
                                           double tradePrice,
                                           ReferenceData refData)
```
    Description copied from interface: Security
    
    Creates a trade based on this security.
    This creates a trade of a suitable type for this security.
    
    Specified by:
    
    createTrade in interface Security
    
    Parameters:
    
    info - the trade information
    
    quantity - the number of contracts in the trade
    
    tradePrice - the price agreed when the trade occurred
    
    refData - the reference data used to find underlying securities
    
    Returns:
    
    the trade
  - createPosition
```
public CapitalIndexedBondPosition createPosition(PositionInfo positionInfo,
                                                 double quantity,
                                                 ReferenceData refData)
```
    Description copied from interface: Security
    
    Creates a position based on this security from a net quantity.
    This creates a position of a suitable type for this security.
    
    Specified by:
    
    createPosition in interface Security
    
    Parameters:
    
    positionInfo - the position information
    
    quantity - the number of contracts in the position
    
    refData - the reference data used to find underlying securities
    
    Returns:
    
    the position
  - createPosition
```
public CapitalIndexedBondPosition createPosition(PositionInfo positionInfo,
                                                 double longQuantity,
                                                 double shortQuantity,
                                                 ReferenceData refData)
```
    Description copied from interface: Security
    
    Creates a position based on this security from a long and short quantity.
    This creates a position of a suitable type for this security.
    The long quantity and short quantity must be zero or positive, not negative.
    
    Specified by:
    
    createPosition in interface Security
    
    Parameters:
    
    positionInfo - the position information
    
    longQuantity - the long quantity in the position
    
    shortQuantity - the short quantity in the position
    
    refData - the reference data used to find underlying securities
    
    Returns:
    
    the position
  - meta
```
public static CapitalIndexedBondSecurity.Meta meta()
```
    The meta-bean for CapitalIndexedBondSecurity.
    
    Returns:
    
    the meta-bean, not null
  - builder
```
public static CapitalIndexedBondSecurity.Builder builder()
```
    Returns a builder used to create an instance of the bean.
    
    Returns:
    
    the builder, not null
  - metaBean
```
public CapitalIndexedBondSecurity.Meta metaBean()
```
    Specified by:
    
    metaBean in interface org.joda.beans.Bean
  - getInfo
```
public SecurityInfo getInfo()
```
    Gets the standard security information.
    This includes the security identifier.
    
    Specified by:
    
    getInfo in interface Security
    
    Returns:
    
    the value of the property, not null
  - getCurrency
```
public Currency getCurrency()
```
    Gets the currency that the bond is traded in.
    
    Specified by:
    
    getCurrency in interface Security
    
    Returns:
    
    the value of the property, not null
  - getNotional
```
public double getNotional()
```
    Gets the notional amount, must be positive.
    The notional expressed here must be positive. The currency of the notional is specified by currency.
    
    Returns:
    
    the value of the property
  - getAccrualSchedule
```
public PeriodicSchedule getAccrualSchedule()
```
    Gets the accrual schedule.
    This is used to define the accrual periods. These are used directly or indirectly to determine other dates in the product.
    
    Returns:
    
    the value of the property, not null
  - getRateCalculation
```
public InflationRateCalculation getRateCalculation()
```
    Gets the inflation rate calculation.
    The reference index is interpolated index or monthly index. Real coupons are represented by gearing in the calculation. The price index value at the start of the bond is represented by firstIndexValue in the calculation.
    
    Returns:
    
    the value of the property, not null
  - getDayCount
```
public DayCount getDayCount()
```
    Gets the day count convention applicable.
    The conversion from dates to a numerical value is made based on this day count. For the inflation-indexed bond, the day count convention is used to compute accrued interest.
    Note that the year fraction of a coupon payment is computed based on the unadjusted dates in the schedule.
    
    Returns:
    
    the value of the property, not null
  - getYieldConvention
```
public CapitalIndexedBondYieldConvention getYieldConvention()
```
    Gets yield convention.
    The convention defines how to convert from yield to price and inversely.
    
    Returns:
    
    the value of the property, not null
  - getLegalEntityId
```
public LegalEntityId getLegalEntityId()
```
    Gets the legal entity identifier.
    This identifier is used for the legal entity that issues the bond.
    
    Specified by:
    
    getLegalEntityId in interface LegalEntitySecurity
    
    Returns:
    
    the value of the property, not null
  - getSettlementDateOffset
```
public DaysAdjustment getSettlementDateOffset()
```
    Gets the number of days between valuation date and settlement date.
    This is used to compute clean price. The clean price is the relative price to be paid at the standard settlement date in exchange for the bond.
    
    Returns:
    
    the value of the property, not null
  - getExCouponPeriod
```
public DaysAdjustment getExCouponPeriod()
```
    Gets ex-coupon period.
    Some bonds trade ex-coupons before the coupon payment. The coupon is paid not to the owner of the bond on the payment date but to the owner of the bond on the detachment date. The difference between the two is the ex-coupon period (measured in days).
    Because the detachment date is not after the coupon date, the number of days stored in this field should be zero or negative.
    
    Returns:
    
    the value of the property, not null
  - toBuilder
```
public CapitalIndexedBondSecurity.Builder toBuilder()
```
    Returns a builder that allows this bean to be mutated.
    
    Returns:
    
    the mutable builder, not null
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Copyright 2009-Present by OpenGamma Inc. and individual contributors
Apache v2 licensed
Additional documentation can be found at strata.opengamma.io.

Class CapitalIndexedBondSecurity

Price

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.opengamma.strata.product.Security

Methods inherited from interface org.joda.beans.Bean

Method Detail

getFirstIndexValue

getUnderlyingIds

withInfo

createProduct

createTrade

createPosition

createPosition

meta

builder

metaBean

getInfo

getCurrency

getNotional

getAccrualSchedule

getRateCalculation

getDayCount

getYieldConvention

getLegalEntityId

getSettlementDateOffset

getExCouponPeriod

toBuilder

equals

hashCode

toString