Class: Commodity

Identifies a specific commodity by referencing a product identifier or by a product definition.

 classDiagram
    class Commodity
    click Commodity href "../Commodity/"
      AssetBase <|-- Commodity
        click AssetBase href "../AssetBase/"

      Commodity : assetType





        Commodity --> "1" AssetTypeEnum : assetType
        click AssetTypeEnum href "../AssetTypeEnum/"



      Commodity : commodityProductDefinition





        Commodity --> "0..1" CommodityProductDefinition : commodityProductDefinition
        click CommodityProductDefinition href "../CommodityProductDefinition/"



      Commodity : deliveryDateReference





        Commodity --> "0..1" DeliveryDateParameters : deliveryDateReference
        click DeliveryDateParameters href "../DeliveryDateParameters/"



      Commodity : description

      Commodity : exchange





        Commodity --> "0..1" LegalEntity : exchange
        click LegalEntity href "../LegalEntity/"



      Commodity : identifier





        Commodity --> "1..*" AssetIdentifier : identifier
        click AssetIdentifier href "../AssetIdentifier/"



      Commodity : isExchangeListed

      Commodity : priceQuoteType





        Commodity --> "1" QuotationSideEnum : priceQuoteType
        click QuotationSideEnum href "../QuotationSideEnum/"



      Commodity : relatedExchange





        Commodity --> "*" LegalEntity : relatedExchange
        click LegalEntity href "../LegalEntity/"



      Commodity : taxonomy





        Commodity --> "*" Taxonomy : taxonomy
        click Taxonomy href "../Taxonomy/"

Inheritance

AssetBase
- Commodity

Slots

Name	Cardinality and Range	Description	Inheritance
commodityProductDefinition	0..1 CommodityProductDefinition	Specifies the commodity underlier in the event that no ISDA Commodity Referen...	direct
priceQuoteType	1 QuotationSideEnum	Describes the required quote type of the underlying price that will be observ...	direct
deliveryDateReference	0..1 DeliveryDateParameters	Specifies the parameters for identifying the relevant contract date when the ...	direct
description	0..1 string	Provides additional information about the commodity underlier	direct
identifier	1..* AssetIdentifier	Asset Identifiers are used to uniquely identify an Asset, using a specified A...	AssetBase
taxonomy	* Taxonomy	Defines the taxonomy of an object by combining a taxonomy source (i	AssetBase
isExchangeListed	0..1 Boolean	Defines whether the Asset is listed on a public exchange	AssetBase
exchange	0..1 LegalEntity	If the Asset is listed, defines the public exchange of the listing	AssetBase
relatedExchange	* LegalEntity	Provides the related Exchanges, if applicable	AssetBase
assetType	1 AssetTypeEnum	Specifies the type of asset	AssetBase

Usages

used by	used in	type	used
UnscheduledTransfer	asset	any_of[range]	Commodity
ScheduledTransfer	asset	any_of[range]	Commodity
TransferBase	asset	any_of[range]	Commodity
CollateralPosition	asset	any_of[range]	Commodity
PositionBase	asset	any_of[range]	Commodity
Position	asset	any_of[range]	Commodity
AssetFlowBase	asset	any_of[range]	Commodity
AssetFlow	asset	any_of[range]	Commodity

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions

In Subsets

CdmBaseStaticdataAssetCommon

Comments

Rosetta condition: ValueSource — if taxonomy exists then (taxonomy -> source exists and taxonomy -> value exists)
Rosetta condition: AssetType — assetType = Commodity

Identifier and Mapping Information

Schema Source

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

Mappings

Mapping Type	Mapped Value
self	common_domain_model:Commodity
native	common_domain_model:Commodity
close	fpml_5_10:Commodity

LinkML Source

Direct

name: Commodity
description: Identifies a specific commodity by referencing a product identifier or
  by a product definition.
comments:
- 'Rosetta condition: ValueSource — if taxonomy exists then (taxonomy -> source exists
  and taxonomy -> value exists)'
- 'Rosetta condition: AssetType — assetType = Commodity'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:Commodity
is_a: AssetBase
slots:
- commodityProductDefinition
- priceQuoteType
- deliveryDateReference
- description
rules:
- postconditions:
    slot_conditions:
      assetType:
        name: assetType
        equals_string: Commodity
  description: AssetType must be commodity.

Induced

name: Commodity
description: Identifies a specific commodity by referencing a product identifier or
  by a product definition.
comments:
- 'Rosetta condition: ValueSource — if taxonomy exists then (taxonomy -> source exists
  and taxonomy -> value exists)'
- 'Rosetta condition: AssetType — assetType = Commodity'
in_subset:
- cdm_base_staticdata_asset_common
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:Commodity
is_a: AssetBase
attributes:
  commodityProductDefinition:
    name: commodityProductDefinition
    description: Specifies the commodity underlier in the event that no ISDA Commodity
      Reference Benchmark exists.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:Commodity.commodityProductDefinition
    rank: 1000
    owner: Commodity
    domain_of:
    - Commodity
    range: CommodityProductDefinition
  priceQuoteType:
    name: priceQuoteType
    description: Describes the required quote type of the underlying price that will
      be observed. Example values include 'Bid, 'Ask', 'Settlement' (for a futures
      contract) and 'WeightedAverage' (for some published prices and indices).
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:Commodity.priceQuoteType
    rank: 1000
    owner: Commodity
    domain_of:
    - Commodity
    range: QuotationSideEnum
    required: true
  deliveryDateReference:
    name: deliveryDateReference
    description: Specifies the parameters for identifying the relevant contract date
      when the commodity reference price is a futures contract.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:Commodity.deliveryDateReference
    rank: 1000
    owner: Commodity
    domain_of:
    - Commodity
    range: DeliveryDateParameters
  description:
    name: description
    description: Provides additional information about the commodity underlier.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:Commodity.description
    rank: 1000
    owner: Commodity
    domain_of:
    - Commodity
    - TaxonomyClassification
    - CodeListIdentification
    - CodeValue
    - OtherIndex
    range: string
  identifier:
    name: identifier
    description: Asset Identifiers are used to uniquely identify an Asset, using a
      specified Asset Identifier Type.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.identifier
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - PartyIdentifier
    - EntityIdentifier
    - PersonIdentifier
    - TransferBase
    - OtherAgreement
    - LegalAgreementBase
    - NonLegalEntity
    - MasterAgreementClauseVariant
    - Clause
    - ContractualDefinition
    - FloatingRateIndexMap
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: AssetIdentifier
    required: true
    multivalued: true
  taxonomy:
    name: taxonomy
    description: Defines the taxonomy of an object by combining a taxonomy source
      (i.e. the rules to classify the object) and a value (i.e. the output of those
      rules on the object.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.taxonomy
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    - NonTransferableProduct
    range: Taxonomy
    multivalued: true
    inlined: true
    inlined_as_list: true
  isExchangeListed:
    name: isExchangeListed
    description: Defines whether the Asset is listed on a public exchange.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.isExchangeListed
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    range: boolean
  exchange:
    name: exchange
    description: If the Asset is listed, defines the public exchange of the listing.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.exchange
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    - ListingExchange
    range: LegalEntity
  relatedExchange:
    name: relatedExchange
    description: Provides the related Exchanges, if applicable.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.relatedExchange
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    range: LegalEntity
    multivalued: true
    inlined: true
    inlined_as_list: true
  assetType:
    name: assetType
    description: Specifies the type of asset.
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:AssetBase.assetType
    rank: 1000
    owner: Commodity
    domain_of:
    - AssetBase
    - AssetType
    range: AssetTypeEnum
    required: true
rules:
- postconditions:
    slot_conditions:
      assetType:
        name: assetType
        equals_string: Commodity
  description: AssetType must be commodity.