src.cdm.base.staticdata.asset.common.Commodity.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__ = ['Commodity']

from cdm.base.staticdata.asset.common.ProductBase import ProductBase

class Commodity(ProductBase):
  """
  Identifies a specific commodity by referencing a product identifier or by a product definition.
  """
  commodityProductDefinition: Optional[CommodityProductDefinition] = Field(None, description="Specifies the commodity underlier in the event that no ISDA Commodity Reference Benchmark exists.")
  """
  Specifies the commodity underlier in the event that no ISDA Commodity Reference Benchmark exists.
  """
  priceQuoteType: QuotationSideEnum = Field(..., 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).")
  """
  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).
  """
  deliveryDateReference: Optional[DeliveryDateParameters] = Field(None, description="Specifies the parameters for identifying the relevant contract date when the commodity reference price is a futures contract.")
  """
  Specifies the parameters for identifying the relevant contract date when the commodity reference price is a futures contract.
  """
  description: Optional[str] = Field(None, description="Provides additional information about the commodity underlier.")
  """
  Provides additional information about the commodity underlier.
  """
  
  @rosetta_condition
  def condition_0_OrdinalExists(self):
    """
    Requires that, if multiple classification elements are present, they contain an  ordinal so that they can be sorted.
    """
    def _then_fn0():
      return ((_resolve_rosetta_attr(_resolve_rosetta_attr(_resolve_rosetta_attr(_resolve_rosetta_attr(self, "productTaxonomy"), "value"), "classification"), "ordinal")) is not None)
    
    def _else_fn0():
      return True
    
    return if_cond_fn(all_elements(len(_resolve_rosetta_attr(_resolve_rosetta_attr(_resolve_rosetta_attr(self, "productTaxonomy"), "value"), "classification")), ">", 1), _then_fn0, _else_fn0)
  
  @rosetta_condition
  def condition_1_ValueSource(self):
    """
    Requires that value and source are present when product taxonomy is present
    """
    def _then_fn0():
      return (((_resolve_rosetta_attr(_resolve_rosetta_attr(self, "productTaxonomy"), "source")) is not None) and ((_resolve_rosetta_attr(_resolve_rosetta_attr(self, "productTaxonomy"), "value")) is not None))
    
    def _else_fn0():
      return True
    
    return if_cond_fn(((_resolve_rosetta_attr(self, "productTaxonomy")) is not None), _then_fn0, _else_fn0)

from cdm.base.staticdata.asset.common.CommodityProductDefinition import CommodityProductDefinition
from cdm.observable.asset.QuotationSideEnum import QuotationSideEnum
from cdm.base.staticdata.asset.common.DeliveryDateParameters import DeliveryDateParameters

Commodity.update_forward_refs()