bo4e-core 0.1.1

Core types for BO4E (Business Objects for Energy)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

//! Bundle contract (Buendelvertrag) business object.

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

use crate::com::TimePeriod;
use crate::enums::{ContractStatus, Division};
use crate::traits::{Bo4eMeta, Bo4eObject};

/// A bundle contract that combines multiple individual contracts.
///
/// German: Buendelvertrag
///
/// # Example
///
/// ```rust
/// use bo4e_core::bo::BundleContract;
/// use bo4e_core::enums::{ContractStatus, Division};
///
/// let bundle = BundleContract {
///     bundle_contract_number: Some("BV-2024-001".to_string()),
///     status: Some(ContractStatus::Active),
///     division: Some(Division::Electricity),
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BundleContract {
    /// BO4E metadata
    #[serde(flatten)]
    pub meta: Bo4eMeta,

    /// Bundle contract number (Buendelvertragsnummer)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub bundle_contract_number: Option<String>,

    /// Description (Beschreibung)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// Status of bundle contract (Vertragsstatus)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub status: Option<ContractStatus>,

    /// Energy division (Sparte)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub division: Option<Division>,

    /// Bundle contract start date (Vertragsbeginn)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract_start: Option<DateTime<Utc>>,

    /// Bundle contract end date (Vertragsende)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract_end: Option<DateTime<Utc>>,

    /// Validity period (Gueltigkeitszeitraum)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub validity_period: Option<TimePeriod>,

    /// Individual contracts in this bundle (Einzelvertraege)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub individual_contracts: Vec<Box<super::Contract>>,

    /// Contracting party (Vertragspartner)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub contract_partner: Option<Box<super::BusinessPartner>>,
}

impl Bo4eObject for BundleContract {
    fn type_name_german() -> &'static str {
        "Buendelvertrag"
    }

    fn type_name_english() -> &'static str {
        "BundleContract"
    }

    fn meta(&self) -> &Bo4eMeta {
        &self.meta
    }

    fn meta_mut(&mut self) -> &mut Bo4eMeta {
        &mut self.meta
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::bo::Contract;
    use crate::enums::ContractType;

    #[test]
    fn test_bundle_contract_creation() {
        let bundle = BundleContract {
            bundle_contract_number: Some("BV-2024-001".to_string()),
            status: Some(ContractStatus::Active),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        assert_eq!(bundle.status, Some(ContractStatus::Active));
    }

    #[test]
    fn test_bundle_with_contracts() {
        let contract1 = Box::new(Contract {
            contract_number: Some("V-001".to_string()),
            contract_type: Some(ContractType::EnergySupplyContract),
            ..Default::default()
        });

        let contract2 = Box::new(Contract {
            contract_number: Some("V-002".to_string()),
            contract_type: Some(ContractType::NetworkUsageContract),
            ..Default::default()
        });

        let bundle = BundleContract {
            bundle_contract_number: Some("BV-2024-001".to_string()),
            individual_contracts: vec![contract1, contract2],
            ..Default::default()
        };

        assert_eq!(bundle.individual_contracts.len(), 2);
    }

    #[test]
    fn test_serialize() {
        let bundle = BundleContract {
            meta: Bo4eMeta::with_type("Buendelvertrag"),
            bundle_contract_number: Some("BV-123".to_string()),
            status: Some(ContractStatus::Active),
            ..Default::default()
        };

        let json = serde_json::to_string(&bundle).unwrap();
        assert!(json.contains(r#""bundleContractNumber":"BV-123""#));
    }

    #[test]
    fn test_roundtrip() {
        let bundle = BundleContract {
            meta: Bo4eMeta::with_type("Buendelvertrag"),
            bundle_contract_number: Some("BV-123".to_string()),
            description: Some("Test bundle".to_string()),
            status: Some(ContractStatus::Active),
            division: Some(Division::Electricity),
            ..Default::default()
        };

        let json = serde_json::to_string(&bundle).unwrap();
        let parsed: BundleContract = serde_json::from_str(&json).unwrap();
        assert_eq!(bundle, parsed);
    }

    #[test]
    fn test_bo4e_object_impl() {
        assert_eq!(BundleContract::type_name_german(), "Buendelvertrag");
        assert_eq!(BundleContract::type_name_english(), "BundleContract");
    }
}