ebi_bpmn 0.0.32

A BPMN parser, writer and executor
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

use crate::{BusinessProcessModelAndNotation, parser::parser_state::GlobalIndex};
use anyhow::Result;

pub(crate) static EMPTY_FLOWS: Vec<usize> = vec![];

/// provides methods to interact with BPMN objects. Cannot be implemented on Vec<...>.
pub trait BPMNObject {
    /// return the global index
    fn global_index(&self) -> GlobalIndex;

    /// return the index within its parent
    fn local_index(&self) -> usize;

    /// return the id
    fn id(&self) -> &str;

    /// return whether this is a start event that could initiate a process instance
    fn is_unconstrained_start_event(&self, bpmn: &BusinessProcessModelAndNotation) -> Result<bool>;

    /// return whether this is an end event
    fn is_end_event(&self) -> bool;

    /// the flow indices of the incoming sequence flows of this object
    fn incoming_sequence_flows(&self) -> &[usize];

    /// the flow indices of the outgoing sequence flows of this object
    fn outgoing_sequence_flows(&self) -> &[usize];

    /// the flow indices of the incoming message flows of this object
    fn incoming_message_flows(&self) -> &[usize];

    /// the flow indices of the outgoing message flows of this object
    fn outgoing_message_flows(&self) -> &[usize];

    /// return whether this object could start a process instance, regardless of marking
    fn can_start_process_instance(&self, bpmn: &BusinessProcessModelAndNotation) -> Result<bool>;

    /// return whether the outgoing message flows of this object are always enabled
    fn outgoing_message_flows_always_have_tokens(&self) -> bool;

    /// return whether any outgoing message flow of this object cannot be removed when it is there
    /// If `true`, do not produce more than 1 message and do not remove messages from message flows outgoing of this object.
    fn outgoing_messages_cannot_be_removed(&self) -> bool;

    /// Return whether any incoming messages are ignored.
    /// If `true`, do not produce messages on message arcs coming into this object.
    fn incoming_messages_are_ignored(&self) -> bool;

    /// return whether this object can have incoming sequence flows
    fn can_have_incoming_sequence_flows(&self) -> bool;

    /// return whether this object can have incoming sequence flows
    fn can_have_outgoing_sequence_flows(&self) -> bool;
}

impl BPMNObject for BusinessProcessModelAndNotation {
    fn global_index(&self) -> GlobalIndex {
        self.definitions_index
    }

    fn local_index(&self) -> usize {
        0
    }

    fn id(&self) -> &str {
        &self.definitions_id
    }

    fn is_unconstrained_start_event(
        &self,
        _bpmn: &BusinessProcessModelAndNotation,
    ) -> Result<bool> {
        Ok(false)
    }

    fn is_end_event(&self) -> bool {
        false
    }

    fn incoming_sequence_flows(&self) -> &[usize] {
        &EMPTY_FLOWS
    }

    fn outgoing_sequence_flows(&self) -> &[usize] {
        &EMPTY_FLOWS
    }

    fn incoming_message_flows(&self) -> &[usize] {
        &EMPTY_FLOWS
    }

    fn outgoing_message_flows(&self) -> &[usize] {
        &EMPTY_FLOWS
    }

    fn can_start_process_instance(&self, _bpmn: &BusinessProcessModelAndNotation) -> Result<bool> {
        Ok(false)
    }

    fn outgoing_message_flows_always_have_tokens(&self) -> bool {
        false
    }

    fn outgoing_messages_cannot_be_removed(&self) -> bool {
        false
    }

    fn incoming_messages_are_ignored(&self) -> bool {
        false
    }

    fn can_have_incoming_sequence_flows(&self) -> bool {
        false
    }

    fn can_have_outgoing_sequence_flows(&self) -> bool {
        false
    }
}