landsgemeinde.models.votum
==========================

.. py:module:: landsgemeinde.models.votum


Attributes
----------

.. autoapisummary::

   landsgemeinde.models.votum.VotumState
   landsgemeinde.models.votum.STATES


Classes
-------

.. autoapisummary::

   landsgemeinde.models.votum.Votum


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

.. py:type:: VotumState
   :canonical: Literal['draft', 'scheduled', 'ongoing', 'completed']


.. py:data:: STATES
   :type:  dict[VotumState, translationstring.TranslationString]

.. py:class:: Votum

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.file.AssociatedFiles`, :py:obj:`onegov.search.ORMSearchable`, :py:obj:`onegov.landsgemeinde.models.mixins.TimestampedVideoMixin`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __tablename__
      :value: 'landsgemeinde_vota'



   .. 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:property:: fts_suggestion
      :type: tuple[str, Ellipsis]


      Returns suggest-as-you-type value of the document.
      The field used for this property should also be indexed, or the
      suggestion will lead to nowhere.

      If a single string is returned, the completion input equals the
      completion output. (My Title -> My Title)

      If an array of strings is returned, all values are possible inputs and
      the first value is the output. (My Title/Title My -> My Title)




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


   .. py:attribute:: state
      :type:  sqlalchemy.Column[VotumState]


   .. py:attribute:: number
      :type:  sqlalchemy.Column[int]


   .. py:attribute:: text


   .. py:attribute:: motion


   .. py:attribute:: statement_of_reasons


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


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


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


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


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


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


   .. py:attribute:: agenda_item
      :type:  sqlalchemy.orm.relationship[onegov.landsgemeinde.models.AgendaItem]


   .. py:property:: date
      :type: datetime.date



   .. py:property:: agenda_item_number
      :type: int



   .. py:property:: assembly
      :type: onegov.landsgemeinde.models.Assembly



   .. py:property:: person_details
      :type: str