Class: ReferencePoolItem

This type contains all the constituent weight and reference information.

URI: common_domain_model:ReferencePoolItem

 classDiagram
    class ReferencePoolItem
    click ReferencePoolItem href "../ReferencePoolItem/"
      ReferencePoolItem : cashSettlementTermsReference





        ReferencePoolItem --> "0..1" CashSettlementTerms : cashSettlementTermsReference
        click CashSettlementTerms href "../CashSettlementTerms/"



      ReferencePoolItem : constituentWeight





        ReferencePoolItem --> "0..1" ConstituentWeight : constituentWeight
        click ConstituentWeight href "../ConstituentWeight/"



      ReferencePoolItem : physicalSettlementTermsReference





        ReferencePoolItem --> "0..1" PhysicalSettlementTerms : physicalSettlementTermsReference
        click PhysicalSettlementTerms href "../PhysicalSettlementTerms/"



      ReferencePoolItem : protectionTermsReference





        ReferencePoolItem --> "0..1" ProtectionTerms : protectionTermsReference
        click ProtectionTerms href "../ProtectionTerms/"



      ReferencePoolItem : referencePair





        ReferencePoolItem --> "1" ReferencePair : referencePair
        click ReferencePair href "../ReferencePair/"

Slots

Name	Cardinality and Range	Description	Inheritance
constituentWeight	0..1 ConstituentWeight	Describes the weight of each of the constituents within the basket	direct
referencePair	1 ReferencePair		direct
protectionTermsReference	0..1 ProtectionTerms	Reference to the documentation terms applicable to this item	direct
cashSettlementTermsReference	0..1 CashSettlementTerms	Reference to the cash settlement terms applicable to this item	direct
physicalSettlementTermsReference	0..1 PhysicalSettlementTerms	Reference to the physical settlement terms applicable to this item	direct

Usages

used by	used in	type	used
ReferencePool	referencePoolItem	range	ReferencePoolItem

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmProductAsset

Comments

Rosetta condition: SettlementChoice — optional choice cashSettlementTermsReference, physicalSettlementTermsReference

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ReferencePoolItem
description: This type contains all the constituent weight and reference information.
comments:
- 'Rosetta condition: SettlementChoice — optional choice cashSettlementTermsReference,
  physicalSettlementTermsReference'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- constituentWeight
- referencePair
- protectionTermsReference
- cashSettlementTermsReference
- physicalSettlementTermsReference
rules:
- postconditions:
    any_of:
    - slot_conditions:
        cashSettlementTermsReference:
          name: cashSettlementTermsReference
          required: true
    - slot_conditions:
        physicalSettlementTermsReference:
          name: physicalSettlementTermsReference
          required: true
  description: A choice rule between a reference to the cash or physical settlement
    terms.

Induced

name: ReferencePoolItem
description: This type contains all the constituent weight and reference information.
comments:
- 'Rosetta condition: SettlementChoice — optional choice cashSettlementTermsReference,
  physicalSettlementTermsReference'
in_subset:
- cdm_product_asset
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  constituentWeight:
    name: constituentWeight
    description: Describes the weight of each of the constituents within the basket.
      If not provided, it is assumed to be equal weighted.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReferencePoolItem
    domain_of:
    - ReferencePoolItem
    range: ConstituentWeight
  referencePair:
    name: referencePair
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReferencePoolItem
    domain_of:
    - ReferencePoolItem
    range: ReferencePair
    required: true
  protectionTermsReference:
    name: protectionTermsReference
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    description: Reference to the documentation terms applicable to this item.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReferencePoolItem
    domain_of:
    - ReferencePoolItem
    range: ProtectionTerms
  cashSettlementTermsReference:
    name: cashSettlementTermsReference
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    description: Reference to the cash settlement terms applicable to this item.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReferencePoolItem
    domain_of:
    - ReferencePoolItem
    range: CashSettlementTerms
  physicalSettlementTermsReference:
    name: physicalSettlementTermsReference
    annotations:
      metadata_reference:
        tag: metadata_reference
        value: true
    description: Reference to the physical settlement terms applicable to this item.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ReferencePoolItem
    domain_of:
    - ReferencePoolItem
    range: PhysicalSettlementTerms
rules:
- postconditions:
    any_of:
    - slot_conditions:
        cashSettlementTermsReference:
          name: cashSettlementTermsReference
          required: true
    - slot_conditions:
        physicalSettlementTermsReference:
          name: physicalSettlementTermsReference
          required: true
  description: A choice rule between a reference to the cash or physical settlement
    terms.