Class: DividendDateReference

A class to specify the dividend date by reference to another date, with the ability to apply and offset. This class doesn’t exist in FpML and is meant to simplify the choice constraint associated with the DividendPaymentDate class.

URI: common_domain_model:DividendDateReference

 classDiagram
    class DividendDateReference
    click DividendDateReference href "../DividendDateReference/"
      DividendDateReference : dateReference
        
          
    
        
        
        DividendDateReference --> "1" DividendDateReferenceEnum : dateReference
        click DividendDateReferenceEnum href "../DividendDateReferenceEnum/"
    

        
      DividendDateReference : paymentDateOffset
        
          
    
        
        
        DividendDateReference --> "0..1" Offset : paymentDateOffset
        click Offset href "../Offset/"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
dateReference	1 DividendDateReferenceEnum	Specification of the dividend date using an enumeration, with values such as …	direct
paymentDateOffset	0..1 Offset	Only to be used when SharePayment has been specified in the dividendDateRefer…	direct

Usages

used by	used in	type	used
DividendPaymentDate	dividendDateReference	range	DividendDateReference

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'paymentDateOffset': {'value_presence': 'PRESENT'}}	{'dateReference': {'equals_string': 'SharePayment'}}

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: DividendDateReference
description: A class to specify the dividend date by reference to another date, with
  the ability to apply and offset. This class doesn't exist in FpML and is meant to
  simplify the choice constraint associated with the DividendPaymentDate class.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  dateReference:
    name: dateReference
    description: Specification of the dividend date using an enumeration, with values
      such as the pay date, the ex-date or the record date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    domain_of:
    - DividendDateReference
    range: DividendDateReferenceEnum
    required: true
  paymentDateOffset:
    name: paymentDateOffset
    description: Only to be used when SharePayment has been specified in the dividendDateReference
      element. The number of Currency Business Days following the day on which the
      Issuer of the Shares pays the relevant dividend to holders of record of the
      Shares.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    domain_of:
    - DividendDateReference
    range: Offset
rules:
- preconditions:
    slot_conditions:
      paymentDateOffset:
        name: paymentDateOffset
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      dateReference:
        name: dateReference
        equals_string: SharePayment
  description: 'PaymentDateOffset: FpML specifies that paymentDateOffset is only to
    be used when SharePayment has been specified in the dividendDateReference element.'

Induced

name: DividendDateReference
description: A class to specify the dividend date by reference to another date, with
  the ability to apply and offset. This class doesn't exist in FpML and is meant to
  simplify the choice constraint associated with the DividendPaymentDate class.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  dateReference:
    name: dateReference
    description: Specification of the dividend date using an enumeration, with values
      such as the pay date, the ex-date or the record date.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    owner: DividendDateReference
    domain_of:
    - DividendDateReference
    range: DividendDateReferenceEnum
    required: true
  paymentDateOffset:
    name: paymentDateOffset
    description: Only to be used when SharePayment has been specified in the dividendDateReference
      element. The number of Currency Business Days following the day on which the
      Issuer of the Shares pays the relevant dividend to holders of record of the
      Shares.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_asset
    rank: 1000
    owner: DividendDateReference
    domain_of:
    - DividendDateReference
    range: Offset
rules:
- preconditions:
    slot_conditions:
      paymentDateOffset:
        name: paymentDateOffset
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      dateReference:
        name: dateReference
        equals_string: SharePayment
  description: 'PaymentDateOffset: FpML specifies that paymentDateOffset is only to
    be used when SharePayment has been specified in the dividendDateReference element.'