bo4e_core/bo/
tariff_price_sheet.rs

1//! Tariff price sheet (Tarifpreisblatt) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{TariffPricePosition, TimePeriod};
7use crate::enums::{CustomerType, Division};
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A tariff price sheet containing tariff-specific pricing.
11///
12/// German: Tarifpreisblatt
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::TariffPriceSheet;
18/// use bo4e_core::enums::{CustomerType, Division};
19///
20/// let price_sheet = TariffPriceSheet {
21///     designation: Some("Haushaltstarif Preisblatt 2024".to_string()),
22///     division: Some(Division::Electricity),
23///     customer_type: Some(CustomerType::Household),
24///     ..Default::default()
25/// };
26/// ```
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28#[serde(rename_all = "camelCase")]
29pub struct TariffPriceSheet {
30    /// BO4E metadata
31    #[serde(flatten)]
32    pub meta: Bo4eMeta,
33
34    /// Name/designation of the price sheet (Bezeichnung)
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub designation: Option<String>,
37
38    /// Description (Beschreibung)
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub description: Option<String>,
41
42    /// Energy division (Sparte)
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub division: Option<Division>,
45
46    /// Target customer type (Kundentyp)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub customer_type: Option<CustomerType>,
49
50    /// Price sheet number/identifier (Preisblattnummer)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub price_sheet_number: Option<String>,
53
54    /// Validity period (Gueltigkeitszeitraum)
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub validity_period: Option<TimePeriod>,
57
58    /// Valid from date (Gueltig ab)
59    #[serde(skip_serializing_if = "Option::is_none")]
60    pub valid_from: Option<DateTime<Utc>>,
61
62    /// Valid until date (Gueltig bis)
63    #[serde(skip_serializing_if = "Option::is_none")]
64    pub valid_until: Option<DateTime<Utc>>,
65
66    /// Tariff price positions (Tarifpreispositionen)
67    #[serde(default, skip_serializing_if = "Vec::is_empty")]
68    pub positions: Vec<TariffPricePosition>,
69
70    /// Publisher/provider of the price sheet
71    #[serde(skip_serializing_if = "Option::is_none")]
72    pub publisher: Option<Box<super::BusinessPartner>>,
73}
74
75impl Bo4eObject for TariffPriceSheet {
76    fn type_name_german() -> &'static str {
77        "Tarifpreisblatt"
78    }
79
80    fn type_name_english() -> &'static str {
81        "TariffPriceSheet"
82    }
83
84    fn meta(&self) -> &Bo4eMeta {
85        &self.meta
86    }
87
88    fn meta_mut(&mut self) -> &mut Bo4eMeta {
89        &mut self.meta
90    }
91}
92
93#[cfg(test)]
94mod tests {
95    use super::*;
96
97    #[test]
98    fn test_tariff_price_sheet_creation() {
99        let price_sheet = TariffPriceSheet {
100            designation: Some("Haushaltstarif Preisblatt 2024".to_string()),
101            division: Some(Division::Electricity),
102            customer_type: Some(CustomerType::Household),
103            price_sheet_number: Some("TPB-2024-001".to_string()),
104            ..Default::default()
105        };
106
107        assert_eq!(price_sheet.customer_type, Some(CustomerType::Household));
108    }
109
110    #[test]
111    fn test_serialize() {
112        let price_sheet = TariffPriceSheet {
113            meta: Bo4eMeta::with_type("Tarifpreisblatt"),
114            designation: Some("Test Tariff Sheet".to_string()),
115            ..Default::default()
116        };
117
118        let json = serde_json::to_string(&price_sheet).unwrap();
119        assert!(json.contains(r#""designation":"Test Tariff Sheet""#));
120        assert!(json.contains(r#""_typ":"Tarifpreisblatt""#));
121    }
122
123    #[test]
124    fn test_roundtrip() {
125        let price_sheet = TariffPriceSheet {
126            meta: Bo4eMeta::with_type("Tarifpreisblatt"),
127            designation: Some("Gas Tariff Sheet".to_string()),
128            division: Some(Division::Gas),
129            customer_type: Some(CustomerType::Commercial),
130            price_sheet_number: Some("GAS-2024".to_string()),
131            ..Default::default()
132        };
133
134        let json = serde_json::to_string(&price_sheet).unwrap();
135        let parsed: TariffPriceSheet = serde_json::from_str(&json).unwrap();
136        assert_eq!(price_sheet, parsed);
137    }
138
139    #[test]
140    fn test_bo4e_object_impl() {
141        assert_eq!(TariffPriceSheet::type_name_german(), "Tarifpreisblatt");
142        assert_eq!(TariffPriceSheet::type_name_english(), "TariffPriceSheet");
143    }
144}
bo4e_core/bo/tariff_price_sheet.rs

bo4e_core/bo/
tariff_price_sheet.rs
