org.forms.survey_submission
===========================

.. py:module:: org.forms.survey_submission


Classes
-------

.. autoapisummary::

   org.forms.survey_submission.SurveySubmissionWindowForm


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

.. py:class:: SurveySubmissionWindowForm(formdata: webob.multidict.MultiDict[str, Any] | None = None, obj: object | None = None, prefix: str = '', data: dict[str, Any] | None = None, meta: dict[str, Any] | None = None, *, extra_filters: collections.abc.Mapping[str, collections.abc.Sequence[Any]] | None = None, **kwargs: Any)

   Bases: :py:obj:`onegov.form.Form`


   Form to edit submission windows. 


   .. py:attribute:: model
      :type:  onegov.form.SurveyDefinition | onegov.form.SurveySubmissionWindow


   .. py:attribute:: title


   .. py:attribute:: start


   .. py:attribute:: end


   .. py:method:: process_obj(obj: onegov.form.SurveySubmissionWindow) -> None

      Called by :meth:`process` if an object was passed.

      Do *not* use this function directly. To process an object, you should
      call ``form.process(obj=obj)`` instead.




   .. py:method:: populate_obj(obj: onegov.form.SurveySubmissionWindow, *args: Any, **kwargs: Any) -> None

      A reimplementation of wtforms populate_obj function with the addage
      of optional include/exclude filters.

      If neither exclude nor include is passed, the function works like it
      does in wtforms. Otherwise fields are considered which are included
      but not excluded.




   .. py:method:: ensure_start_before_end() -> bool | None

      Validate start and end for proper error message.
      def ensure_start_end(self) would also be run in side the validate
      function, but the error is not clear. 



   .. py:method:: ensure_unique_title() -> bool | None

      Ensure that the title is unique within the survey. 



   .. py:method:: ensure_no_overlapping_windows() -> bool | None

      Ensure that this registration window does not overlap with other
      already defined registration windows unless they have a title.