Class: Period

A class to define recurring periods or time offsets.

URI: common_domain_model:Period

 classDiagram
    class Period
    click Period href "../Period/"
      Period <|-- Offset
        click Offset href "../Offset/"
      Period <|-- BusinessDayOffset
        click BusinessDayOffset href "../BusinessDayOffset/"
      
      Period : period
        
          
    
        
        
        Period --> "1" PeriodEnum : period
        click PeriodEnum href "../PeriodEnum/"
    

        
      Period : periodMultiplier
        
      

Inheritance

• Period
  • Offset
  • BusinessDayOffset

Slots

Name	Cardinality and Range	Description	Inheritance
periodMultiplier	1 Integer	A time period multiplier, e	direct
period	1 PeriodEnum	A time period, e	direct

Usages

used by	used in	type	used
CalculationFrequency	period	range	Period
PeriodBound	period	range	Period
AssetFloatingRateIndex	indexTenor	range	Period
InflationIndex	indexTenor	range	Period
MakeWholeAmount	indexTenor	range	Period
SwapCurveValuation	indexTenor	range	Period
StubFloatingRate	indexTenor	range	Period
AverageTradingVolume	period	range	Period
SubstitutionProvisions	noticeDeadlinePeriod	range	Period
DeliverableObligations	maximumMaturity	range	Period
CancelableProvision	effectivePeriod	range	Period
EarlyTerminationProvision	mandatoryEarlyTerminationDateTenor	range	Period
ExercisePeriod	earliestExerciseDateTenor	range	Period
ExercisePeriod	exerciseFrequency	range	Period

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'periodMultiplier': {'equals_number': 0}}	{'period': {'equals_string': 'D'}}

Identifier and Mapping Information

Annotations

property	value
rosetta_metadata	key

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Period
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A class to define recurring periods or time offsets.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  periodMultiplier:
    name: periodMultiplier
    description: A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can
      be used when specifying an offset relative to another date, e.g. -2 days.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    domain_of:
    - Frequency
    - Period
    - Velocity
    range: integer
    required: true
  period:
    name: period
    description: A time period, e.g. a day, week, month or year of the stream. If
      the periodMultiplier value is 0 (zero) then period must contain the value D
      (day).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    domain_of:
    - CalculationFrequency
    - Frequency
    - Period
    - PeriodBound
    - Velocity
    - AverageTradingVolume
    range: PeriodEnum
    required: true
rules:
- preconditions:
    slot_conditions:
      periodMultiplier:
        name: periodMultiplier
        equals_number: 0
  postconditions:
    slot_conditions:
      period:
        name: period
        equals_string: D
  description: 'DayPeriod: FpML specifies that if the periodMultiplier value is 0
    (zero) then period must contain the value D (day).'

Induced

name: Period
annotations:
  rosetta_metadata:
    tag: rosetta_metadata
    value: key
description: A class to define recurring periods or time offsets.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  periodMultiplier:
    name: periodMultiplier
    description: A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can
      be used when specifying an offset relative to another date, e.g. -2 days.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    owner: Period
    domain_of:
    - Frequency
    - Period
    - Velocity
    range: integer
    required: true
  period:
    name: period
    description: A time period, e.g. a day, week, month or year of the stream. If
      the periodMultiplier value is 0 (zero) then period must contain the value D
      (day).
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_datetime
    owner: Period
    domain_of:
    - CalculationFrequency
    - Frequency
    - Period
    - PeriodBound
    - Velocity
    - AverageTradingVolume
    range: PeriodEnum
    required: true
rules:
- preconditions:
    slot_conditions:
      periodMultiplier:
        name: periodMultiplier
        equals_number: 0
  postconditions:
    slot_conditions:
      period:
        name: period
        equals_string: D
  description: 'DayPeriod: FpML specifies that if the periodMultiplier value is 0
    (zero) then period must contain the value D (day).'