bo4e_core/bo/
bundle_contract.rs

1//! Bundle contract (Buendelvertrag) business object.
2
3use chrono::{DateTime, Utc};
4use serde::{Deserialize, Serialize};
5
6use crate::com::TimePeriod;
7use crate::enums::{ContractStatus, Division};
8use crate::traits::{Bo4eMeta, Bo4eObject};
9
10/// A bundle contract that combines multiple individual contracts.
11///
12/// German: Buendelvertrag
13///
14/// # Example
15///
16/// ```rust
17/// use bo4e_core::bo::BundleContract;
18/// use bo4e_core::enums::{ContractStatus, Division};
19///
20/// let bundle = BundleContract {
21///     bundle_contract_number: Some("BV-2024-001".to_string()),
22///     status: Some(ContractStatus::Active),
23///     division: Some(Division::Electricity),
24///     ..Default::default()
25/// };
26/// ```
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28#[serde(rename_all = "camelCase")]
29pub struct BundleContract {
30    /// BO4E metadata
31    #[serde(flatten)]
32    pub meta: Bo4eMeta,
33
34    /// Bundle contract number (Buendelvertragsnummer)
35    #[serde(skip_serializing_if = "Option::is_none")]
36    pub bundle_contract_number: Option<String>,
37
38    /// Description (Beschreibung)
39    #[serde(skip_serializing_if = "Option::is_none")]
40    pub description: Option<String>,
41
42    /// Status of bundle contract (Vertragsstatus)
43    #[serde(skip_serializing_if = "Option::is_none")]
44    pub status: Option<ContractStatus>,
45
46    /// Energy division (Sparte)
47    #[serde(skip_serializing_if = "Option::is_none")]
48    pub division: Option<Division>,
49
50    /// Bundle contract start date (Vertragsbeginn)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    pub contract_start: Option<DateTime<Utc>>,
53
54    /// Bundle contract end date (Vertragsende)
55    #[serde(skip_serializing_if = "Option::is_none")]
56    pub contract_end: Option<DateTime<Utc>>,
57
58    /// Validity period (Gueltigkeitszeitraum)
59    #[serde(skip_serializing_if = "Option::is_none")]
60    pub validity_period: Option<TimePeriod>,
61
62    /// Individual contracts in this bundle (Einzelvertraege)
63    #[serde(default, skip_serializing_if = "Vec::is_empty")]
64    pub individual_contracts: Vec<Box<super::Contract>>,
65
66    /// Contracting party (Vertragspartner)
67    #[serde(skip_serializing_if = "Option::is_none")]
68    pub contract_partner: Option<Box<super::BusinessPartner>>,
69}
70
71impl Bo4eObject for BundleContract {
72    fn type_name_german() -> &'static str {
73        "Buendelvertrag"
74    }
75
76    fn type_name_english() -> &'static str {
77        "BundleContract"
78    }
79
80    fn meta(&self) -> &Bo4eMeta {
81        &self.meta
82    }
83
84    fn meta_mut(&mut self) -> &mut Bo4eMeta {
85        &mut self.meta
86    }
87}
88
89#[cfg(test)]
90mod tests {
91    use super::*;
92    use crate::bo::Contract;
93    use crate::enums::ContractType;
94
95    #[test]
96    fn test_bundle_contract_creation() {
97        let bundle = BundleContract {
98            bundle_contract_number: Some("BV-2024-001".to_string()),
99            status: Some(ContractStatus::Active),
100            division: Some(Division::Electricity),
101            ..Default::default()
102        };
103
104        assert_eq!(bundle.status, Some(ContractStatus::Active));
105    }
106
107    #[test]
108    fn test_bundle_with_contracts() {
109        let contract1 = Box::new(Contract {
110            contract_number: Some("V-001".to_string()),
111            contract_type: Some(ContractType::EnergySupplyContract),
112            ..Default::default()
113        });
114
115        let contract2 = Box::new(Contract {
116            contract_number: Some("V-002".to_string()),
117            contract_type: Some(ContractType::NetworkUsageContract),
118            ..Default::default()
119        });
120
121        let bundle = BundleContract {
122            bundle_contract_number: Some("BV-2024-001".to_string()),
123            individual_contracts: vec![contract1, contract2],
124            ..Default::default()
125        };
126
127        assert_eq!(bundle.individual_contracts.len(), 2);
128    }
129
130    #[test]
131    fn test_serialize() {
132        let bundle = BundleContract {
133            meta: Bo4eMeta::with_type("Buendelvertrag"),
134            bundle_contract_number: Some("BV-123".to_string()),
135            status: Some(ContractStatus::Active),
136            ..Default::default()
137        };
138
139        let json = serde_json::to_string(&bundle).unwrap();
140        assert!(json.contains(r#""bundleContractNumber":"BV-123""#));
141    }
142
143    #[test]
144    fn test_roundtrip() {
145        let bundle = BundleContract {
146            meta: Bo4eMeta::with_type("Buendelvertrag"),
147            bundle_contract_number: Some("BV-123".to_string()),
148            description: Some("Test bundle".to_string()),
149            status: Some(ContractStatus::Active),
150            division: Some(Division::Electricity),
151            ..Default::default()
152        };
153
154        let json = serde_json::to_string(&bundle).unwrap();
155        let parsed: BundleContract = serde_json::from_str(&json).unwrap();
156        assert_eq!(bundle, parsed);
157    }
158
159    #[test]
160    fn test_bo4e_object_impl() {
161        assert_eq!(BundleContract::type_name_german(), "Buendelvertrag");
162        assert_eq!(BundleContract::type_name_english(), "BundleContract");
163    }
164}
bo4e_core/bo/bundle_contract.rs

bo4e_core/bo/
bundle_contract.rs
