fsi.models.course
=================

.. py:module:: fsi.models.course


Classes
-------

.. autoapisummary::

   fsi.models.course.Course


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

.. py:class:: Course

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.search.ORMSearchable`


   Extends the default :class:`Searchable` class with sensible defaults
   for SQLAlchemy orm models.



   .. py:attribute:: __tablename__
      :value: 'fsi_courses'



   .. py:attribute:: fts_public
      :value: True


      Returns True if the model is available to be found by the public.
      If false, only editors/admins will see this object in the search
      results.




   .. py:attribute:: fts_properties


   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: name
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: description
      :type:  sqlalchemy.Column[markupsafe.Markup]


   .. py:attribute:: refresh_interval
      :type:  sqlalchemy.Column[int | None]


   .. py:attribute:: mandatory_refresh
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: hidden_from_public
      :type:  sqlalchemy.Column[bool]


   .. py:attribute:: evaluation_url
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: events
      :type:  sqlalchemy.orm.relationship[onegov.core.types.AppenderQuery[fsi.models.course_event.CourseEvent]]


   .. py:property:: title
      :type: str



   .. py:property:: lead
      :type: str



   .. py:property:: description_html
      :type: markupsafe.Markup


      Returns the description that is saved as HTML from the redactor js
      plugin.



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