org.views.form_submission
=========================

.. py:module:: org.views.form_submission

.. autoapi-nested-parse::

   Renders and handles defined forms, turning them into submissions. 



Functions
---------

.. autoapisummary::

   org.views.form_submission.copy_query
   org.views.form_submission.get_price
   org.views.form_submission.handle_pending_submission
   org.views.form_submission.handle_edit_submission_from_ticket
   org.views.form_submission.handle_complete_submission
   org.views.form_submission.view_submission_ticket
   org.views.form_submission.handle_accept_registration
   org.views.form_submission.handle_accept_registration_from_ticket
   org.views.form_submission.handle_deny_registration
   org.views.form_submission.handle_deny_registration_from_ticket
   org.views.form_submission.handle_cancel_registration
   org.views.form_submission.handle_cancel_registration_from_ticket
   org.views.form_submission.handle_submission_action
   org.views.form_submission.handle_survey_submission


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

.. py:function:: copy_query(request: onegov.org.request.OrgRequest, url: str, fields: collections.abc.Iterable[str]) -> str

.. py:function:: get_price(request: onegov.org.request.OrgRequest, form: onegov.form.Form, submission: onegov.form.FormSubmission) -> onegov.pay.Price | None

.. py:function:: handle_pending_submission(self: onegov.form.FormSubmission, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.FormSubmissionLayout | onegov.org.layout.TicketLayout | None = None, ticket: onegov.ticket.Ticket | None = None) -> onegov.core.types.RenderData | webob.Response

   Renders a pending submission, takes it's input and allows the
   user to turn the submission into a complete submission, once all data
   is valid.

   This view has two states, a completable state where the form values
   are displayed without a form and an edit state, where a form is rendered
   to change the values.

   Takes the following query parameters for customization::

       * ``edit`` render the view in the edit state
       * ``return-to`` the view redirects to this url once complete
       * ``title`` a custom title (required if external submission)
       * ``quiet`` no success messages are rendered if present



.. py:function:: handle_edit_submission_from_ticket(self: onegov.org.models.ticket.DirectoryEntryTicket | onegov.org.models.ticket.FormSubmissionTicket | onegov.org.models.ticket.ReservationTicket, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.TicketLayout | None = None) -> onegov.core.types.RenderData | webob.Response

.. py:function:: handle_complete_submission(self: onegov.form.FormSubmission, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: view_submission_ticket(self: onegov.form.CompleteFormSubmission, request: onegov.org.request.OrgRequest) -> webob.Response

.. py:function:: handle_accept_registration(self: onegov.form.CompleteFormSubmission, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_accept_registration_from_ticket(self: onegov.org.models.ticket.FormSubmissionTicket, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_deny_registration(self: onegov.form.CompleteFormSubmission, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_deny_registration_from_ticket(self: onegov.org.models.ticket.FormSubmissionTicket, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_cancel_registration(self: onegov.form.CompleteFormSubmission, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_cancel_registration_from_ticket(self: onegov.org.models.ticket.FormSubmissionTicket, request: onegov.org.request.OrgRequest) -> webob.Response | None

.. py:function:: handle_submission_action(self: onegov.form.CompleteFormSubmission, request: onegov.org.request.OrgRequest, action: Literal['confirmed', 'denied', 'cancelled'], ignore_csrf: bool = False, raises: bool = False, no_messages: bool = False, force_email: bool = False, return_url: str | None = None) -> webob.Response | None

.. py:function:: handle_survey_submission(self: onegov.form.models.submission.SurveySubmission, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.SurveySubmissionLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Renders a pending submission, takes it's input and allows the
   user to turn the submission into a complete submission, once all data
   is valid.