ORE Studio 0.0.4
Loading...
Searching...
No Matches
report_definition.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_REPORTING_DOMAIN_REPORT_DEFINITION_HPP
21#define ORES_REPORTING_DOMAIN_REPORT_DEFINITION_HPP
22
23#include <optional>
24#include <string>
25#include <boost/uuid/uuid.hpp>
26#include "ores.utility/uuid/tenant_id.hpp"
27
28namespace ores::reporting::domain {
29
44struct report_definition final {
48 int version = 0;
49
54
58 boost::uuids::uuid id;
59
63 std::string name;
64
68 boost::uuids::uuid party_id;
69
73 std::string description;
74
78 std::string report_type;
79
83 std::optional<boost::uuids::uuid> fsm_state_id;
84
89
93 std::string concurrency_policy;
94
98 std::optional<boost::uuids::uuid> scheduler_job_id;
99
103 std::string modified_by;
104
108 std::string performed_by;
109
116
120 std::string change_commentary;
121
125 std::chrono::system_clock::time_point recorded_at;
126};
127
128}
129
130#endif
Persistent template for a scheduled report.
Definition report_definition.hpp:44
std::optional< boost::uuids::uuid > scheduler_job_id
Scheduler job UUID (FK to ores_scheduler_job_definitions_tbl). Present only when status is active.
Definition report_definition.hpp:98
std::string modified_by
Username of the person who last modified this report definition.
Definition report_definition.hpp:103
std::string schedule_expression
Validated cron expression driving report recurrence.
Definition report_definition.hpp:88
std::string change_commentary
Free-text commentary explaining the change.
Definition report_definition.hpp:120
std::string description
Optional human-readable description of the report.
Definition report_definition.hpp:73
boost::uuids::uuid party_id
Party that owns this report definition.
Definition report_definition.hpp:68
std::string report_type
Report type code (FK to ores_reporting_report_types_tbl).
Definition report_definition.hpp:78
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition report_definition.hpp:125
std::string name
Unique name for the report definition within a tenant.
Definition report_definition.hpp:63
boost::uuids::uuid id
UUID uniquely identifying this report definition.
Definition report_definition.hpp:58
std::optional< boost::uuids::uuid > fsm_state_id
Current FSM state (FK to ores_dq_fsm_states_tbl). Null until first activation.
Definition report_definition.hpp:83
int version
Version number for optimistic locking and change tracking.
Definition report_definition.hpp:48
std::string performed_by
Username of the account that performed this action.
Definition report_definition.hpp:108
std::string concurrency_policy
Concurrency policy code (FK to ores_reporting_concurrency_policies_tbl).
Definition report_definition.hpp:93
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition report_definition.hpp:53
std::string change_reason_code
Code identifying the reason for the change.
Definition report_definition.hpp:115
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