ORE Studio 0.0.4
Loading...
Searching...
No Matches
badge_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_DQ_DOMAIN_BADGE_DEFINITION_HPP
21#define ORES_DQ_DOMAIN_BADGE_DEFINITION_HPP
22
23#include <chrono>
24#include <optional>
25#include <string>
26#include "ores.utility/uuid/tenant_id.hpp"
27
28namespace ores::dq::domain {
29
41struct badge_definition final {
45 int version = 0;
46
51
57 std::string code;
58
62 std::string name;
63
67 std::string description;
68
74 std::string background_colour;
75
81 std::string text_colour;
82
88 std::string severity_code;
89
95 std::string css_class;
96
101
105 std::string modified_by;
106
110 std::string performed_by;
111
118
122 std::string change_commentary;
123
127 std::chrono::system_clock::time_point recorded_at;
128};
129
130}
131
132#endif
Visual definition for a badge, including colours, label, and severity.
Definition badge_definition.hpp:41
int display_order
Order for UI display purposes.
Definition badge_definition.hpp:100
std::string modified_by
Username of the person who last modified this badge definition.
Definition badge_definition.hpp:105
std::string text_colour
Badge text colour as a hex string.
Definition badge_definition.hpp:81
std::string change_commentary
Free-text commentary explaining the change.
Definition badge_definition.hpp:122
std::string description
Tooltip text explaining what this badge represents.
Definition badge_definition.hpp:67
std::string code
Unique badge definition code.
Definition badge_definition.hpp:57
std::string background_colour
Badge background colour as a hex string.
Definition badge_definition.hpp:74
std::string css_class
Optional Bootstrap CSS class hint for Wt rendering.
Definition badge_definition.hpp:95
std::chrono::system_clock::time_point recorded_at
Timestamp when this version of the record was recorded.
Definition badge_definition.hpp:127
std::string name
Display label shown inside the badge.
Definition badge_definition.hpp:62
int version
Version number for optimistic locking and change tracking.
Definition badge_definition.hpp:45
std::string performed_by
Username of the account that performed this action.
Definition badge_definition.hpp:110
utility::uuid::tenant_id tenant_id
Tenant identifier for multi-tenancy isolation.
Definition badge_definition.hpp:50
std::string change_reason_code
Code identifying the reason for the change.
Definition badge_definition.hpp:117
std::string severity_code
Severity classification for this badge.
Definition badge_definition.hpp:88
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