Class: DividendPayoutRatio

A class describing the dividend payout ratio associated with an equity underlier. In certain cases the actual ratio is not known on trade inception, and only general conditions are then specified.

URI: common_domain_model:DividendPayoutRatio

 classDiagram
    class DividendPayoutRatio
    click DividendPayoutRatio href "../DividendPayoutRatio/"
      DividendPayoutRatio : basketConstituent





        DividendPayoutRatio --> "0..1" BasketConstituent : basketConstituent
        click BasketConstituent href "../BasketConstituent/"



      DividendPayoutRatio : cashRatio

      DividendPayoutRatio : nonCashRatio

      DividendPayoutRatio : totalRatio

Slots

Name	Cardinality and Range	Description	Inheritance
totalRatio	1 Decimal	Specifies the total actual dividend payout ratio associated with the equity u...	direct
cashRatio	0..1 Decimal	Specifies the cash actual dividend payout ratio associated with the equity un...	direct
nonCashRatio	0..1 Decimal	Specifies the non cash actual dividend payout ratio associated with the equit...	direct
basketConstituent	0..1 BasketConstituent	In the case of a basket underlier, specifies to which component of the basket...	direct

Usages

used by	used in	type	used
DividendReturnTerms	dividendPayoutRatio	range	DividendPayoutRatio
DividendTerms	manufacturedIncomeRequirement	range	DividendPayoutRatio

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'cashRatio': {'required': True}}`	`{'cashRatio': {'minimum_value': 0, 'maximum_value': 1}}`

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	`{'nonCashRatio': {'required': True}}`	`{'nonCashRatio': {'minimum_value': 0, 'maximum_value': 1}}`

In Subsets

CdmProductAsset

Comments

Rosetta condition: DividendPayoutRatioTotal — totalRatio >= 0 and totalRatio <= 1
Rosetta condition: DividendPayoutRatioCash — if cashRatio exists then cashRatio >= 0 and totalRatio <= 1
Rosetta condition: DividendPayoutRatioNonCash — if nonCashRatio exists then nonCashRatio >= 0 and totalRatio <= 1

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: DividendPayoutRatio
description: A class describing the dividend payout ratio associated with an equity
  underlier. In certain cases the actual ratio is not known on trade inception, and
  only general conditions are then specified.
comments:
- 'Rosetta condition: DividendPayoutRatioTotal — totalRatio >= 0 and totalRatio <=
  1'
- 'Rosetta condition: DividendPayoutRatioCash — if cashRatio exists then cashRatio
  >= 0 and totalRatio <= 1'
- 'Rosetta condition: DividendPayoutRatioNonCash — if nonCashRatio exists then nonCashRatio
  >= 0 and totalRatio <= 1'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- totalRatio
- cashRatio
- nonCashRatio
- basketConstituent
slot_usage:
  basketConstituent:
    name: basketConstituent
    description: In the case of a basket underlier, specifies to which component of
      the basket this particular set of dividend payout ratios correspond.
    required: false
    multivalued: false
rules:
- postconditions:
    slot_conditions:
      totalRatio:
        name: totalRatio
        minimum_value: 0
        maximum_value: 1
  description: The dividend payout ratio should be comprised between 0 and 100%, meaning
    0 and 1.
- preconditions:
    slot_conditions:
      cashRatio:
        name: cashRatio
        required: true
  postconditions:
    slot_conditions:
      cashRatio:
        name: cashRatio
        minimum_value: 0
        maximum_value: 1
  description: The cash dividend payout ratio should be comprised between 0 and 100%,
    meaning 0 and 1.
- preconditions:
    slot_conditions:
      nonCashRatio:
        name: nonCashRatio
        required: true
  postconditions:
    slot_conditions:
      nonCashRatio:
        name: nonCashRatio
        minimum_value: 0
        maximum_value: 1
  description: The non cash dividend payout ratio should be comprised between 0 and
    100%, meaning 0 and 1.

Induced

name: DividendPayoutRatio
description: A class describing the dividend payout ratio associated with an equity
  underlier. In certain cases the actual ratio is not known on trade inception, and
  only general conditions are then specified.
comments:
- 'Rosetta condition: DividendPayoutRatioTotal — totalRatio >= 0 and totalRatio <=
  1'
- 'Rosetta condition: DividendPayoutRatioCash — if cashRatio exists then cashRatio
  >= 0 and totalRatio <= 1'
- 'Rosetta condition: DividendPayoutRatioNonCash — if nonCashRatio exists then nonCashRatio
  >= 0 and totalRatio <= 1'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  basketConstituent:
    name: basketConstituent
    description: In the case of a basket underlier, specifies to which component of
      the basket this particular set of dividend payout ratios correspond.
    required: false
    multivalued: false
attributes:
  totalRatio:
    name: totalRatio
    description: Specifies the total actual dividend payout ratio associated with
      the equity underlier. A ratio of 90% should be expressed at 0.90.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPayoutRatio
    domain_of:
    - DividendPayoutRatio
    range: decimal
    required: true
  cashRatio:
    name: cashRatio
    description: Specifies the cash actual dividend payout ratio associated with the
      equity underlier. A ratio of 90% should be expressed at 0.90.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPayoutRatio
    domain_of:
    - DividendPayoutRatio
    range: decimal
  nonCashRatio:
    name: nonCashRatio
    description: Specifies the non cash actual dividend payout ratio associated with
      the equity underlier. A ratio of 90% should be expressed at 0.90.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPayoutRatio
    domain_of:
    - DividendPayoutRatio
    range: decimal
  basketConstituent:
    name: basketConstituent
    description: In the case of a basket underlier, specifies to which component of
      the basket this particular set of dividend payout ratios correspond.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: DividendPayoutRatio
    domain_of:
    - Basket
    - DividendPayoutRatio
    - DividendPeriod
    range: BasketConstituent
    required: false
    multivalued: false
    inlined: true
    inlined_as_list: true
rules:
- postconditions:
    slot_conditions:
      totalRatio:
        name: totalRatio
        minimum_value: 0
        maximum_value: 1
  description: The dividend payout ratio should be comprised between 0 and 100%, meaning
    0 and 1.
- preconditions:
    slot_conditions:
      cashRatio:
        name: cashRatio
        required: true
  postconditions:
    slot_conditions:
      cashRatio:
        name: cashRatio
        minimum_value: 0
        maximum_value: 1
  description: The cash dividend payout ratio should be comprised between 0 and 100%,
    meaning 0 and 1.
- preconditions:
    slot_conditions:
      nonCashRatio:
        name: nonCashRatio
        required: true
  postconditions:
    slot_conditions:
      nonCashRatio:
        name: nonCashRatio
        minimum_value: 0
        maximum_value: 1
  description: The non cash dividend payout ratio should be comprised between 0 and
    100%, meaning 0 and 1.