gazette.collections.notices
===========================

.. py:module:: gazette.collections.notices


Attributes
----------

.. autoapisummary::

   gazette.collections.notices.TRANSLATIONS


Classes
-------

.. autoapisummary::

   gazette.collections.notices.GazetteNoticeCollection


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

.. py:data:: TRANSLATIONS
   :type:  dict[str | None, str]

.. py:class:: GazetteNoticeCollection(session: sqlalchemy.orm.Session, page: int = 0, state: onegov.notice.models.NoticeState | None = None, term: str | None = None, order: str | None = None, direction: Literal['asc', 'desc'] | None = None, issues: collections.abc.Collection[str] | None = None, categories: collections.abc.Collection[str] | None = None, organizations: collections.abc.Collection[str] | None = None, user_ids: list[uuid.UUID] | None = None, group_ids: list[uuid.UUID] | None = None, from_date: datetime.date | None = None, to_date: datetime.date | None = None, source: uuid.UUID | None = None, own: bool | None = None)

   Bases: :py:obj:`onegov.notice.OfficialNoticeCollection`\ [\ :py:obj:`onegov.gazette.models.GazetteNotice`\ ]


   Manage a list of gazette specific official notices. 


   .. py:attribute:: batch_size
      :value: 20



   .. py:property:: model_class
      :type: type[onegov.gazette.models.GazetteNotice]



   .. py:attribute:: from_date
      :value: None



   .. py:attribute:: to_date
      :value: None



   .. py:attribute:: source
      :value: None



   .. py:attribute:: own
      :value: None



   .. py:attribute:: own_user_id
      :type:  str | None
      :value: None



   .. py:method:: on_request(request: onegov.gazette.request.GazetteRequest) -> None


   .. py:method:: page_by_index(index: int) -> Self

      Returns the page at the given index. A page here means an instance
      of the class inheriting from the ``Pagination`` base class.




   .. py:method:: for_state(state: onegov.notice.models.NoticeState) -> Self

      Returns a new instance of the collection with the given state. 



   .. py:method:: for_term(term: str | None) -> Self

      Returns a new instance of the collection with the given term. 



   .. py:method:: for_order(order: str, direction: Literal['asc', 'desc'] | None = None) -> Self

      Returns a new instance of the collection with the given ordering.
      Inverts the direction if the new ordering is the same as the old one
      and an explicit ordering is not defined.




   .. py:method:: for_organizations(organizations: collections.abc.Collection[str] | None) -> Self

      Returns a new instance of the collection with the given
      organizations.




   .. py:method:: for_categories(categories: collections.abc.Collection[str] | None) -> Self

      Returns a new instance of the collection with the given categories.

              



   .. py:method:: for_dates(from_date: datetime.date | None, to_date: datetime.date | None) -> Self

      Returns a new instance of the collection with the given dates. 



   .. py:property:: term_columns
      :type: list[onegov.notice.collections._StrColumnLike]


      The columns used for full text search. 



   .. py:method:: filter_query(query: sqlalchemy.orm.Query[onegov.gazette.models.GazetteNotice]) -> sqlalchemy.orm.Query[onegov.gazette.models.GazetteNotice]

      Allows additionally to filter for notices with changes made by a
      given user.




   .. py:method:: add(title: str, text: str | None, organization_id: str | None, category_id: str | None, user: onegov.user.User, issues: dict[str, str | None] | collections.abc.Iterable[str], **kwargs: Any) -> onegov.gazette.models.GazetteNotice

      Add a new notice.

      A unique, URL-friendly name is created automatically for this notice
      using the title and optionally numbers for duplicate names.

      A entry is added automatically to the audit trail.

      Returns the created notice.



   .. py:method:: count_by_organization() -> list[tuple[str, int]]

      Returns the total number of notices by organizations.

      Returns a tuple ``(organization name, number of notices)``
      for each organization. Filters by the state of the collection.




   .. py:method:: count_by_category() -> list[tuple[str, int]]

      Returns the total number of notices by categories.

      Returns a tuple ``(category name, number of notices)``
      for each category. Filters by the state of the collection.




   .. py:method:: count_by_group() -> list[tuple[str, int]]

      Returns the total number of notices by groups.

      Returns a tuple ``(group name, number of notices)``
      for each group. Filters by the state of the collection.




   .. py:method:: count_rejected() -> list[tuple[str, int]]

      Returns the number of rejected notices by user.

      Returns a tuple ``(user name, number of rejections)``
      for each user. Does not filter by the state of the collection.




   .. py:property:: used_issues
      :type: tuple[onegov.gazette.models.Issue, Ellipsis]


      Returns all issues currently in use. 



   .. py:property:: used_organizations
      :type: tuple[onegov.gazette.models.Organization, Ellipsis]


      Returns all organizations currently in use. 



   .. py:property:: used_categories
      :type: tuple[onegov.gazette.models.Category, Ellipsis]


      Returns all categories currently in use.