Class: CommodityReferenceFramework

Specifies the type of commodity.

URI: common_domain_model:CommodityReferenceFramework

 classDiagram
    class CommodityReferenceFramework
    click CommodityReferenceFramework href "../CommodityReferenceFramework/"
      CommodityReferenceFramework : capacityUnit
        
          
    
        
        
        CommodityReferenceFramework --> "0..1" CapacityUnitEnum : capacityUnit
        click CapacityUnitEnum href "../CapacityUnitEnum/"
    

        
      CommodityReferenceFramework : commodityName
        
      CommodityReferenceFramework : currency
        
      CommodityReferenceFramework : weatherUnit
        
          
    
        
        
        CommodityReferenceFramework --> "0..1" WeatherUnitEnum : weatherUnit
        click WeatherUnitEnum href "../WeatherUnitEnum/"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
commodityName	1 string	Identifies the commodity more specifically	direct
capacityUnit	0..1 CapacityUnitEnum	Provides an enumerated value for a capacity unit, generally used in the conte…	direct
weatherUnit	0..1 WeatherUnitEnum	Provides an enumerated values for a weather unit, generally used in the conte…	direct
currency	1 string	Defines the currency in which the commodity is priced	direct

Expressions & Logic

All Of

The class must satisfy all of:

• AnonymousClassExpression({ ‘description’: (’CommodityReferenceFrameworkChoice: Requires that either the capacity unit or ’ ‘weather unit is populated.’), ‘exactly_one_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘capacityUnit’: SlotDefinition({‘name’: ‘capacityUnit’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘weatherUnit’: SlotDefinition({‘name’: ‘weatherUnit’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} }), AnonymousClassExpression({ ‘all_of’: [AnonymousClassExpression({ ‘slot_conditions’: {‘capacityUnit’: SlotDefinition({‘name’: ‘capacityUnit’, ‘value_presence’: PresenceEnum(text=‘ABSENT’)})} }), AnonymousClassExpression({ ‘slot_conditions’: {‘weatherUnit’: SlotDefinition({‘name’: ‘weatherUnit’, ‘value_presence’: PresenceEnum(text=‘ABSENT’)})} })] })] })

Usages

used by	used in	type	used
CommodityProductDefinition	referenceFramework	range	CommodityReferenceFramework

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: CommodityReferenceFramework
description: Specifies the type of commodity.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  commodityName:
    name: commodityName
    description: Identifies the commodity more specifically. Where possible, this
      should follow the naming convention used in the 2005 ISDA Commodity Definitions
      SubAnnex A, including the subCommodity and additional qualifiers, but should
      be limited to 256 characters or less.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    rank: 1000
    domain_of:
    - CommodityReferenceFramework
    range: string
    required: true
  capacityUnit:
    name: capacityUnit
    description: Provides an enumerated value for a capacity unit, generally used
      in the context of defining quantities for commodities.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    range: CapacityUnitEnum
  weatherUnit:
    name: weatherUnit
    description: Provides an enumerated values for a weather unit, generally used
      in the context of defining quantities for commodities.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    range: WeatherUnitEnum
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Defines the currency in which the commodity is priced.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
all_of:
- description: 'CommodityReferenceFrameworkChoice: Requires that either the capacity
    unit or weather unit is populated.'
  exactly_one_of:
  - slot_conditions:
      capacityUnit:
        name: capacityUnit
        value_presence: PRESENT
  - slot_conditions:
      weatherUnit:
        name: weatherUnit
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        capacityUnit:
          name: capacityUnit
          value_presence: ABSENT
    - slot_conditions:
        weatherUnit:
          name: weatherUnit
          value_presence: ABSENT

Induced

name: CommodityReferenceFramework
description: Specifies the type of commodity.
from_schema: https://w3id.org/lmodel/common-domain-model
attributes:
  commodityName:
    name: commodityName
    description: Identifies the commodity more specifically. Where possible, this
      should follow the naming convention used in the 2005 ISDA Commodity Definitions
      SubAnnex A, including the subCommodity and additional qualifiers, but should
      be limited to 256 characters or less.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    rank: 1000
    owner: CommodityReferenceFramework
    domain_of:
    - CommodityReferenceFramework
    range: string
    required: true
  capacityUnit:
    name: capacityUnit
    description: Provides an enumerated value for a capacity unit, generally used
      in the context of defining quantities for commodities.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    owner: CommodityReferenceFramework
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    range: CapacityUnitEnum
  weatherUnit:
    name: weatherUnit
    description: Provides an enumerated values for a weather unit, generally used
      in the context of defining quantities for commodities.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    owner: CommodityReferenceFramework
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    range: WeatherUnitEnum
  currency:
    name: currency
    annotations:
      rosetta_metadata:
        tag: rosetta_metadata
        value: scheme
    description: Defines the currency in which the commodity is priced.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_asset_common
    owner: CommodityReferenceFramework
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - FloatingRateIndexIdentification
    - AmountScheduleWithInitialValue
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
all_of:
- description: 'CommodityReferenceFrameworkChoice: Requires that either the capacity
    unit or weather unit is populated.'
  exactly_one_of:
  - slot_conditions:
      capacityUnit:
        name: capacityUnit
        value_presence: PRESENT
  - slot_conditions:
      weatherUnit:
        name: weatherUnit
        value_presence: PRESENT
  - all_of:
    - slot_conditions:
        capacityUnit:
          name: capacityUnit
          value_presence: ABSENT
    - slot_conditions:
        weatherUnit:
          name: weatherUnit
          value_presence: ABSENT