Class: ResetInstruction

_Defines the information needed to create a Reset Business Event. _

URI: common_domain_model:ResetInstruction

 classDiagram
    class ResetInstruction
    click ResetInstruction href "../ResetInstruction/"
      ResetInstruction : payout





        ResetInstruction --> "1..*" Payout : payout
        click Payout href "../Payout/"



      ResetInstruction : rateRecordDate

      ResetInstruction : resetDate

Slots

Name	Cardinality and Range	Description	Inheritance
payout	1..* Payout or AssetPayout or CommodityPayout or CreditDefaultPayout or FixedPricePayout or InterestRatePayout or OptionPayout or PerformancePayout or SettlementPayout		direct
rateRecordDate	0..1 date	Specifies the 'Rate Record Day' for a Fallback rate	direct
resetDate	1 date	Specifies the date on which the reset is occuring	direct

Usages

used by	used in	type	used
PrimitiveInstruction	reset	range	ResetInstruction

In Subsets

CdmEventCommon

Comments

Rosetta func: Create_Reset — Defines how a Reset should be constructed.

Identifier and Mapping Information

Annotations

property	value
rosetta_functions	[{"name":"Create_Reset","description":"Defines how a Reset should be constructed.","inputs":[{"name":"instruction","type":"ResetInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"reset","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:ResetInstruction
native	common_domain_model:ResetInstruction

LinkML Source

Direct

name: ResetInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Reset","description":"Defines how a Reset should be constructed.","inputs":[{"name":"instruction","type":"ResetInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"reset","type":"TradeState","cardinality":"1..1"}}]'
description: 'Defines the information needed to create a Reset Business Event. '
comments:
- 'Rosetta func: Create_Reset — Defines how a Reset should be constructed.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- payout
- rateRecordDate
- resetDate

Induced

name: ResetInstruction
annotations:
  rosetta_functions:
    tag: rosetta_functions
    value: '[{"name":"Create_Reset","description":"Defines how a Reset should be constructed.","inputs":[{"name":"instruction","type":"ResetInstruction","cardinality":"1..1"},{"name":"tradeState","type":"TradeState","cardinality":"1..1"}],"output":{"name":"reset","type":"TradeState","cardinality":"1..1"}}]'
description: 'Defines the information needed to create a Reset Business Event. '
comments:
- 'Rosetta func: Create_Reset — Defines how a Reset should be constructed.'
in_subset:
- cdm_event_common
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  payout:
    name: payout
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ResetInstruction
    domain_of:
    - ResetInstruction
    - CalculateTransferInstruction
    - EconomicTerms
    range: Payout
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true
    any_of:
    - range: AssetPayout
    - range: CommodityPayout
    - range: CreditDefaultPayout
    - range: FixedPricePayout
    - range: InterestRatePayout
    - range: OptionPayout
    - range: PerformancePayout
    - range: SettlementPayout
  rateRecordDate:
    name: rateRecordDate
    description: Specifies the 'Rate Record Day' for a Fallback rate.  Fallback rate
      fixing processes typically set the fixing rate in arrears, i.e., the Fallback
      Rate corresponding to a Rate Record Date is set at the end of the interest accural
      period.  When this applies, Reset->resetDate occurs at the end of the interest
      period, and the Reset->rateRecordDate occurs near the start of the interest
      period.  The Reset->rateRecordDate and Reset->observations->observationIdentifier->observationDate
      will differ if a Fallback rate is unavailable on the Rate Record Date, and the
      latest previous available rate is used as the observation.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ResetInstruction
    domain_of:
    - ResetInstruction
    - Reset
    range: date
  resetDate:
    name: resetDate
    description: Specifies the date on which the reset is occuring.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ResetInstruction
    domain_of:
    - ResetInstruction
    - Reset
    - RateObservation
    - FxLinkedNotionalAmount
    - FloatingRateSettingDetails
    range: date
    required: true