org.models.political_business
Attributes
Classes
Extends any class that has a meta dictionary field with the ability to |
|
A participant of a political business, e.g. a parliamentarian. |
|
Abstract base class for generic types. |
|
Abstract base class for generic types. |
Module Contents
- type org.models.political_business.PoliticalBusinessType = Literal['inquiry', 'proposal', 'mandate', 'report', 'report and proposal', 'decision', 'message', 'urgent interpellation', 'invitation', 'interpelleation', 'interpellation', 'commission report', 'communication', 'motion', 'postulate', 'resolution', 'regulation', 'miscellaneous', 'elections'][source]
- org.models.political_business.POLITICAL_BUSINESS_STATUS: dict[PoliticalBusinessStatus, str][source]
- class org.models.political_business.PoliticalBusiness[source]
Bases:
onegov.org.models.extensions.AccessExtension
,onegov.file.MultiAssociatedFiles
,onegov.core.orm.Base
,onegov.core.orm.mixins.ContentMixin
,onegov.org.models.extensions.GeneralFileLinkExtension
,onegov.search.ORMSearchable
Extends any class that has a meta dictionary field with the ability to set one of the following access levels:
‘public’ - The default, the model is listed and accessible.
- ‘private’ - Neither listed nor accessible, except administrators
and editors.
- ‘member’ - Neither listed nor accessible except administrators, editors
and members.
‘secret’ - Not listed, but available for anyone that knows the URL.
- ‘mtan’ - The model is listed but only accessible once an mTAN has been
sent to the person and entered correctly.
- ‘secret_mtan’ - Not listed and only accessible once an mTAN has been
sent to the person and entered correctly.
see
onegov.core.security.rules.has_permission_not_logged_in()
- es_public = True[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.
- es_properties[source]
Returns the type mapping of this model. Each property in the mapping will be read from the model instance.
The returned object needs to be a dict or an object that provides a
to_dict
method.Internally, onegov.search stores differing languages in different indices. It does this automatically through langauge detection, or by manually specifying a language.
Note that objects with multiple languages are not supported (each object is supposed to have exactly one language).
Onegov.search will automatically insert the right analyzer for types like these.
There’s currently only limited support for properties here, namely objects and nested mappings do not work! This is going to be added in the future though.
- property es_suggestion: str[source]
Returns suggest-as-you-type value of the document. The field used for this property should also be indexed, or the suggestion will lead to nowhere.
If a single string is returned, the completion input equals the completion output. (My Title -> My Title)
If an array of strings is returned, all values are possible inputs and the first value is the output. (My Title/Title My -> My Title)
- participants: sqlalchemy.orm.relationship[list[PoliticalBusinessParticipation]][source]
- class org.models.political_business.PoliticalBusinessParticipation[source]
Bases:
onegov.core.orm.Base
,onegov.core.orm.mixins.ContentMixin
A participant of a political business, e.g. a parliamentarian.
- political_business: sqlalchemy.orm.relationship[PoliticalBusiness][source]
- class org.models.political_business.PoliticalBusinessCollection(session: sqlalchemy.orm.Session, page: int = 0)[source]
Bases:
onegov.core.collection.GenericCollection
[PoliticalBusiness
],onegov.core.collection.Pagination
[PoliticalBusiness
]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
- property model_class: type[PoliticalBusiness][source]
- __eq__(other: object) bool [source]
Returns True if the current and the other Pagination instance are equal. Used to find the current page in a list of pages.
- query() sqlalchemy.orm.Query[PoliticalBusiness] [source]
- subset() sqlalchemy.orm.Query[PoliticalBusiness] [source]
Returns an SQLAlchemy query containing all records that should be considered for pagination.
- class org.models.political_business.PoliticalBusinessParticipationCollection(session: sqlalchemy.orm.Session, active: bool | None = None)[source]
Bases:
onegov.core.collection.GenericCollection
[PoliticalBusinessParticipation
]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
- property model_class: type[PoliticalBusinessParticipation][source]