Class: Underlier

The underlying financial product that will be physically or cash settled, which can be of any type, eg an asset such as cash or a security, a product, or the cash settlement of an index rate. Conditions are usually applied when used in a data type, such as a payout, to ensure this aligns with the use case.

URI: common_domain_model:Underlier

 classDiagram
    class Underlier
    click Underlier href "../Underlier/"
      Underlier : Observable
        
          
    
        
        
        Underlier --> "0..1" Observable : Observable
        click Observable href "../Observable/"
    

        
      Underlier : Product
        
          
    
        
        
        Underlier --> "0..1" Product : Product
        click Product href "../Product/"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
Observable	0..1 Observable	Specifies the object to be observed for a price, it could be an asset or a re…	direct
Product	0..1 Product	Enables either a TransferableProduct or a NonTransferableProduct to be used i…	direct

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: ‘OneOf: A choice type holds exactly one of its options.’, ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘Observable’: SlotDefinition({‘name’: ‘Observable’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘Product’: SlotDefinition({‘name’: ‘Product’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })] })

Usages

used by	used in	type	used
CorporateAction	underlier	range	Underlier
CommodityPayout	underlier	range	Underlier
OptionPayout	underlier	range	Underlier
PerformancePayout	underlier	range	Underlier
SettlementPayout	underlier	range	Underlier

Identifier and Mapping Information

Annotations

property	value
rosetta_choice	true

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Underlier
annotations:
  rosetta_choice:
    tag: rosetta_choice
    value: 'true'
description: The underlying financial product that will be physically or cash settled,
  which can be of any type, eg an asset such as cash or a security, a product, or
  the cash settlement of an index rate. Conditions are usually applied when used in
  a data type, such as a payout, to ensure this aligns with the use case.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  Observable:
    name: Observable
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: address "pointsTo"=PriceQuantity->observable
    description: Specifies the object to be observed for a price, it could be an asset
      or a reference.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_template
    rank: 1000
    domain_of:
    - Underlier
    range: Observable
  Product:
    name: Product
    description: Enables either a TransferableProduct or a NonTransferableProduct
      to be used in an underlier.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_template
    rank: 1000
    domain_of:
    - Underlier
    range: Product
all_of:
- description: 'OneOf: A choice type holds exactly one of its options.'
  exactly_one_of:
  - slot_conditions:
      Observable:
        name: Observable
        value_presence: PRESENT
  - slot_conditions:
      Product:
        name: Product
        value_presence: PRESENT

Induced

name: Underlier
annotations:
  rosetta_choice:
    tag: rosetta_choice
    value: 'true'
description: The underlying financial product that will be physically or cash settled,
  which can be of any type, eg an asset such as cash or a security, a product, or
  the cash settlement of an index rate. Conditions are usually applied when used in
  a data type, such as a payout, to ensure this aligns with the use case.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  Observable:
    name: Observable
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: address "pointsTo"=PriceQuantity->observable
    description: Specifies the object to be observed for a price, it could be an asset
      or a reference.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_template
    rank: 1000
    owner: Underlier
    domain_of:
    - Underlier
    range: Observable
  Product:
    name: Product
    description: Enables either a TransferableProduct or a NonTransferableProduct
      to be used in an underlier.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_product_template
    rank: 1000
    owner: Underlier
    domain_of:
    - Underlier
    range: Product
all_of:
- description: 'OneOf: A choice type holds exactly one of its options.'
  exactly_one_of:
  - slot_conditions:
      Observable:
        name: Observable
        value_presence: PRESENT
  - slot_conditions:
      Product:
        name: Product
        value_presence: PRESENT