fsi.collections.course_event
============================

.. py:module:: fsi.collections.course_event


Classes
-------

.. autoapisummary::

   fsi.collections.course_event.CourseEventCollection
   fsi.collections.course_event.PastCourseEventCollection


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

.. py:class:: CourseEventCollection(session: sqlalchemy.orm.Session, page: int = 0, from_date: datetime.datetime | None = None, upcoming_only: bool = False, past_only: bool = False, limit: int | None = None, show_hidden: bool = False, show_locked: bool = True, course_id: uuid.UUID | None = None, sort_desc: bool = False)

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


   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: 10



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



   .. py:attribute:: from_date
      :value: None



   .. py:attribute:: upcoming_only
      :value: False



   .. py:attribute:: past_only
      :value: False



   .. py:attribute:: limit
      :value: None



   .. py:attribute:: show_hidden
      :value: False



   .. py:attribute:: show_locked
      :value: True



   .. py:attribute:: course_id
      :value: None



   .. py:attribute:: sort_desc
      :value: False



   .. 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_event.CourseEvent]



   .. py:property:: course
      :type: onegov.fsi.models.course.Course | None



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


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

      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.




   .. py:method:: latest(session: sqlalchemy.orm.Session, limit: int = 5) -> Self
      :classmethod:



   .. py:method:: next_event() -> sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]


   .. py:method:: get_past_reminder_date() -> sqlalchemy.orm.Query[onegov.fsi.models.course_event.CourseEvent]


   .. py:method:: add(**kwargs: Any) -> onegov.fsi.models.course_event.CourseEvent


.. py:class:: PastCourseEventCollection(session: sqlalchemy.orm.Session, page: int = 0, show_hidden: bool = False, show_locked: bool = True, course_id: uuid.UUID | None = None)

   Bases: :py:obj:`CourseEventCollection`


   This is used for past events to do the audit 


   .. 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.




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