activity.matching.interfaces
============================

.. py:module:: activity.matching.interfaces


Classes
-------

.. autoapisummary::

   activity.matching.interfaces.MatchableOccasion
   activity.matching.interfaces.MatchableBooking


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

.. py:class:: MatchableOccasion

   Describes the interface required by the occasion class used by
   the algorithm.

   This allows us to untie our implementation from the database.



   .. py:property:: id
      :type: uuid.UUID

      :abstractmethod:


      The id of the occasion. 



   .. py:property:: max_spots
      :type: int

      :abstractmethod:


      The maximum number of available spots. 



   .. py:property:: exclude_from_overlap_check
      :type: bool

      :abstractmethod:


      True if bookings of this occasion are ignored during overlap
      checks.




   .. py:property:: anti_affinity_group
      :type: str

      :abstractmethod:


      Forces the occasion to not be accept an attendee that has an
      occasion of the same anti-affinity-group.

      Note that the anti-affinity-group is ignored if the occasion
      is excluded from overlap checks.

      See :meth:`exclude_from_overlap_check`.




.. py:class:: MatchableBooking

   Describes the interface required by the booking class used by
   the algorithm.

   This allows us to untie our implementation from the database.



   .. py:method:: __eq__(other: object) -> bool
      :abstractmethod:


      The class must be comparable to other classes. 



   .. py:method:: __hash__() -> int
      :abstractmethod:


      The class must be hashable. 



   .. py:property:: id
      :type: uuid.UUID

      :abstractmethod:


      The id of the booking. 



   .. py:property:: occasion_id
      :type: uuid.UUID

      :abstractmethod:


      Returns the id of the occasion this booking belongs to. 



   .. py:property:: attendee_id
      :type: uuid.UUID

      :abstractmethod:


      Returns the id of the attendee this booking belongs to. 



   .. py:property:: state
      :type: onegov.activity.models.booking.BookingState

      :abstractmethod:


      Returns the state of the booking, one of:

      * "open" (for unassigned bookings)
      * "accepted" (for already accepted bookings)
      * "blocked" (for bookings blocked by another accepted booking)




   .. py:property:: priority
      :type: int

      :abstractmethod:


      Returns the priority of the booking. The higher the priority
      the further up the wishlist.

      Bookings further up the wishlist are first passed to the occasions.
      All things being equal (i.e. the scores of the other bookings), this
      leads to a higher chance of placement.




   .. py:property:: dates
      :type: collections.abc.Sequence[onegov.activity.models.OccasionDate]

      :abstractmethod:


      Returns the dates of the booking. 



   .. py:property:: group_code
      :type: str | None

      :abstractmethod:


      A code holding groups together. Grouped bookings are preferred
      over other bookings (so that groups may stay together).