fsi.collections.subscription
============================

.. py:module:: fsi.collections.subscription


Classes
-------

.. autoapisummary::

   fsi.collections.subscription.SubscriptionsCollection


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

.. py:class:: SubscriptionsCollection(session: sqlalchemy.orm.Session, attendee_id: uuid.UUID | None = None, course_event_id: uuid.UUID | None = None, external_only: bool = False, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None, page: int = 0)

   Bases: :py:obj:`onegov.core.collection.GenericCollection`\ [\ :py:obj:`onegov.fsi.models.course_subscription.CourseSubscription`\ ], :py:obj:`onegov.core.collection.Pagination`\ [\ :py:obj:`onegov.fsi.models.course_subscription.CourseSubscription`\ ]


   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:attribute:: batch_size
      :value: 30



   .. py:attribute:: attendee_id
      :value: None



   .. py:attribute:: page
      :value: 0



   .. py:attribute:: course_event_id
      :value: None



   .. py:attribute:: external_only
      :value: False



   .. py:attribute:: auth_attendee
      :value: None



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

      Returns True if the current and the other Pagination instance
      are equal. Used to find the current page in a list of pages.




   .. py:property:: model_class
      :type: type[onegov.fsi.models.course_subscription.CourseSubscription]



   .. py:property:: course_event
      :type: onegov.fsi.models.course_event.CourseEvent | None



   .. py:property:: attendee
      :type: onegov.fsi.models.course_attendee.CourseAttendee | None



   .. py:property:: attendee_collection
      :type: onegov.fsi.collections.attendee.CourseAttendeeCollection



   .. py:property:: for_himself
      :type: bool



   .. py:method:: query() -> sqlalchemy.orm.Query[onegov.fsi.models.course_subscription.CourseSubscription]


   .. py:method:: by_id(id: uuid.UUID) -> onegov.fsi.models.course_subscription.CourseSubscription | None


   .. py:method:: subset() -> sqlalchemy.orm.Query[onegov.fsi.models.course_subscription.CourseSubscription]

      Returns an SQLAlchemy query containing all records that should
      be considered for pagination.




   .. py:property:: page_index
      :type: int


      Returns the current page index (starting at 0). 



   .. py:method:: page_by_index(index: int) -> Self

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.