notice.models
=============

.. py:module:: notice.models


Attributes
----------

.. autoapisummary::

   notice.models.NoticeState


Classes
-------

.. autoapisummary::

   notice.models.OfficialNotice


Module Contents
---------------

.. py:data:: NoticeState

.. py:class:: OfficialNotice

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Defines an official notice.

   The notice follows a typcical state transition: drafted by an editor ->
   submitted by and editor to a publisher -> accepted by a publisher ->
   published by the publisher. It may be alternatively rejected by a publisher
   when submitted.

   The notice typically has a title and a text, belongs to a user and a user
   group, appears in one ore more issues and belongs to one or more categories
   and organizations.

   You can set the date of the first issue besides setting the issues (to
   allow filtering by date for example).

   You can set the category and organization directly instead of using the
   HSTOREs (or use both).



   .. py:attribute:: __tablename__
      :value: 'official_notices'



   .. py:attribute:: type
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: __mapper_args__


   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: name
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: state
      :type:  sqlalchemy.Column[NoticeState]


   .. py:attribute:: title
      :type:  sqlalchemy.Column[str]


   .. py:attribute:: text
      :type:  sqlalchemy.Column[markupsafe.Markup | None]


   .. py:attribute:: author_name
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: author_place
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: author_date
      :type:  sqlalchemy.Column[datetime.datetime | None]


   .. py:attribute:: note
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: _issues
      :type:  sqlalchemy.Column[dict[str, str | None]]


   .. py:property:: issues
      :type: dict[str, str | None]



   .. py:attribute:: first_issue
      :type:  sqlalchemy.Column[datetime.datetime | None]


   .. py:attribute:: expiry_date
      :type:  sqlalchemy.Column[datetime.datetime | None]


   .. py:property:: expired
      :type: bool


      Returns True, if the notice is expired. 



   .. py:attribute:: _categories
      :type:  sqlalchemy.Column[dict[str, str | None]]


   .. py:property:: categories
      :type: dict[str, str | None]



   .. py:attribute:: category
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: organization
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: _organizations
      :type:  sqlalchemy.Column[dict[str, str | None] | None]


   .. py:property:: organizations
      :type: dict[str, str | None]



   .. py:attribute:: user_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: user
      :type:  sqlalchemy.orm.relationship[onegov.user.User | None]


   .. py:attribute:: group_id
      :type:  sqlalchemy.Column[uuid.UUID | None]


   .. py:attribute:: group
      :type:  sqlalchemy.orm.relationship[onegov.user.UserGroup | None]


   .. py:attribute:: source
      :type:  sqlalchemy.Column[str | None]


   .. py:method:: submit() -> None

      Submit a drafted notice. 



   .. py:method:: reject() -> None

      Reject a submitted notice. 



   .. py:method:: accept() -> None

      Accept a submitted notice. 



   .. py:method:: publish() -> None

      Publish an accepted notice.