activity.collections.occasion
=============================

.. py:module:: activity.collections.occasion


Classes
-------

.. autoapisummary::

   activity.collections.occasion.OccasionCollection


Module Contents
---------------

.. py:class:: OccasionCollection(session: sqlalchemy.orm.Session, **kwargs: Any)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.activity.models.Occasion`\ ]


   Abstract base class for generic types.

   A generic type is typically declared by inheriting from
   this class parameterized with one or more type variables.
   For example, a generic mapping type might be defined as::

     class Mapping(Generic[KT, VT]):
         def __getitem__(self, key: KT) -> VT:
             ...
         # Etc.

   This class can then be used as follows::

     def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
         try:
             return mapping[key]
         except KeyError:
             return default


   .. py:property:: model_class
      :type: type[onegov.activity.models.Occasion]



   .. py:method:: to_half_open_interval(lower: int, upper: int) -> onegov.activity.types.BoundedIntegerRange
      :staticmethod:


      Postgres coerces ranges internally to be half-open in an effort
      to canonize these ranges. This function does the same by taking
      a closed interval and turning it into a half-open interval of
      the NumericRange type.




   .. py:method:: add(activity: onegov.activity.models.Activity, period: onegov.activity.models.Period, start: datetime.datetime, end: datetime.datetime, timezone: str, meeting_point: str | None = None, age: collections.abc.Sequence[int] | None = None, spots: collections.abc.Sequence[int] | None = None, note: str | None = None, cost: decimal.Decimal = Decimal(0), exclude_from_overlap_check: bool = False) -> onegov.activity.models.Occasion


   .. py:method:: add_date(occasion: onegov.activity.models.Occasion, start: datetime.datetime, end: datetime.datetime, timezone: str) -> onegov.activity.models.OccasionDate


   .. py:method:: find_date(occasion: onegov.activity.models.Occasion, start: datetime.datetime, end: datetime.datetime, timezone: str) -> onegov.activity.models.OccasionDate | None


   .. py:method:: remove_date(date: onegov.activity.models.OccasionDate) -> None


   .. py:method:: clear_dates(occasion: onegov.activity.models.Occasion) -> None