org.models.directory

Module Contents

Classes

DirectorySubmissionAction

ExtendedDirectory

A directory of entries that share a common data structure. For example,

ExtendedDirectoryEntry

A single entry of a directory.

ExtendedDirectoryEntryCollection

Provides a view on a directory's entries.

Attributes

ExtendedDirectorySearchWidget

org.models.directory.ExtendedDirectorySearchWidget: typing_extensions.TypeAlias[source]
class org.models.directory.DirectorySubmissionAction(session: sqlalchemy.orm.Session, directory_id: uuid.UUID, action: str, submission_id: uuid.UUID)[source]
property valid: bool[source]
submission() → onegov.form.FormSubmission | None[source]
directory() → onegov.directory.Directory | None[source]
ticket() → onegov.ticket.Ticket | None[source]
send_mail_if_enabled(request: onegov.org.request.OrgRequest, subject: str, template: str) → None[source]
execute(request: onegov.org.request.OrgRequest) → None[source]
adopt(request: onegov.org.request.OrgRequest) → None[source]
create_new_entry(request: onegov.org.request.OrgRequest, data: dict[str, Any]) → onegov.directory.DirectoryEntry[source]
apply_change_request(request: onegov.org.request.OrgRequest, data: dict[str, Any]) → onegov.directory.DirectoryEntry[source]
reject(request: onegov.org.request.OrgRequest) → None[source]
class org.models.directory.ExtendedDirectory[source]

Bases: onegov.directory.Directory, onegov.org.models.extensions.AccessExtension, onegov.form.Extendable, onegov.org.models.extensions.GeneralFileLinkExtension

A directory of entries that share a common data structure. For example, a directory of people, of emergency services or playgrounds.

property entry_cls_name: str[source]
property es_public: bool[source]

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 extensions: tuple[str, Ellipsis][source]
property actual_price: onegov.pay.Price | None[source]
__mapper_args__[source]
es_type_name = 'extended_directories'[source]
enable_map: onegov.core.orm.mixins.dict_property[str | None][source]
enable_submissions: onegov.core.orm.mixins.dict_property[bool | None][source]
enable_change_requests: onegov.core.orm.mixins.dict_property[bool | None][source]
enable_publication: onegov.core.orm.mixins.dict_property[bool | None][source]
required_publication: onegov.core.orm.mixins.dict_property[bool | None][source]
submitter_meta_fields: onegov.core.orm.mixins.dict_property[list[str] | None][source]
submissions_guideline: onegov.core.orm.mixins.dict_property[str | None][source]
change_requests_guideline: onegov.core.orm.mixins.dict_property[str | None][source]
text: onegov.core.orm.mixins.dict_property[str | None][source]
title_further_information: onegov.core.orm.mixins.dict_property[str | None][source]
position: onegov.core.orm.mixins.dict_property[str][source]
price: onegov.core.orm.mixins.dict_property[Literal[free, paid] | None][source]
price_per_submission: onegov.core.orm.mixins.dict_property[float | None][source]
currency: onegov.core.orm.mixins.dict_property[str | None][source]
minimum_price_total: onegov.core.orm.mixins.dict_property[float | None][source]
payment_method: onegov.core.orm.mixins.dict_property[PaymentMethod | None][source]
search_widget_config: onegov.core.orm.mixins.dict_property[dict[str, Any] | None][source]
search_widget_config[source]
marker_icon: onegov.core.orm.mixins.dict_property[str | None][source]
marker_color: onegov.core.orm.mixins.dict_property[str | None][source]
overview_two_columns: onegov.core.orm.mixins.dict_property[bool | None][source]
numbering: onegov.core.orm.mixins.dict_property[str | None][source]
numbers: onegov.core.orm.mixins.dict_property[str | None][source]
form_class_for_submissions(change_request: bool = False) → type[ExtendedDirectoryEntryForm][source]

Generates the form_class used for user submissions and change requests. The resulting form always includes a submitter field and all fields. When doing a change request, removes input required validators from UploadFields.

submission_action(action: Literal[adopt, reject], submission_id: uuid.UUID) → DirectorySubmissionAction[source]
remove_old_pending_submissions() → None[source]
class org.models.directory.ExtendedDirectoryEntry[source]

Bases: onegov.directory.DirectoryEntry, onegov.org.models.extensions.PublicationExtension, onegov.org.models.extensions.CoordinatesExtension, onegov.org.models.extensions.AccessExtension, onegov.org.models.extensions.DeletableContentExtension

A single entry of a directory.

property es_public: bool[source]

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 display_config: dict[str, Any][source]
property contact: str | None[source]
property content_fields: tuple[wtforms.Field, Ellipsis] | None[source]
property hidden_label_fields: set[str][source]
__mapper_args__[source]
es_type_name = 'extended_directory_entries'[source]
internal_notes: onegov.core.orm.mixins.dict_property[str | None][source]
class org.models.directory.ExtendedDirectoryEntryCollection(directory: ExtendedDirectory, type: Literal[extended] = 'extended', keywords: Mapping[str, list[str]] | None = None, page: int = 0, search_widget: ExtendedDirectorySearchWidget | None = None, published_only: bool = False, past_only: bool = False, upcoming_only: bool = False)[source]

Bases: onegov.directory.DirectoryEntryCollection[ExtendedDirectoryEntry]

Provides a view on a directory’s entries.

The directory itself might be a natural place for lots of these methods to reside, but ultimately we want to avoid mixing the concerns of the directory model and this view-supporting collection.

query() → Query[ExtendedDirectoryEntry][source]