gazette.views.notices
=====================

.. py:module:: gazette.views.notices


Functions
---------

.. autoapisummary::

   gazette.views.notices.create_notice
   gazette.views.notices.view_notices
   gazette.views.notices.view_notices_statistics
   gazette.views.notices.view_notices_statistics_xlsx
   gazette.views.notices.view_notices_preview_pdf
   gazette.views.notices.view_notices_index
   gazette.views.notices.view_notices_update


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

.. py:function:: create_notice(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.NoticeForm) -> onegov.core.types.RenderData | webob.Response

   Create a new notice.

   If a valid UID of a notice is given (via 'source' query parameter), its
   values are pre-filled in the form.

   This view is mainly used by the editors.



.. py:function:: view_notices(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest) -> onegov.core.types.RenderData

   View the list of notices.

   This view is only visible by a publisher. This (in the state 'accepted')
   is the view used by the publisher.



.. py:function:: view_notices_statistics(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest) -> onegov.core.types.RenderData

   View the list of notices.

   This view is only visible by a publisher. This (in the state 'accepted')
   is the view used by the publisher.



.. py:function:: view_notices_statistics_xlsx(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest) -> morepath.request.Response

   View the statistics as XLSX. 


.. py:function:: view_notices_preview_pdf(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest) -> morepath.request.Response

   Preview the notices as PDF.

   This view is only visible by a publisher.



.. py:function:: view_notices_index(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest) -> morepath.request.Response

   Export the index to the notices as PDF.

   This view is only visible by a publisher.



.. py:function:: view_notices_update(self: onegov.gazette.collections.GazetteNoticeCollection, request: onegov.gazette.request.GazetteRequest, form: onegov.gazette.forms.EmptyForm) -> onegov.core.types.RenderData | webob.Response

   Updates all notices (of this state): Applies the categories, issues and
   organization from the meta informations. This view is not used normally
   and only intended when changing category names in the principal definition,
   for example.