fsi.models.course_event

Attributes

EventStatusType
COURSE_EVENT_STATUSES
COURSE_EVENT_STATUSES_TRANSLATIONS

Classes

CourseEvent

Mixin providing created/modified timestamps for all records.

Functions

course_status_choices(…)

Module Contents

type fsi.models.course_event.EventStatusType = Literal['created', 'confirmed', 'canceled', 'planned']

fsi.models.course_event.COURSE_EVENT_STATUSES: tuple[EventStatusType, Ellipsis] = ('created', 'confirmed', 'canceled', 'planned')

fsi.models.course_event.COURSE_EVENT_STATUSES_TRANSLATIONS

fsi.models.course_event.course_status_choices(request: onegov.fsi.request.FsiRequest | None = None, as_dict: Literal[False] = False) → list[wtforms.fields.choices._Choice]

fsi.models.course_event.course_status_choices(request: onegov.fsi.request.FsiRequest | None, as_dict: Literal[True]) → list[dict[str, str]]

fsi.models.course_event.course_status_choices(request: onegov.fsi.request.FsiRequest | None = None, *, as_dict: Literal[True]) → list[dict[str, str]]

class fsi.models.course_event.CourseEvent

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

Mixin providing created/modified timestamps for all records.

The columns are deferred loaded as this is primarily for logging and future forensics.

default_reminder_before

__tablename__ = 'fsi_course_events'

es_properties

id: sqlalchemy.Column[uuid.UUID]

course_id: sqlalchemy.Column[uuid.UUID]

course: sqlalchemy.orm.relationship[fsi.models.course.Course]

property es_public: bool

Returns True if the model is available to be found by the public. If false, only editors/admins will see this object in the search results.

property title: str

property name: str

property lead: str

property description: markupsafe.Markup

__str__() → str

property localized_start: datetime.datetime

property localized_end: datetime.datetime

location: sqlalchemy.Column[str]

start: sqlalchemy.Column[datetime.datetime]

end: sqlalchemy.Column[datetime.datetime]

presenter_name: sqlalchemy.Column[str]

presenter_company: sqlalchemy.Column[str]

presenter_email: sqlalchemy.Column[str | None]

min_attendees: sqlalchemy.Column[int]

max_attendees: sqlalchemy.Column[int | None]

status: sqlalchemy.Column[EventStatusType]

attendees: sqlalchemy.orm.relationship[onegov.core.types.AppenderQuery[onegov.fsi.models.course_attendee.CourseAttendee]]

subscriptions: sqlalchemy.orm.relationship[onegov.core.types.AppenderQuery[onegov.fsi.models.course_subscription.CourseSubscription]]

notification_templates: sqlalchemy.orm.relationship[list[fsi.models.course_notification_template.CourseNotificationTemplate]]

info_template: sqlalchemy.orm.relationship[fsi.models.course_notification_template.InfoTemplate]

reservation_template: sqlalchemy.orm.relationship[fsi.models.course_notification_template.SubscriptionTemplate]

cancellation_template: sqlalchemy.orm.relationship[fsi.models.course_notification_template.CancellationTemplate]

reminder_template: sqlalchemy.orm.relationship[fsi.models.course_notification_template.ReminderTemplate]

hidden_from_public: sqlalchemy.Column[bool]

locked_for_subscriptions: sqlalchemy.Column[bool | None]

schedule_reminder_before: sqlalchemy.Column[datetime.timedelta]

property description_html: markupsafe.Markup

Returns the portrait that is saved as HTML from the redactor js plugin.

scheduled_reminder() → datetime.datetime

next_event_start() → datetime.datetime

property duration: datetime.timedelta

property hidden: bool

property cached_reservation_count: int

property available_seats: int | None

property booked: bool

property bookable: bool

property is_past: bool

property locked: bool

property duplicate_dict: dict[str, Any]

property duplicate: Self

has_reservation(attendee_id: uuid.UUID) → bool

excluded_subscribers(year: int | None = None, as_uids: Literal[True] = True, exclude_inactive: bool = True) → sqlalchemy.orm.Query[tuple[uuid.UUID]]

excluded_subscribers(year: int | None, as_uids: Literal[False], exclude_inactive: bool = True) → sqlalchemy.orm.Query[onegov.fsi.models.course_attendee.CourseAttendee]

excluded_subscribers(year: int | None = None, *, as_uids: Literal[False], exclude_inactive: bool = True) → sqlalchemy.orm.Query[onegov.fsi.models.course_attendee.CourseAttendee]

excluded_subscribers(year: int | None, as_uids: bool, exclude_inactive: bool = True) → sqlalchemy.orm.Query[tuple[uuid.UUID]] | sqlalchemy.orm.Query[onegov.fsi.models.course_attendee.CourseAttendee]

Returns a list of attendees / names tuple of UIDS of attendees that have booked one of the events of a course in the given year.

possible_subscribers(external_only: bool = False, year: int | None = None, as_uids: Literal[False] = False, exclude_inactive: bool = True, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None) → sqlalchemy.orm.Query[onegov.fsi.models.course_attendee.CourseAttendee]

possible_subscribers(external_only: bool, year: int | None, as_uids: Literal[True], exclude_inactive: bool = True, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None) → sqlalchemy.orm.Query[tuple[uuid.UUID]]

possible_subscribers(external_only: bool = False, year: int | None = None, *, as_uids: Literal[True], exclude_inactive: bool = True, auth_attendee: onegov.fsi.models.course_attendee.CourseAttendee | None = None) → sqlalchemy.orm.Query[tuple[uuid.UUID]]

Returns the list of possible bookers. Attendees that already have a subscription for the parent course in the same year are excluded.

property email_recipients: collections.abc.Iterator[str]

as_ical(event_url: str | None = None) → bytes

as_ical_attachment(url: str | None = None) → onegov.core.mail.Attachment

can_book(attendee_or_id: onegov.fsi.models.course_attendee.CourseAttendee | uuid.UUID | str, year: int | None = None) → bool

exceeds_six_year_limit(attendee_id: str | onegov.core.orm.types.UUID, request: onegov.fsi.request.FsiRequest) → bool