form.models.definition
======================

.. py:module:: form.models.definition


Classes
-------

.. autoapisummary::

   form.models.definition.FormDefinition
   form.models.definition.SurveyDefinition


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

.. py:class:: FormDefinition

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.form.extensions.Extendable`, :py:obj:`onegov.file.MultiAssociatedFiles`


   Defines a form stored in the database. 


   .. py:attribute:: __tablename__
      :value: 'forms'



   .. py:method:: id() -> str


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


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


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


   .. py:attribute:: pick_up
      :type:  onegov.core.orm.mixins.dict_property[str | None]


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


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


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


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


   .. py:attribute:: submissions
      :type:  sqlalchemy.orm.relationship[list[onegov.form.models.submission.FormSubmission]]


   .. py:attribute:: registration_windows
      :type:  sqlalchemy.orm.relationship[list[onegov.form.models.registration_window.FormRegistrationWindow]]


   .. py:attribute:: current_registration_window
      :type:  sqlalchemy.orm.relationship[onegov.form.models.registration_window.FormRegistrationWindow | None]


   .. py:attribute:: lead
      :type:  onegov.core.orm.mixins.dict_property[str | None]


   .. py:attribute:: text


   .. py:attribute:: extensions
      :type:  onegov.core.orm.mixins.dict_property[list[str]]


   .. py:attribute:: payment_method
      :type:  sqlalchemy.Column[onegov.pay.types.PaymentMethod]


   .. py:attribute:: minimum_price_total
      :type:  onegov.core.orm.mixins.dict_property[float | None]


   .. py:attribute:: __mapper_args__


   .. py:property:: form_class
      :type: type[onegov.form.Form]


      Parses the form definition and returns a form class. 



   .. py:method:: definition_observer(definition: str) -> None


   .. py:method:: title_observer(title: str) -> None


   .. py:method:: has_submissions(with_state: onegov.form.types.SubmissionState | None = None) -> bool


   .. py:method:: add_registration_window(start: datetime.date, end: datetime.date, *, enabled: bool = True, timezone: str = 'Europe/Zurich', limit: int | None = None, overflow: bool = True) -> onegov.form.models.registration_window.FormRegistrationWindow


   .. py:method:: for_new_name(name: str) -> Self


.. py:class:: SurveyDefinition

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.form.extensions.Extendable`


   Defines a survey stored in the database. 


   .. py:attribute:: __tablename__
      :value: 'surveys'



   .. py:method:: id() -> str


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


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


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


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


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


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


   .. py:attribute:: submissions
      :type:  sqlalchemy.orm.relationship[list[onegov.form.models.submission.SurveySubmission]]


   .. py:attribute:: submission_windows
      :type:  sqlalchemy.orm.relationship[list[onegov.form.models.survey_window.SurveySubmissionWindow]]


   .. py:attribute:: current_submission_window
      :type:  sqlalchemy.orm.relationship[onegov.form.models.survey_window.SurveySubmissionWindow | None]


   .. py:attribute:: lead
      :type:  onegov.core.orm.mixins.dict_property[str | None]


   .. py:attribute:: text


   .. py:attribute:: extensions
      :type:  onegov.core.orm.mixins.dict_property[list[str]]


   .. py:property:: form_class
      :type: type[onegov.form.Form]


      Parses the survey definition and returns a form class. 



   .. py:method:: definition_observer(definition: str) -> None


   .. py:method:: title_observer(title: str) -> None


   .. py:method:: has_submissions() -> bool


   .. py:method:: add_submission_window(start: datetime.date, end: datetime.date, *, enabled: bool = True, timezone: str = 'Europe/Zurich') -> onegov.form.models.survey_window.SurveySubmissionWindow


   .. py:method:: get_results(request: onegov.core.request.CoreRequest, sw_id: uuid.UUID | None = None) -> dict[str, Any]

      Returns the results of the survey.