bo4e_core/bo/
hardware_price_sheet.rs

1//! Hardware price sheet (PreisblattHardware) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::{Hardware, Price, TimePeriod};
7use crate::enums::Division;
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A price sheet for hardware (meters, communication devices, etc.).
11///
12/// German: PreisblattHardware
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::HardwarePriceSheet;
18/// use bo4e_core::enums::Division;
19///
20/// let price_sheet = HardwarePriceSheet {
21///     designation: Some("Hardware Preisblatt 2024".to_string()),
22///     division: Some(Division::Electricity),
23///     ..Default::default()
24/// };
25/// ```
26#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
27#[serde(rename_all = "camelCase")]
28pub struct HardwarePriceSheet {
29    /// BO4E metadata
30    #[serde(flatten)]
31    pub meta: Bo4eMeta,
32
33    /// Name/designation of the price sheet (Bezeichnung)
34    #[serde(skip_serializing_if = "Option::is_none")]
35    pub designation: Option<String>,
36
37    /// Description (Beschreibung)
38    #[serde(skip_serializing_if = "Option::is_none")]
39    pub description: Option<String>,
40
41    /// Energy division (Sparte)
42    #[serde(skip_serializing_if = "Option::is_none")]
43    pub division: Option<Division>,
44
45    /// Price sheet number/identifier (Preisblattnummer)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    pub price_sheet_number: Option<String>,
48
49    /// Validity period (Gueltigkeitszeitraum)
50    #[serde(skip_serializing_if = "Option::is_none")]
51    pub validity_period: Option<TimePeriod>,
52
53    /// Valid from date (Gueltig ab)
54    #[serde(skip_serializing_if = "Option::is_none")]
55    pub valid_from: Option<DateTime<Utc>>,
56
57    /// Valid until date (Gueltig bis)
58    #[serde(skip_serializing_if = "Option::is_none")]
59    pub valid_until: Option<DateTime<Utc>>,
60
61    /// Hardware items with pricing (Hardware)
62    #[serde(default, skip_serializing_if = "Vec::is_empty")]
63    pub hardware_items: Vec<Hardware>,
64
65    /// Installation price (Installationspreis)
66    #[serde(skip_serializing_if = "Option::is_none")]
67    pub installation_price: Option<Price>,
68
69    /// Rental price per unit (Mietpreis)
70    #[serde(skip_serializing_if = "Option::is_none")]
71    pub rental_price: Option<Price>,
72
73    /// Purchase price (Kaufpreis)
74    #[serde(skip_serializing_if = "Option::is_none")]
75    pub purchase_price: Option<Price>,
76
77    /// Hardware provider
78    #[serde(skip_serializing_if = "Option::is_none")]
79    pub provider: Option<Box<super::BusinessPartner>>,
80}
81
82impl Bo4eObject for HardwarePriceSheet {
83    fn type_name_german() -> &'static str {
84        "PreisblattHardware"
85    }
86
87    fn type_name_english() -> &'static str {
88        "HardwarePriceSheet"
89    }
90
91    fn meta(&self) -> &Bo4eMeta {
92        &self.meta
93    }
94
95    fn meta_mut(&mut self) -> &mut Bo4eMeta {
96        &mut self.meta
97    }
98}
99
100#[cfg(test)]
101mod tests {
102    use super::*;
103    use crate::com::Price;
104
105    #[test]
106    fn test_hardware_price_sheet_creation() {
107        let price_sheet = HardwarePriceSheet {
108            designation: Some("Hardware Preisblatt 2024".to_string()),
109            division: Some(Division::Electricity),
110            price_sheet_number: Some("HW-2024-001".to_string()),
111            installation_price: Some(Price::eur_per_month(5.0)),
112            ..Default::default()
113        };
114
115        assert_eq!(
116            price_sheet.designation,
117            Some("Hardware Preisblatt 2024".to_string())
118        );
119    }
120
121    #[test]
122    fn test_serialize() {
123        let price_sheet = HardwarePriceSheet {
124            meta: Bo4eMeta::with_type("PreisblattHardware"),
125            designation: Some("Meter Hardware".to_string()),
126            ..Default::default()
127        };
128
129        let json = serde_json::to_string(&price_sheet).unwrap();
130        assert!(json.contains(r#""designation":"Meter Hardware""#));
131        assert!(json.contains(r#""_typ":"PreisblattHardware""#));
132    }
133
134    #[test]
135    fn test_roundtrip() {
136        let price_sheet = HardwarePriceSheet {
137            meta: Bo4eMeta::with_type("PreisblattHardware"),
138            designation: Some("Smart Meter Prices".to_string()),
139            description: Some("Prices for smart meter hardware".to_string()),
140            division: Some(Division::Electricity),
141            price_sheet_number: Some("SM-2024".to_string()),
142            ..Default::default()
143        };
144
145        let json = serde_json::to_string(&price_sheet).unwrap();
146        let parsed: HardwarePriceSheet = 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!(HardwarePriceSheet::type_name_german(), "PreisblattHardware");
153        assert_eq!(
154            HardwarePriceSheet::type_name_english(),
155            "HardwarePriceSheet"
156        );
157    }
158}