org.models.external_link

Classes

ExternalLink	An Object appearing in some other collection
ExternalLinkCollection	Abstract base class for generic types.

Module Contents

class org.models.external_link.ExternalLink

Bases: onegov.core.orm.Base, onegov.core.orm.mixins.ContentMixin, onegov.core.orm.mixins.TimestampMixin, onegov.org.models.AccessExtension, onegov.search.SearchableContent

An Object appearing in some other collection that features a lead and text but points to some external url.

__tablename__ = 'external_links'

fts_id = 'title'

The name of the id attribute (not the actual value!).

If you use this on an ORM model, be sure to use a primary key, all other properties are not available during deletion.

fts_properties

id: sqlalchemy.Column[uuid.UUID]

title: sqlalchemy.Column[str]

url: sqlalchemy.Column[str]

page_image: onegov.core.orm.mixins.dict_property[str | None]

member_of: sqlalchemy.Column[str | None]

group: sqlalchemy.Column[str | None]

order: sqlalchemy.Column[str]

lead: onegov.core.orm.mixins.dict_property[str | None]

title_observer(title: str) → None

class org.models.external_link.ExternalLinkCollection(session: sqlalchemy.orm.Session, member_of: str | None = None, group: str | None = None, type: str | None = None)

Bases: onegov.core.collection.GenericCollection[ExternalLink]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

supported_collections

member_of = None

group = None

type = None

static translatable_name(model_class: type[object]) → str

Most collections have a base model whose name can be guessed from the collection name.

form_choices() → tuple[tuple[str, str], Ellipsis]

classmethod collection_by_name() → dict[str, type[onegov.core.collection.GenericCollection[Any]]]

property model_class: type[ExternalLink]

classmethod target(external_link: ExternalLink) → type[onegov.core.collection.GenericCollection[Any]]

query() → sqlalchemy.orm.Query[ExternalLink]

classmethod for_model(session: sqlalchemy.orm.Session, model_class: type[onegov.form.FormCollection | onegov.reservation.ResourceCollection], **kwargs: Any) → Self

It would be better to use the tablename, but the collections do not always implement the property model_class.