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

Usages

used by	used in	type	used
CommodityProductDefinition	referenceFramework	range	CommodityReferenceFramework

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmBaseStaticdataAssetCommon

Comments

Rosetta condition: CommodityReferenceFrameworkChoice — optional choice capacityUnit, weatherUnit

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
close	fpml_5_10:CommodityReferenceFramework

LinkML Source

Direct

name: CommodityReferenceFramework
description: Specifies the type of commodity.
comments:
- 'Rosetta condition: CommodityReferenceFrameworkChoice — optional choice capacityUnit,
  weatherUnit'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CommodityReferenceFramework
slots:
- commodityName
- capacityUnit
- weatherUnit
- currency
slot_usage:
  currency:
    name: currency
    description: Defines the currency in which the commodity is priced.
    required: true
rules:
- postconditions:
    any_of:
    - slot_conditions:
        capacityUnit:
          name: capacityUnit
          required: true
    - slot_conditions:
        weatherUnit:
          name: weatherUnit
          required: true
  description: Requires that either the capacity unit or weather unit is populated.

Induced

name: CommodityReferenceFramework
description: Specifies the type of commodity.
comments:
- 'Rosetta condition: CommodityReferenceFrameworkChoice — optional choice capacityUnit,
  weatherUnit'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CommodityReferenceFramework
slot_usage:
  currency:
    name: currency
    description: Defines the currency in which the commodity is priced.
    required: true
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
    close_mappings:
    - fpml_5_10:CommodityReferenceFramework.commodityName
    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
    rank: 1000
    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
    rank: 1000
    owner: CommodityReferenceFramework
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    range: WeatherUnitEnum
  currency:
    name: currency
    annotations:
      metadata_scheme:
        tag: metadata_scheme
        value: true
    description: Defines the currency in which the commodity is priced.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CommodityReferenceFramework
    domain_of:
    - UnitType
    - CommodityReferenceFramework
    - NotDomesticCurrency
    - SpecifiedCurrency
    - LimitApplicable
    - CalculationCurrencyElection
    - CollateralRounding
    - TerminationCurrencyElection
    - ThresholdRatingsBased
    - MinimumTransferAmountRatingsBased
    - LegacyIndependentAmountRatingsBased
    - FloatingRateIndexIdentification
    - FeaturePayment
    - DividendCurrency
    - FutureValueAmount
    - AmountSchedule
    - CollateralInterestParameters
    - ComputedAmount
    range: string
    required: true
rules:
- postconditions:
    any_of:
    - slot_conditions:
        capacityUnit:
          name: capacityUnit
          required: true
    - slot_conditions:
        weatherUnit:
          name: weatherUnit
          required: true
  description: Requires that either the capacity unit or weather unit is populated.