directory.models.directory

Module Contents

Classes

_Sentinel

Generic enumeration.

DirectoryFile

A general file (image, document, pdf, etc), referenced in the database.

Directory

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

Attributes

InheritType

INHERIT

directory.models.directory.InheritType: typing_extensions.TypeAlias = 'Literal[_Sentinel.INHERIT]'[source]
class directory.models.directory._Sentinel[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

INHERIT[source]
directory.models.directory.INHERIT[source]
class directory.models.directory.DirectoryFile[source]

Bases: 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.

property directory_entry: DirectoryEntry | None[source]
property access: str[source]
__mapper_args__[source]
class directory.models.directory.Directory[source]

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.search.SearchableContent, onegov.file.MultiAssociatedFiles

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

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 entry_cls_name: str[source]
property entry_cls: _type[DirectoryEntry][source]
property fields: Sequence[ParsedField][source]
property basic_fields: Sequence[BasicParsedField][source]
property file_fields: Sequence[FileParsedField][source]
property form_obj: DirectoryEntryForm[source]
property form_class: _type[DirectoryEntryForm][source]
__tablename__ = 'directories'[source]
es_properties[source]
id: Column[uuid.UUID][source]
name: Column[str][source]
title: Column[str][source]
lead: Column[str | None][source]
order: Column[str][source]
type: Column[str][source]
structure: Column[str][source]
configuration: Column[DirectoryConfiguration][source]
__mapper_args__[source]
entries: relationship[list[DirectoryEntry]][source]
count() → ColumnElement[int][source]
add(values: dict[str, Any], type: str | InheritType = INHERIT) → directory.models.directory_entry.DirectoryEntry[source]
add_by_form(form: DirectoryEntryForm, type: str | InheritType = INHERIT) → directory.models.directory_entry.DirectoryEntry[source]
update(entry: directory.models.directory_entry.DirectoryEntry, values: Mapping[str, Any], set_name: bool = False, force_update: bool = False) → directory.models.directory_entry.DirectoryEntry[source]
title_observer(title: str) → None[source]
structure_configuration_observer(structure: str, configuration: directory.types.DirectoryConfiguration) → None[source]
entry_with_name_exists(name: str) → bool[source]
migration(new_structure: str, new_configuration: directory.types.DirectoryConfiguration) → onegov.directory.migration.DirectoryMigration[source]
static fields_from_structure(structure: str) → Sequence[ParsedField][source]
field_by_id(id: str) → ParsedField | None[source]
form_obj_from_structure(structure: str) → DirectoryEntryForm[source]
form_class_from_structure(structure: str) → _type[DirectoryEntryForm][source]