src.cdm.base.datetime.Period.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.89

# 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__ = ['Period']


class Period(BaseDataClass):
  """
  A class to define recurring periods or time offsets.
  """
  periodMultiplier: int = Field(..., description="A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can be used when specifying an offset relative to another date, e.g. -2 days.")
  """
  A time period multiplier, e.g. 1, 2 or 3 etc. A negative value can be used when specifying an offset relative to another date, e.g. -2 days.
  """
  period: PeriodEnum = Field(..., description="A time period, e.g. a day, week, month or year of the stream. If the periodMultiplier value is 0 (zero) then period must contain the value D (day).")
  """
  A time period, e.g. a day, week, month or year of the stream. If the periodMultiplier value is 0 (zero) then period must contain the value D (day).
  """
  
  @rosetta_condition
  def condition_0_DayPeriod(self):
    """
    FpML specifies that if the periodMultiplier value is 0 (zero) then period must contain the value D (day).
    """
    def _then_fn0():
      return all_elements(_resolve_rosetta_attr(self, "period"), "=", _resolve_rosetta_attr(PeriodEnum, "D"))
    
    def _else_fn0():
      return True
    
    return if_cond_fn(all_elements(_resolve_rosetta_attr(self, "periodMultiplier"), "=", 0), _then_fn0, _else_fn0)

from cdm.base.datetime.PeriodEnum import PeriodEnum

Period.update_forward_refs()