Class: InflationRateSpecification

name: InflationRateSpecification
description: 'A data to:  specify the inflation rate.'
comments:
- 'Rosetta condition: InflationIndex — rateOption -> InflationIndex exists'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: FloatingRateSpecification
slots:
- inflationLag
- indexSource
- mainPublication
- interpolationMethod
- initialIndexLevel
- fallbackBondApplicable
- calculationMethod
- calculationStyle
- finalPrincipalExchangeCalculation
slot_usage:
  interpolationMethod:
    name: interpolationMethod
    description: The method used when calculating the Inflation Index Level from multiple
      points. The most common is Linear.
    required: true
  calculationMethod:
    name: calculationMethod
    description: Indicates how to use the inflation index to calculate the payment
      (e.g. Ratio, Return, Spread). Added for Inflation Asset Swap
    range: InflationCalculationMethodEnum
    required: false

name: InflationRateSpecification
description: 'A data to:  specify the inflation rate.'
comments:
- 'Rosetta condition: InflationIndex — rateOption -> InflationIndex exists'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: FloatingRateSpecification
slot_usage:
  interpolationMethod:
    name: interpolationMethod
    description: The method used when calculating the Inflation Index Level from multiple
      points. The most common is Linear.
    required: true
  calculationMethod:
    name: calculationMethod
    description: Indicates how to use the inflation index to calculate the payment
      (e.g. Ratio, Return, Spread). Added for Inflation Asset Swap
    range: InflationCalculationMethodEnum
    required: false
attributes:
  inflationLag:
    name: inflationLag
    description: An off-setting period from the payment date which determines the
      reference period for which the inflation index is observed.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: Offset
    required: true
  indexSource:
    name: indexSource
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The reference source such as Reuters or Bloomberg. FpML specifies
      indexSource to be of type rateSourcePageScheme, but without specifying actual
      values.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: string
    required: true
  mainPublication:
    name: mainPublication
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: The current main publication source such as relevant web site or
      a government body. FpML specifies mainPublication to be of type mainPublicationSource,
      but without specifying actual values.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: string
    required: true
  interpolationMethod:
    name: interpolationMethod
    description: The method used when calculating the Inflation Index Level from multiple
      points. The most common is Linear.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - MakeWholeAmount
    - InflationRateSpecification
    range: InterpolationMethodEnum
    required: true
  initialIndexLevel:
    name: initialIndexLevel
    description: Initial known index level for the first calculation period.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: decimal
  fallbackBondApplicable:
    name: fallbackBondApplicable
    description: The applicability of a fallback bond as defined in the 2006 ISDA
      Inflation Derivatives Definitions, sections 1.3 and 1.8.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: boolean
    required: true
  calculationMethod:
    name: calculationMethod
    description: Indicates how to use the inflation index to calculate the payment
      (e.g. Ratio, Return, Spread). Added for Inflation Asset Swap
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AveragingCalculationMethod.calculationMethod
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - AveragingCalculationMethod
    - FloatingRateCalculationParameters
    - InflationRateSpecification
    range: InflationCalculationMethodEnum
    required: false
  calculationStyle:
    name: calculationStyle
    description: Indicates the style of how the inflation index calculates the payment
      (e.g. YearOnYear, ZeroCoupon).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: InflationCalculationStyleEnum
  finalPrincipalExchangeCalculation:
    name: finalPrincipalExchangeCalculation
    description: To be specified only for products that embed a redemption payment.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - InflationRateSpecification
    range: FinalPrincipalExchangeCalculationEnum
  initialRate:
    name: initialRate
    description: The initial floating rate reset agreed between the principal parties
      involved in the trade. This is assumed to be the first required reset rate for
      the first regular calculation period. It should only be included when the rate
      is not equal to the rate published on the source implied by the floating rate
      index. An initial rate of 5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateSpecification
    - FloatingRateProcessingParameters
    range: Price
  finalRateRounding:
    name: finalRateRounding
    description: The rounding convention to apply to the final rate used in determination
      of a calculation period amount.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateSpecification
    range: Rounding
  averagingMethod:
    name: averagingMethod
    description: If averaging is applicable, this component specifies whether a weighted
      or unweighted average method of calculation is to be used. The component must
      only be included when averaging applies.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - DeterminationMethodology
    - FloatingRateSpecification
    - AveragingCalculation
    range: AveragingWeightingMethodEnum
  negativeInterestRateTreatment:
    name: negativeInterestRateTreatment
    description: The specification of any provisions for calculating payment obligations
      when a floating rate is negative (either due to a quoted negative floating rate
      or by operation of a spread that is subtracted from the floating rate).
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateSpecification
    range: NegativeInterestRateTreatmentEnum
  floatingRateMultiplierSchedule:
    name: floatingRateMultiplierSchedule
    description: A rate multiplier or multiplier schedule to apply to the floating
      rate. A multiplier schedule is expressed as explicit multipliers and dates.
      In the case of a schedule, the step dates may be subject to adjustment in accordance
      with any adjustments specified in the calculationPeriodDatesAdjustments. The
      multiplier can be a positive or negative decimal. This element should only be
      included if the multiplier is not equal to 1 (one) for the term of the stream.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRate
    - StubFloatingRate
    range: RateSchedule
  rateTreatment:
    name: rateTreatment
    description: The specification of any rate conversion which needs to be applied
      to the observed rate before being used in any calculations. The two common conversions
      are for securities quoted on a bank discount basis which will need to be converted
      to either a Money Market Yield or Bond Equivalent Yield. See the Annex to the
      2000 ISDA Definitions, Section 7.3. Certain General Definitions Relating to
      Floating Rate Options, paragraphs (g) and (h) for definitions of these terms.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRate
    - StubFloatingRate
    range: RateTreatmentEnum
  calculationParameters:
    name: calculationParameters
    description: Support for modular calculated rates, such such as lockout compound
      calculations.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FallbackRateParameters
    - FloatingRate
    range: FloatingRateCalculationParameters
  fallbackRate:
    name: fallbackRate
    description: Definition of any fallback rate that may be applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRate
    range: FallbackRateParameters
  rateOption:
    name: rateOption
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateBase
    range: InterestRateIndex
    any_of:
    - range: FloatingRateIndex
    - range: InflationIndex
  spreadSchedule:
    name: spreadSchedule
    description: The ISDA Spread or a Spread schedule expressed as explicit spreads
      and dates. In the case of a schedule, the step dates may be subject to adjustment
      in accordance with any adjustments specified in calculationPeriodDatesAdjustments.
      The spread is a per annum rate, expressed as a decimal. For purposes of determining
      a calculation period amount, if positive the spread will be added to the floating
      rate and if negative the spread will be subtracted from the floating rate. A
      positive 10 basis point (0.1%) spread would be represented as 0.001.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateBase
    - StubFloatingRate
    range: SpreadSchedule
  capRateSchedule:
    name: capRateSchedule
    description: The cap rate or cap rate schedule, if any, which applies to the floating
      rate. The cap rate (strike) is only required where the floating rate on a swap
      stream is capped at a certain level. A cap rate schedule is expressed as explicit
      cap rates and dates and the step dates may be subject to adjustment in accordance
      with any adjustments specified in calculationPeriodDatesAdjustments. The cap
      rate is assumed to be exclusive of any spread and is a per annum rate, expressed
      as a decimal. A cap rate of 5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateBase
    - StubFloatingRate
    range: StrikeSchedule
  floorRateSchedule:
    name: floorRateSchedule
    description: The floor rate or floor rate schedule, if any, which applies to the
      floating rate. The floor rate (strike) is only required where the floating rate
      on a swap stream is floored at a certain strike level. A floor rate schedule
      is expressed as explicit floor rates and dates and the step dates may be subject
      to adjustment in accordance with any adjustments specified in calculationPeriodDatesAdjustments.
      The floor rate is assumed to be exclusive of any spread and is a per annum rate,
      expressed as a decimal. A floor rate of 5% would be represented as 0.05.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: InflationRateSpecification
    domain_of:
    - FloatingRateBase
    - StubFloatingRate
    range: StrikeSchedule