Skip to content
common-domain-model

Class: DividendPeriod

Time bounded dividend payment periods, each with a dividend payment date per period.

URI: common_domain_model:DividendPeriod

 classDiagram
    class DividendPeriod
    click DividendPeriod href "../DividendPeriod/"
      DividendPeriod : basketConstituent
        
          
    
        
        
        DividendPeriod --> "0..1" BasketConstituent : basketConstituent
        click BasketConstituent href "../BasketConstituent/"
    

        
      DividendPeriod : dateAdjustments
        
          
    
        
        
        DividendPeriod --> "1" BusinessDayAdjustments : dateAdjustments
        click BusinessDayAdjustments href "../BusinessDayAdjustments/"
    

        
      DividendPeriod : dividendPaymentDate
        
          
    
        
        
        DividendPeriod --> "1" DividendPaymentDate : dividendPaymentDate
        click DividendPaymentDate href "../DividendPaymentDate/"
    

        
      DividendPeriod : dividendValuationDate
        
          
    
        
        
        DividendPeriod --> "0..1" AdjustableOrRelativeDate : dividendValuationDate
        click AdjustableOrRelativeDate href "../AdjustableOrRelativeDate/"
    

        
      DividendPeriod : endDate
        
          
    
        
        
        DividendPeriod --> "0..1" DividendPaymentDate : endDate
        click DividendPaymentDate href "../DividendPaymentDate/"
    

        
      DividendPeriod : startDate
        
          
    
        
        
        DividendPeriod --> "0..1" DividendPaymentDate : startDate
        click DividendPaymentDate href "../DividendPaymentDate/"

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
startDate 0..1
DividendPaymentDate		 Dividend period start date direct
endDate 0..1
DividendPaymentDate		 Dividend period end date direct
dateAdjustments 1
BusinessDayAdjustments		 Date adjustments for all unadjusted dates in this dividend period direct
basketConstituent 0..1
BasketConstituent		 For basket underliers, reference to the basket component which is paying divi… direct
dividendPaymentDate 1
DividendPaymentDate		 Specifies when the dividend will be paid to the receiver of the equity return direct
dividendValuationDate 0..1
AdjustableOrRelativeDate		 Specifies the dividend valuation dates of the swap direct

Usages

Section titled “Usages”
used by used in type used
DividendReturnTerms dividendPeriod range DividendPeriod

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:DividendPeriod
native common_domain_model:DividendPeriod

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: DividendPeriod
description: Time bounded dividend payment periods, each with a dividend payment date
  per period.
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- startDate
- endDate
slot_usage:
  startDate:
    name: startDate
    description: Dividend period start date.
    range: DividendPaymentDate
  endDate:
    name: endDate
    description: Dividend period end date.
    range: DividendPaymentDate
attributes:
  dateAdjustments:
    name: dateAdjustments
    description: Date adjustments for all unadjusted dates in this dividend period.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    domain_of:
    - AdjustableDate
    - AdjustableDates
    - AdjustableOrAdjustedDate
    - AdjustableOrAdjustedOrRelativeDate
    - ObservationSchedule
    - DividendPeriod
    - EconomicTerms
    range: BusinessDayAdjustments
    required: true
  basketConstituent:
    name: basketConstituent
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: address "pointsTo"=PriceQuantity->observable->Basket->basketConstituent
    description: For basket underliers, reference to the basket component which is
      paying dividends in the specified period.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    domain_of:
    - Basket
    - DividendPayoutRatio
    - DividendPeriod
    range: BasketConstituent
  dividendPaymentDate:
    name: dividendPaymentDate
    description: Specifies when the dividend will be paid to the receiver of the equity
      return. Has the meaning as defined in the ISDA 2002 Equity Derivatives Definitions.
      Is not applicable in the case of a dividend reinvestment election.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    domain_of:
    - DividendPeriod
    range: DividendPaymentDate
    required: true
  dividendValuationDate:
    name: dividendValuationDate
    description: Specifies the dividend valuation dates of the swap.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    domain_of:
    - DividendPeriod
    range: AdjustableOrRelativeDate

Induced

Section titled “Induced”
name: DividendPeriod
description: Time bounded dividend payment periods, each with a dividend payment date
  per period.
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  startDate:
    name: startDate
    description: Dividend period start date.
    range: DividendPaymentDate
  endDate:
    name: endDate
    description: Dividend period end date.
    range: DividendPaymentDate
attributes:
  dateAdjustments:
    name: dateAdjustments
    description: Date adjustments for all unadjusted dates in this dividend period.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    owner: DividendPeriod
    domain_of:
    - AdjustableDate
    - AdjustableDates
    - AdjustableOrAdjustedDate
    - AdjustableOrAdjustedOrRelativeDate
    - ObservationSchedule
    - DividendPeriod
    - EconomicTerms
    range: BusinessDayAdjustments
    required: true
  basketConstituent:
    name: basketConstituent
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: address "pointsTo"=PriceQuantity->observable->Basket->basketConstituent
    description: For basket underliers, reference to the basket component which is
      paying dividends in the specified period.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    owner: DividendPeriod
    domain_of:
    - Basket
    - DividendPayoutRatio
    - DividendPeriod
    range: BasketConstituent
  dividendPaymentDate:
    name: dividendPaymentDate
    description: Specifies when the dividend will be paid to the receiver of the equity
      return. Has the meaning as defined in the ISDA 2002 Equity Derivatives Definitions.
      Is not applicable in the case of a dividend reinvestment election.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    owner: DividendPeriod
    domain_of:
    - DividendPeriod
    range: DividendPaymentDate
    required: true
  dividendValuationDate:
    name: dividendValuationDate
    description: Specifies the dividend valuation dates of the swap.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    owner: DividendPeriod
    domain_of:
    - DividendPeriod
    range: AdjustableOrRelativeDate
  startDate:
    name: startDate
    description: Dividend period start date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPeriod
    domain_of:
    - AveragingSchedule
    - DateRange
    - PeriodicDates
    - FroHistory
    - CalculationPeriodData
    - AssetDeliveryPeriods
    - DividendPeriod
    range: DividendPaymentDate
  endDate:
    name: endDate
    description: Dividend period end date.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPeriod
    domain_of:
    - AveragingSchedule
    - DateRange
    - PeriodicDates
    - FroHistory
    - CalculationPeriodData
    - CustodianEvent
    - AssetDeliveryPeriods
    - DividendPeriod
    range: DividendPaymentDate