Class: IndexTransitionInstruction

Defines the information needed to create a Index Transition Business Event.

URI: common_domain_model:IndexTransitionInstruction

 classDiagram
    class IndexTransitionInstruction
    click IndexTransitionInstruction href "../IndexTransitionInstruction/"
      IndexTransitionInstruction : cashTransfer





        IndexTransitionInstruction --> "0..1" Transfer : cashTransfer
        click Transfer href "../Transfer/"



      IndexTransitionInstruction : effectiveDate

      IndexTransitionInstruction : priceQuantity





        IndexTransitionInstruction --> "1..*" PriceQuantity : priceQuantity
        click PriceQuantity href "../PriceQuantity/"

Slots

Name	Cardinality and Range	Description	Inheritance
priceQuantity	1..* PriceQuantity	Specifies both new floating rate index and spread adjustment for each leg to ...	direct
effectiveDate	1 date	Specifies the effective date of the index transition event	direct
cashTransfer	0..1 Transfer or ScheduledTransfer or UnscheduledTransfer	Specifies the cash transfer that can optionally be tied to an index transitio...	direct

Usages

used by	used in	type	used
PrimitiveInstruction	indexTransition	range	IndexTransitionInstruction

In Subsets

CdmEventCommon

Comments

Rosetta condition: PriceQuantity — priceQuantity -> price -> priceType contains PriceTypeEnum -> InterestRate and priceQuantity -> observable -> Index -> InterestRateIndex exists and priceQuantity -> quantity is absent
Rosetta func: Create_IndexTransitionTermsChange — Function specification to create a terms change that contains changes to the floating rate indexes and adds an adjustment spread to any existing spread.

Identifier and Mapping Information

Annotations

property

value

rosetta_functions

[{"name":"Create_IndexTransitionTermsChange","description":"Function specification to create a terms change that contains changes to the floating rate indexes and adds an adjustment spread to any existing spread.","inputs":[{"name":"instruction","type":"IndexTransitionInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"termsChange","type":"TradeState","cardinality":"1..1"}}]

Schema Source

from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:IndexTransitionInstruction
native	common_domain_model:IndexTransitionInstruction

LinkML Source

Direct

name: IndexTransitionInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_IndexTransitionTermsChange","description":"Function specification
      to create a terms change that contains changes to the floating rate indexes
      and adds an adjustment spread to any existing spread.","inputs":[{"name":"instruction","type":"IndexTransitionInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"termsChange","type":"TradeState","cardinality":"1..1"}}]'
description: Defines the information needed to create a Index Transition Business
  Event.
comments:
- 'Rosetta condition: PriceQuantity — priceQuantity -> price -> priceType contains
  PriceTypeEnum -> InterestRate and priceQuantity -> observable -> Index -> InterestRateIndex
  exists and priceQuantity -> quantity is absent'
- 'Rosetta func: Create_IndexTransitionTermsChange — Function specification to create
  a terms change that contains changes to the floating rate indexes and adds an adjustment
  spread to any existing spread.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- priceQuantity
- effectiveDate
- cashTransfer
slot_usage:
  priceQuantity:
    name: priceQuantity
    description: 'Specifies both new floating rate index and spread adjustment for
      each leg to be updated.  The spread adjustment accounts for the difference between
      the old floating rate index relative to the new one. This spread amount is added
      to the existing spread to determine the new spread, which is applied from the
      specified effective date forward. In the case of the IBOR Fallback Rate Adjustments,
      the adjustment spread (also known as the Fallback Adjustment) accounts for two
      distinctions: i) the fact that the replacement Risk-Free Rate is an overnight
      rate while IBORs have term structures (e.g., 1, 3, 6-month LIBOR); and (ii)
      the historical spread differential between IBORs and their term equivalent Overnight
      Risk-Free Rate compounded rates.'
  effectiveDate:
    name: effectiveDate
    description: Specifies the effective date of the index transition event. This
      is first date on which the floating rate calculation will use the new floating
      rate index and adjusted spread in the floating rate calculation.
    required: true

Induced

name: IndexTransitionInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_IndexTransitionTermsChange","description":"Function specification
      to create a terms change that contains changes to the floating rate indexes
      and adds an adjustment spread to any existing spread.","inputs":[{"name":"instruction","type":"IndexTransitionInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"termsChange","type":"TradeState","cardinality":"1..1"}}]'
description: Defines the information needed to create a Index Transition Business
  Event.
comments:
- 'Rosetta condition: PriceQuantity — priceQuantity -> price -> priceType contains
  PriceTypeEnum -> InterestRate and priceQuantity -> observable -> Index -> InterestRateIndex
  exists and priceQuantity -> quantity is absent'
- 'Rosetta func: Create_IndexTransitionTermsChange — Function specification to create
  a terms change that contains changes to the floating rate indexes and adds an adjustment
  spread to any existing spread.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  priceQuantity:
    name: priceQuantity
    description: 'Specifies both new floating rate index and spread adjustment for
      each leg to be updated.  The spread adjustment accounts for the difference between
      the old floating rate index relative to the new one. This spread amount is added
      to the existing spread to determine the new spread, which is applied from the
      specified effective date forward. In the case of the IBOR Fallback Rate Adjustments,
      the adjustment spread (also known as the Fallback Adjustment) accounts for two
      distinctions: i) the fact that the replacement Risk-Free Rate is an overnight
      rate while IBORs have term structures (e.g., 1, 3, 6-month LIBOR); and (ii)
      the historical spread differential between IBORs and their term equivalent Overnight
      Risk-Free Rate compounded rates.'
  effectiveDate:
    name: effectiveDate
    description: Specifies the effective date of the index transition event. This
      is first date on which the floating rate calculation will use the new floating
      rate index and adjusted spread in the floating rate calculation.
    required: true
attributes:
  priceQuantity:
    name: priceQuantity
    description: 'Specifies both new floating rate index and spread adjustment for
      each leg to be updated.  The spread adjustment accounts for the difference between
      the old floating rate index relative to the new one. This spread amount is added
      to the existing spread to determine the new spread, which is applied from the
      specified effective date forward. In the case of the IBOR Fallback Rate Adjustments,
      the adjustment spread (also known as the Fallback Adjustment) accounts for two
      distinctions: i) the fact that the replacement Risk-Free Rate is an overnight
      rate while IBORs have term structures (e.g., 1, 3, 6-month LIBOR); and (ii)
      the historical spread differential between IBORs and their term equivalent Overnight
      Risk-Free Rate compounded rates.'
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: IndexTransitionInstruction
    domain_of:
    - ExecutionInstruction
    - IndexTransitionInstruction
    - PositionBase
    - PayoutBase
    - TradeLot
    range: PriceQuantity
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
  effectiveDate:
    name: effectiveDate
    description: Specifies the effective date of the index transition event. This
      is first date on which the floating rate calculation will use the new floating
      rate index and adjusted spread in the floating rate calculation.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CodeValue.effectiveDate
    rank: 1000
    owner: IndexTransitionInstruction
    domain_of:
    - CodeValue
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - ClosedState
    - EventInstruction
    - LegalAgreementBase
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - EconomicTerms
    - CancelableProvision
    range: date
    required: true
  cashTransfer:
    name: cashTransfer
    description: Specifies the cash transfer that can optionally be tied to an index
      transition event.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: IndexTransitionInstruction
    domain_of:
    - IndexTransitionInstruction
    range: Transfer
    any_of:
    - range: ScheduledTransfer
    - range: UnscheduledTransfer