pibtool_stock_data/document_kind.rs
1// SPDX-FileCopyrightText: Politik im Blick developers
2// SPDX-FileCopyrightText: Wolfgang Silbermayr <wolfgang@silbermayr.at>
3//
4// SPDX-License-Identifier: AGPL-3.0-or-later OR EUPL-1.2
5
6use serde::{Deserialize, Serialize};
7
8/// The kinds of documents that can be downloaded from available data sources.
9#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
10#[serde(rename_all = "snake_case")]
11pub enum DocumentKind {
12 /// A document containing the protocol of the municipal council meeting procedure in detail as demanded by law
13 ///
14 /// A proper protocol typically follows this structure (not necessarily in *exactly* this order):
15 ///
16 /// - A header with location and date
17 /// - A list of the present and invited but absent participants
18 /// - An agenda listing all the items planned for this session
19 /// - A detailed section describing the discussion of each agenda item in detail
20 /// - Ballot results for agenda items that require a vote
21 MunicipalCouncilMeetingProtocol,
22
23 /// One or more invitations to municipal council meetings
24 MunicipalCouncilMeetingInvitation,
25
26 /// A report or summary of the municipal council meeting summarizing the outcome of each of the agenda items
27 MunicipalCouncilSummaryReport,
28
29 /// An official journal published by a municipality.
30 ///
31 /// Municipal journals frequently contain a report or summary of the most recent municipal council meeting.
32 OfficialMunicipalJournal,
33}