form.models.registration_window

Module Contents

Classes

FormRegistrationWindow

Defines a registration window during which a form definition

Attributes

daterange

form.models.registration_window.daterange

class form.models.registration_window.FormRegistrationWindow

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.TimestampMixin

Defines a registration window during which a form definition may be used to create submissions.

Submissions created thusly are attached to the currently active registration window.

Registration windows may not overlap.

property localized_start: datetime.datetime

property localized_end: datetime.datetime

property available_spots: int

property claimed_spots: int

Returns the number of actually claimed spots.

property requested_spots: int

Returns the number of requested spots.

When the claim has not been made yet, spots are counted as requested. When the claim has been partially made, the difference is counted as requested. If the claim has been fully made, the result is 0. If the claim has been relinquished, the result is 0.

property next_submission: onegov.form.models.submission.FormSubmission | None

Returns the submission next in line. In other words, the next submission in order of first come, first serve.

property in_the_future: bool

property in_the_past: bool

property in_the_present: bool

__tablename__ = 'registration_windows'

id: Column[uuid.UUID]

name: Column[str]

enabled: Column[bool]

start: Column[date]

end: Column[date]

timezone: Column[str]

limit: Column[int | None]

overflow: Column[bool]

submissions: relationship[list[FormSubmission]]

__table_args__ = ()

accepts_submissions(required_spots: int = 1) → bool

disassociate() → None

Disassociates all records linked to this window.