form.models.submission ====================== .. py:module:: form.models.submission Classes ------- .. autoapisummary:: form.models.submission.FormSubmission form.models.submission.SurveySubmission form.models.submission.PendingFormSubmission form.models.submission.CompleteFormSubmission form.models.submission.FormFile Module Contents --------------- .. py:class:: FormSubmission Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.pay.Payable`, :py:obj:`onegov.file.AssociatedFiles`, :py:obj:`onegov.form.extensions.Extendable` Defines a submitted form of any kind in the database. .. py:attribute:: __tablename__ :value: 'submissions' .. py:attribute:: id :type: sqlalchemy.Column[uuid.UUID] .. py:attribute:: name :type: sqlalchemy.Column[str | None] .. py:attribute:: form :type: sqlalchemy.orm.relationship[onegov.form.models.FormDefinition | None] .. py:attribute:: title :type: sqlalchemy.Column[str | None] .. py:attribute:: email :type: sqlalchemy.Column[str | None] .. py:attribute:: definition :type: sqlalchemy.Column[str] .. py:attribute:: received :type: sqlalchemy.Column[datetime.datetime | None] .. py:attribute:: checksum :type: sqlalchemy.Column[str] .. py:attribute:: meta :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: data :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: state :type: sqlalchemy.Column[onegov.form.types.SubmissionState] .. py:attribute:: spots :type: sqlalchemy.Column[int] .. py:attribute:: claimed :type: sqlalchemy.Column[int | None] .. py:attribute:: registration_window_id :type: sqlalchemy.Column[uuid.UUID | None] .. py:attribute:: registration_window :type: sqlalchemy.orm.relationship[onegov.form.models.FormRegistrationWindow | None] .. 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:: extensions :type: onegov.core.orm.mixins.dict_property[list[str]] .. py:attribute:: __table_args__ .. py:property:: form_class :type: type[onegov.form.Form] Parses the form definition and returns a form class. .. py:property:: form_obj :type: onegov.form.Form Returns a form instance containing the submission data. .. py:method:: get_email_field_data(form: onegov.form.Form | None = None) -> str | None .. py:method:: definition_observer(definition: str) -> None .. py:method:: state_observer(state: onegov.form.types.SubmissionState) -> None .. py:method:: update_title(form: onegov.form.Form) -> None .. py:attribute:: submitter_name :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: submitter_address :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: submitter_phone :type: onegov.core.orm.mixins.dict_property[str | None] .. py:attribute:: __mapper_args__ .. py:attribute:: registration_state :type: sqlalchemy.Column[onegov.form.types.RegistrationState | None] .. py:property:: payable_reference :type: str A string which identifies this payable in payment lists. Do not join any values here as it can lead to an explosion of executed queries! By default we use the table name plus a hash derived from the primary key values of the table. This ensures that we do not accidentally leak secrets. In practice, this reference should be customised for each payable. .. py:method:: process_payment(price: onegov.pay.Price | None, provider: onegov.pay.PaymentProvider[Any] | None = None, token: str | None = None) -> onegov.pay.Payment | onegov.pay.PaymentError | bool | None Takes a request, optionally with the provider and the token by the provider that can be used to charge the credit card and creates a payment record if necessary. Returns True or a payment object if the payment was processed successfully. That is, if there is a payment or if there is no payment required the method returns truthy. .. py:method:: claim(spots: int | None = None) -> bool Claimes the given number of spots (defaults to the requested number of spots). :return bool: Whether or not claiming spots is possible .. py:method:: disclaim(spots: int | None = None) -> None Disclaims the given number of spots (defaults to all spots that were claimed so far). .. py:class:: SurveySubmission Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`, :py:obj:`onegov.file.AssociatedFiles`, :py:obj:`onegov.form.extensions.Extendable` Defines a submitted survey of any kind in the database. .. py:attribute:: __tablename__ :value: 'survey_submissions' .. py:attribute:: id :type: sqlalchemy.Column[uuid.UUID] .. py:attribute:: name :type: sqlalchemy.Column[str | None] .. py:attribute:: survey :type: sqlalchemy.orm.relationship[onegov.form.models.SurveyDefinition | None] .. py:attribute:: definition :type: sqlalchemy.Column[str] .. py:attribute:: checksum :type: sqlalchemy.Column[str] .. py:attribute:: meta :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: data :type: sqlalchemy.Column[dict[str, Any]] .. py:attribute:: submission_window_id :type: sqlalchemy.Column[uuid.UUID | None] .. py:attribute:: submission_window :type: sqlalchemy.orm.relationship[onegov.form.models.SurveySubmissionWindow | None] .. py:attribute:: extensions :type: onegov.core.orm.mixins.dict_property[list[str]] .. py:property:: form_class :type: type[onegov.form.Form] Parses the form definition and returns a form class. .. py:property:: form_obj :type: onegov.form.Form Returns a form instance containing the submission data. .. py:method:: definition_observer(definition: str) -> None .. py:method:: update_title(survey: onegov.form.Form) -> None .. py:class:: PendingFormSubmission Bases: :py:obj:`FormSubmission` Defines a submitted form of any kind in the database. .. py:attribute:: __mapper_args__ .. py:class:: CompleteFormSubmission Bases: :py:obj:`FormSubmission` Defines a submitted form of any kind in the database. .. py:attribute:: __mapper_args__ .. py:class:: FormFile Bases: :py:obj:`onegov.file.File` A general file (image, document, pdf, etc), referenced in the database. Thanks to the use of `Depot `_ files can be seemingly stored in the database (with transaction guarantees), without actually storing it in the database. .. py:attribute:: __mapper_args__ .. py:property:: access :type: str