ORE Studio 0.0.4
Loading...
Searching...
No Matches
change_reason.hpp
1/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * Copyright (C) 2025 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_DOMAIN_CHANGE_REASON_HPP
21#define ORES_DQ_DOMAIN_CHANGE_REASON_HPP
22
23#include <chrono>
24#include <string>
25
26namespace ores::dq::domain {
27
47struct change_reason final {
51 int version = 0;
52
59 std::string code;
60
64 std::string description;
65
71 std::string category_code;
72
76 bool applies_to_amend = true;
77
81 bool applies_to_delete = true;
82
86 bool requires_commentary = false;
87
94
98 std::string recorded_by;
99
103 std::string change_commentary;
104
108 std::chrono::system_clock::time_point recorded_at;
109};
110
114namespace change_reasons {
115 // System reasons
116 constexpr auto system_new = "system.new";
117 constexpr auto system_migration = "system.migration";
118
119 // Static data reasons
120 constexpr auto static_data_front_office_error = "static_data.front_office_error";
121 constexpr auto static_data_back_office_error = "static_data.back_office_error";
122 constexpr auto static_data_regulatory_change = "static_data.regulatory_change";
123 constexpr auto static_data_corporate_action = "static_data.corporate_action";
124}
125
126}
127
128#endif
Defines a specific reason for record changes.
Definition change_reason.hpp:47
int display_order
Display order for UI presentation.
Definition change_reason.hpp:93
std::string change_commentary
Free-text commentary explaining the change.
Definition change_reason.hpp:103
std::string description
Human-readable description of when to use this reason.
Definition change_reason.hpp:64
bool requires_commentary
Whether commentary is mandatory when using this reason.
Definition change_reason.hpp:86
std::string code
Unique code identifying this reason.
Definition change_reason.hpp:59
bool applies_to_delete
Whether this reason can be used for delete operations.
Definition change_reason.hpp:81
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition change_reason.hpp:108
std::string recorded_by
Username of the person who last modified this reason.
Definition change_reason.hpp:98
int version
Version number for optimistic locking and change tracking.
Definition change_reason.hpp:51
bool applies_to_amend
Whether this reason can be used for amend operations.
Definition change_reason.hpp:76
std::string category_code
Category code this reason belongs to.
Definition change_reason.hpp:71