src.cdm.base.staticdata.asset.common.CommodityReferenceFramework.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdm-java Show documentation

There is a newer version: 6.0.0-dev.92

# pylint: disable=line-too-long, invalid-name, missing-function-docstring, missing-module-docstring, superfluous-parens
# pylint: disable=wrong-import-position, unused-import, unused-wildcard-import, wildcard-import, wrong-import-order, missing-class-docstring
from __future__ import annotations
from typing import List, Optional
from datetime import date
from datetime import time
from datetime import datetime
from decimal import Decimal
from pydantic import Field
from rosetta.runtime.utils import *

__all__ = ['CommodityReferenceFramework']


class CommodityReferenceFramework(BaseDataClass):
  """
  Specifies the type of commodity.
  """
  commodityName: str = Field(..., 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.")
  """
  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.
  """
  capacityUnit: Optional[CapacityUnitEnum] = Field(None, description="Provides an enumerated value for a capacity unit, generally used in the context of defining quantities for commodities.")
  """
  Provides an enumerated value for a capacity unit, generally used in the context of defining quantities for commodities.
  """
  weatherUnit: Optional[WeatherUnitEnum] = Field(None, description="Provides an enumerated values for a weather unit, generally used in the context of defining quantities for commodities.")
  """
  Provides an enumerated values for a weather unit, generally used in the context of defining quantities for commodities.
  """
  currency: AttributeWithMeta[str] | str = Field(..., description="Defines the currency in which the commodity is priced.")
  """
  Defines the currency in which the commodity is priced.
  """
  
  @rosetta_condition
  def condition_0_CommodityReferenceFrameworkChoice(self):
    """
    Requires that either the capacity unit or weather unit is populated.
    """
    return self.check_one_of_constraint('capacityUnit', 'weatherUnit', necessity=False)

from cdm.base.math.CapacityUnitEnum import CapacityUnitEnum
from cdm.base.math.WeatherUnitEnum import WeatherUnitEnum

CommodityReferenceFramework.update_forward_refs()