change_reason.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_DQ_API_DOMAIN_CHANGE_REASON_HPP
#define ORES_DQ_API_DOMAIN_CHANGE_REASON_HPP
 
#include <chrono>
#include <optional>
#include <string>
 
namespace ores::dq::domain {
 
struct change_reason final {
    int version = 0;
 
    std::string tenant_id;
 
    std::string code;
 
    std::string description;
 
    std::string category_code;
 
    bool applies_to_new = false;
 
    bool applies_to_amend = true;
 
    bool applies_to_delete = true;
 
    bool requires_commentary = false;
 
    int display_order = 0;
 
    std::string modified_by;
 
    std::string change_commentary;
 
    std::string performed_by;
 
    std::chrono::system_clock::time_point recorded_at;
};
 
namespace change_reasons {
    // System reasons
    constexpr auto system_initial_load        = "system.initial_load";
    constexpr auto system_new_record          = "system.new_record";
    constexpr auto system_external_data_import = "system.external_data_import";
    constexpr auto system_import              = "system.import";
    constexpr auto system_test                = "system.test";
    constexpr auto system_tenant_terminated   = "system.tenant_terminated";
 
    // Static data reasons
    constexpr auto static_data_front_office_error = "static_data.front_office_error";
    constexpr auto static_data_back_office_error  = "static_data.back_office_error";
    constexpr auto static_data_regulatory_change  = "static_data.regulatory_change";
    constexpr auto static_data_corporate_action   = "static_data.corporate_action";
}
 
}
 
#endif