bo4e_core/bo/
market_participant.rs

1//! Market participant (Marktteilnehmer) business object.
2
3use serde::{Deserialize, Serialize};
4
5use crate::com::{Address, ContactMethod};
6use crate::enums::{Division, MarketRole};
7use crate::traits::{Bo4eMeta, Bo4eObject};
8
9/// A market participant in the energy market.
10///
11/// German: Marktteilnehmer
12///
13/// # Example
14///
15/// ```rust
16/// use bo4e_core::bo::MarketParticipant;
17/// use bo4e_core::enums::{Division, MarketRole};
18///
19/// let participant = MarketParticipant {
20///     market_partner_id: Some("9900000000001".to_string()),
21///     market_role: Some(MarketRole::Supplier),
22///     division: Some(Division::Electricity),
23///     ..Default::default()
24/// };
25/// ```
26#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
27#[cfg_attr(feature = "json-schema", derive(schemars::JsonSchema))]
28#[cfg_attr(feature = "json-schema", schemars(rename = "Marktteilnehmer"))]
29#[serde(rename_all = "camelCase")]
30pub struct MarketParticipant {
31    /// BO4E metadata
32    #[serde(flatten)]
33    pub meta: Bo4eMeta,
34
35    /// Market partner ID (Marktpartner-ID) - typically BDEW code number
36    #[serde(skip_serializing_if = "Option::is_none")]
37    #[cfg_attr(feature = "json-schema", schemars(rename = "marktpartnerId"))]
38    pub market_partner_id: Option<String>,
39
40    /// Name of the market participant (Name)
41    #[serde(skip_serializing_if = "Option::is_none")]
42    #[cfg_attr(feature = "json-schema", schemars(rename = "name"))]
43    pub name: Option<String>,
44
45    /// Market role (Marktrolle)
46    #[serde(skip_serializing_if = "Option::is_none")]
47    #[cfg_attr(feature = "json-schema", schemars(rename = "marktrolle"))]
48    pub market_role: Option<MarketRole>,
49
50    /// Energy division (Sparte)
51    #[serde(skip_serializing_if = "Option::is_none")]
52    #[cfg_attr(feature = "json-schema", schemars(rename = "sparte"))]
53    pub division: Option<Division>,
54
55    /// Primary address (Adresse)
56    #[serde(skip_serializing_if = "Option::is_none")]
57    #[cfg_attr(feature = "json-schema", schemars(rename = "adresse"))]
58    pub address: Option<Address>,
59
60    /// Contact methods (Kontaktwege)
61    #[serde(default, skip_serializing_if = "Vec::is_empty")]
62    #[cfg_attr(feature = "json-schema", schemars(rename = "kontaktwege"))]
63    pub contact_methods: Vec<ContactMethod>,
64
65    /// Associated business partner (Geschaeftspartner)
66    #[serde(skip_serializing_if = "Option::is_none")]
67    #[cfg_attr(feature = "json-schema", schemars(rename = "geschaeftspartner"))]
68    pub business_partner: Option<Box<super::BusinessPartner>>,
69}
70
71impl Bo4eObject for MarketParticipant {
72    fn type_name_german() -> &'static str {
73        "Marktteilnehmer"
74    }
75
76    fn type_name_english() -> &'static str {
77        "MarketParticipant"
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
93    #[test]
94    fn test_market_participant_creation() {
95        let participant = MarketParticipant {
96            market_partner_id: Some("9900000000001".to_string()),
97            market_role: Some(MarketRole::Supplier),
98            division: Some(Division::Electricity),
99            ..Default::default()
100        };
101
102        assert_eq!(
103            participant.market_partner_id,
104            Some("9900000000001".to_string())
105        );
106        assert_eq!(participant.market_role, Some(MarketRole::Supplier));
107    }
108
109    #[test]
110    fn test_network_operator() {
111        let participant = MarketParticipant {
112            market_partner_id: Some("9900000000002".to_string()),
113            name: Some("Verteilnetz GmbH".to_string()),
114            market_role: Some(MarketRole::NetworkOperator),
115            division: Some(Division::Electricity),
116            ..Default::default()
117        };
118
119        assert_eq!(participant.market_role, Some(MarketRole::NetworkOperator));
120    }
121
122    #[test]
123    fn test_serialize() {
124        let participant = MarketParticipant {
125            meta: Bo4eMeta::with_type("Marktteilnehmer"),
126            market_partner_id: Some("9900000000001".to_string()),
127            name: Some("Test Lieferant GmbH".to_string()),
128            market_role: Some(MarketRole::Supplier),
129            ..Default::default()
130        };
131
132        let json = serde_json::to_string(&participant).unwrap();
133        assert!(json.contains(r#""marketPartnerId":"9900000000001""#));
134        assert!(json.contains(r#""name":"Test Lieferant GmbH""#));
135    }
136
137    #[test]
138    fn test_roundtrip() {
139        let participant = MarketParticipant {
140            meta: Bo4eMeta::with_type("Marktteilnehmer"),
141            market_partner_id: Some("9900000000001".to_string()),
142            name: Some("Test Lieferant GmbH".to_string()),
143            market_role: Some(MarketRole::Supplier),
144            division: Some(Division::Electricity),
145            ..Default::default()
146        };
147
148        let json = serde_json::to_string(&participant).unwrap();
149        let parsed: MarketParticipant = serde_json::from_str(&json).unwrap();
150        assert_eq!(participant, parsed);
151    }
152
153    #[test]
154    fn test_bo4e_object_impl() {
155        assert_eq!(MarketParticipant::type_name_german(), "Marktteilnehmer");
156        assert_eq!(MarketParticipant::type_name_english(), "MarketParticipant");
157    }
158}
bo4e_core/bo/market_participant.rs

bo4e_core/bo/
market_participant.rs
