ORE Studio 0.0.4
Loading...
Searching...
No Matches
fsm_transition.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2026 Marco Craveiro <marco.craveiro@gmail.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU General Public License as published by the Free Software
7 * Foundation; either version 3 of the License, or (at your option) any later
8 * version.
9 *
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
13 * details.
14 *
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 *
19 */
20#ifndef ORES_DQ_API_DOMAIN_FSM_TRANSITION_HPP
21#define ORES_DQ_API_DOMAIN_FSM_TRANSITION_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26#include <boost/uuid/uuid.hpp>
27#include "ores.utility/uuid/tenant_id.hpp"
28
29namespace ores::dq::domain {
30
36struct fsm_transition final {
40 int version = 0;
41
46
50 boost::uuids::uuid id;
51
55 boost::uuids::uuid machine_id;
56
62 std::optional<boost::uuids::uuid> from_state_id;
63
67 boost::uuids::uuid to_state_id;
68
72 std::string name;
73
77 std::string guard_function;
78
82 std::string modified_by;
83
87 std::string performed_by;
88
92 std::string change_reason_code;
93
97 std::string change_commentary;
98
102 std::chrono::system_clock::time_point recorded_at;
103};
104
105}
106
107#endif
A valid state-to-state transition within a finite state machine.
Definition fsm_transition.hpp:36
std::string modified_by
Username of the person who last modified this record.
Definition fsm_transition.hpp:82
std::string change_commentary
Free-text commentary explaining the change.
Definition fsm_transition.hpp:97
std::string guard_function
Optional guard function name for business rule enforcement.
Definition fsm_transition.hpp:77
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition fsm_transition.hpp:102
std::string name
Human-readable transition name (e.g. "confirm", "cancel_new").
Definition fsm_transition.hpp:72
boost::uuids::uuid machine_id
UUID of the FSM machine this transition belongs to.
Definition fsm_transition.hpp:55
boost::uuids::uuid id
UUID uniquely identifying this transition.
Definition fsm_transition.hpp:50
int version
Version number for optimistic locking and change tracking.
Definition fsm_transition.hpp:40
std::string performed_by
Username of the account that performed this action.
Definition fsm_transition.hpp:87
boost::uuids::uuid to_state_id
Target state UUID.
Definition fsm_transition.hpp:67
std::optional< boost::uuids::uuid > from_state_id
Source state UUID.
Definition fsm_transition.hpp:62
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition fsm_transition.hpp:45
std::string change_reason_code
Code identifying the reason for the change.
Definition fsm_transition.hpp:92
A strongly-typed wrapper around a UUID representing a tenant identifier.
Definition tenant_id.hpp:66
static tenant_id system()
Creates a tenant_id representing the system tenant.
Definition tenant_id.cpp:41