ORE Studio 0.0.4
Loading...
Searching...
No Matches
change_management_service.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_CORE_SERVICE_CHANGE_MANAGEMENT_SERVICE_HPP
21#define ORES_DQ_CORE_SERVICE_CHANGE_MANAGEMENT_SERVICE_HPP
22
23#include <string>
24#include <vector>
25#include <optional>
26#include "ores.logging/make_logger.hpp"
27#include "ores.database/domain/context.hpp"
28#include "ores.dq.api/domain/change_reason_category.hpp"
29#include "ores.dq.api/domain/change_reason.hpp"
30#include "ores.dq.core/repository/change_reason_category_repository.hpp"
31#include "ores.dq.core/repository/change_reason_repository.hpp"
32
33namespace ores::dq::service {
34
44private:
45 inline static std::string_view logger_name =
46 "ores.iam.service.change_management_service";
47
48 [[nodiscard]] static auto& lg() {
49 using namespace ores::logging;
50 static auto instance = make_logger(logger_name);
51 return instance;
52 }
53
54public:
56
63
64 // ========================================================================
65 // Category Management
66 // ========================================================================
67
71 std::vector<domain::change_reason_category> list_categories();
72
76 std::vector<domain::change_reason_category>
77 list_categories(std::uint32_t offset, std::uint32_t limit);
78
82 std::uint32_t get_category_count();
83
87 std::optional<domain::change_reason_category>
88 find_category(const std::string& code);
89
96
102 void save_categories(const std::vector<domain::change_reason_category>& categories);
103
109 void remove_category(const std::string& code);
110
114 void remove_categories(const std::vector<std::string>& codes);
115
122 std::vector<domain::change_reason_category>
123 get_category_history(const std::string& code);
124
125 // ========================================================================
126 // Reason Management
127 // ========================================================================
128
132 std::vector<domain::change_reason> list_reasons();
133
137 std::vector<domain::change_reason>
138 list_reasons(std::uint32_t offset, std::uint32_t limit);
139
143 std::vector<domain::change_reason>
144 list_reasons_by_category(const std::string& category_code);
145
149 std::uint32_t get_reason_count();
150
154 std::optional<domain::change_reason> find_reason(const std::string& code);
155
161 void save_reason(const domain::change_reason& reason);
162
168 void save_reasons(const std::vector<domain::change_reason>& reasons);
169
175 void remove_reason(const std::string& code);
176
180 void remove_reasons(const std::vector<std::string>& codes);
181
188 std::vector<domain::change_reason> get_reason_history(const std::string& code);
189
190 // ========================================================================
191 // Validation
192 // ========================================================================
193
200 bool is_valid_reason_code(const std::string& code);
201
208 bool is_valid_category_code(const std::string& code);
209
210private:
213};
214
215}
216
217#endif
Implements logging infrastructure for ORE Studio.
Definition boost_severity.hpp:28
Context for the operations on a postgres database.
Definition context.hpp:47
Defines a specific reason for record changes.
Definition change_reason.hpp:48
Groups change reasons into logical categories.
Definition change_reason_category.hpp:46
Reads and writes change_reason_categories to data storage.
Definition change_reason_category_repository.hpp:35
Reads and writes change_reasons to data storage.
Definition change_reason_repository.hpp:35
Service for managing change reason categories and change reasons.
Definition change_management_service.hpp:43
bool is_valid_reason_code(const std::string &code)
Validates that a change reason code exists.
Definition change_management_service.cpp:204
std::vector< domain::change_reason_category > get_category_history(const std::string &code)
Gets the version history for a category.
Definition change_management_service.cpp:114
void save_reasons(const std::vector< domain::change_reason > &reasons)
Saves multiple change reasons (creates or updates).
Definition change_management_service.cpp:170
void save_reason(const domain::change_reason &reason)
Saves a change reason (creates or updates).
Definition change_management_service.cpp:160
std::vector< domain::change_reason > list_reasons_by_category(const std::string &category_code)
Lists change reasons for a specific category.
Definition change_management_service.cpp:138
void save_category(const domain::change_reason_category &category)
Saves a change reason category (creates or updates).
Definition change_management_service.cpp:69
void remove_category(const std::string &code)
Removes a change reason category.
Definition change_management_service.cpp:93
std::vector< domain::change_reason > get_reason_history(const std::string &code)
Gets the version history for a reason.
Definition change_management_service.cpp:195
void remove_reason(const std::string &code)
Removes a change reason.
Definition change_management_service.cpp:182
std::vector< domain::change_reason > list_reasons()
Lists all change reasons.
Definition change_management_service.cpp:124
std::uint32_t get_reason_count()
Gets the total count of active reasons.
Definition change_management_service.cpp:145
std::optional< domain::change_reason > find_reason(const std::string &code)
Finds a reason by its code.
Definition change_management_service.cpp:151
void remove_reasons(const std::vector< std::string > &codes)
Removes multiple change reasons.
Definition change_management_service.cpp:190
void remove_categories(const std::vector< std::string > &codes)
Removes multiple change reason categories.
Definition change_management_service.cpp:109
std::optional< domain::change_reason_category > find_category(const std::string &code)
Finds a category by its code.
Definition change_management_service.cpp:60
std::vector< domain::change_reason_category > list_categories()
Lists all change reason categories.
Definition change_management_service.cpp:41
bool is_valid_category_code(const std::string &code)
Validates that a category code exists.
Definition change_management_service.cpp:208
std::uint32_t get_category_count()
Gets the total count of active categories.
Definition change_management_service.cpp:54
void save_categories(const std::vector< domain::change_reason_category > &categories)
Saves multiple change reason categories (creates or updates).
Definition change_management_service.cpp:81