bo4e_core/bo/
concession_fee_price_sheet.rs

1//! Concession fee price sheet (PreisblattKonzessionsabgabe) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{ConcessionFee, TimePeriod};
7use crate::enums::{ConcessionFeeCustomerGroup, Division};
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A price sheet for concession fees.
11///
12/// Concession fees are paid to municipalities for the use of public
13/// ways for energy infrastructure.
14///
15/// German: PreisblattKonzessionsabgabe
16///
17/// # Example
18///
19/// ```rust
20/// use bo4e_core::bo::ConcessionFeePriceSheet;
21/// use bo4e_core::enums::Division;
22///
23/// let price_sheet = ConcessionFeePriceSheet {
24///     designation: Some("Konzessionsabgaben 2024".to_string()),
25///     division: Some(Division::Electricity),
26///     ..Default::default()
27/// };
28/// ```
29#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
30#[serde(rename_all = "camelCase")]
31pub struct ConcessionFeePriceSheet {
32    /// BO4E metadata
33    #[serde(flatten)]
34    pub meta: Bo4eMeta,
35
36    /// Name/designation of the price sheet (Bezeichnung)
37    #[serde(skip_serializing_if = "Option::is_none")]
38    pub designation: Option<String>,
39
40    /// Description (Beschreibung)
41    #[serde(skip_serializing_if = "Option::is_none")]
42    pub description: Option<String>,
43
44    /// Energy division (Sparte)
45    #[serde(skip_serializing_if = "Option::is_none")]
46    pub division: Option<Division>,
47
48    /// Customer group for concession fees (Kundengruppe)
49    #[serde(skip_serializing_if = "Option::is_none")]
50    pub customer_group: Option<ConcessionFeeCustomerGroup>,
51
52    /// Price sheet number/identifier (Preisblattnummer)
53    #[serde(skip_serializing_if = "Option::is_none")]
54    pub price_sheet_number: Option<String>,
55
56    /// Validity period (Gueltigkeitszeitraum)
57    #[serde(skip_serializing_if = "Option::is_none")]
58    pub validity_period: Option<TimePeriod>,
59
60    /// Valid from date (Gueltig ab)
61    #[serde(skip_serializing_if = "Option::is_none")]
62    pub valid_from: Option<DateTime<Utc>>,
63
64    /// Valid until date (Gueltig bis)
65    #[serde(skip_serializing_if = "Option::is_none")]
66    pub valid_until: Option<DateTime<Utc>>,
67
68    /// Concession fees (Konzessionsabgaben)
69    #[serde(default, skip_serializing_if = "Vec::is_empty")]
70    pub concession_fees: Vec<ConcessionFee>,
71
72    /// Municipality/area name (Gemeindebezeichnung)
73    #[serde(skip_serializing_if = "Option::is_none")]
74    pub municipality: Option<String>,
75
76    /// Network operator
77    #[serde(skip_serializing_if = "Option::is_none")]
78    pub operator: Option<Box<super::BusinessPartner>>,
79}
80
81impl Bo4eObject for ConcessionFeePriceSheet {
82    fn type_name_german() -> &'static str {
83        "PreisblattKonzessionsabgabe"
84    }
85
86    fn type_name_english() -> &'static str {
87        "ConcessionFeePriceSheet"
88    }
89
90    fn meta(&self) -> &Bo4eMeta {
91        &self.meta
92    }
93
94    fn meta_mut(&mut self) -> &mut Bo4eMeta {
95        &mut self.meta
96    }
97}
98
99#[cfg(test)]
100mod tests {
101    use super::*;
102
103    #[test]
104    fn test_concession_fee_price_sheet_creation() {
105        let price_sheet = ConcessionFeePriceSheet {
106            designation: Some("Konzessionsabgaben 2024".to_string()),
107            division: Some(Division::Electricity),
108            customer_group: Some(ConcessionFeeCustomerGroup::ElectricityTariff25000),
109            municipality: Some("Musterstadt".to_string()),
110            price_sheet_number: Some("KA-2024-001".to_string()),
111            ..Default::default()
112        };
113
114        assert_eq!(
115            price_sheet.customer_group,
116            Some(ConcessionFeeCustomerGroup::ElectricityTariff25000)
117        );
118    }
119
120    #[test]
121    fn test_serialize() {
122        let price_sheet = ConcessionFeePriceSheet {
123            meta: Bo4eMeta::with_type("PreisblattKonzessionsabgabe"),
124            designation: Some("Concession Fees".to_string()),
125            ..Default::default()
126        };
127
128        let json = serde_json::to_string(&price_sheet).unwrap();
129        assert!(json.contains(r#""designation":"Concession Fees""#));
130        assert!(json.contains(r#""_typ":"PreisblattKonzessionsabgabe""#));
131    }
132
133    #[test]
134    fn test_roundtrip() {
135        let price_sheet = ConcessionFeePriceSheet {
136            meta: Bo4eMeta::with_type("PreisblattKonzessionsabgabe"),
137            designation: Some("Municipal Fees".to_string()),
138            description: Some("Concession fees for municipality".to_string()),
139            division: Some(Division::Electricity),
140            municipality: Some("Teststadt".to_string()),
141            price_sheet_number: Some("MF-2024".to_string()),
142            ..Default::default()
143        };
144
145        let json = serde_json::to_string(&price_sheet).unwrap();
146        let parsed: ConcessionFeePriceSheet = serde_json::from_str(&json).unwrap();
147        assert_eq!(price_sheet, parsed);
148    }
149
150    #[test]
151    fn test_bo4e_object_impl() {
152        assert_eq!(
153            ConcessionFeePriceSheet::type_name_german(),
154            "PreisblattKonzessionsabgabe"
155        );
156        assert_eq!(
157            ConcessionFeePriceSheet::type_name_english(),
158            "ConcessionFeePriceSheet"
159        );
160    }
161}
bo4e_core/bo/concession_fee_price_sheet.rs

bo4e_core/bo/
concession_fee_price_sheet.rs
