EntityDetailOperations.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2026 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_QT_ENTITY_DETAIL_OPERATIONS_HPP
#define ORES_QT_ENTITY_DETAIL_OPERATIONS_HPP
 
#include <optional>
#include <string>
#include <vector>
#include <boost/uuid/uuid.hpp>
#include "ores.qt/export.hpp"
 
namespace ores::qt {
 
class ClientManager;
 
struct operation_result final {
    bool success;
    std::string message;
};
 
struct parent_entity_entry final {
    boost::uuids::uuid id;
    std::string short_code;
    std::string full_name;
    std::string status;
    std::optional<boost::uuids::uuid> parent_id;
};
 
struct identifier_entry final {
    boost::uuids::uuid id;
    boost::uuids::uuid owner_id; 
    std::string id_scheme;
    std::string id_value;
    std::string description;
    std::string modified_by;
    std::string performed_by;
};
 
struct contact_entry final {
    boost::uuids::uuid id;
    boost::uuids::uuid owner_id; 
    std::string contact_type;
    std::string street_line_1;
    std::string street_line_2;
    std::string city;
    std::string state;
    std::string country_code;
    std::string postal_code;
    std::string phone;
    std::string email;
    std::string web_page;
    std::string modified_by;
    std::string performed_by;
};
 
struct entity_data final {
    int version = 0;
    std::string tenant_id;
    boost::uuids::uuid id;
    std::string full_name;
    std::string short_code;
    std::optional<std::string> codename; 
    std::optional<std::string> transliterated_name;
    std::optional<std::string> party_category; 
    std::string party_type;
    std::optional<boost::uuids::uuid> parent_id;
    std::string business_center_code;
    std::string status;
    std::string modified_by;
    std::string performed_by;
    std::string change_reason_code;
    std::string change_commentary;
    std::chrono::system_clock::time_point recorded_at;
};
 
struct load_all_entities_result final {
    std::vector<parent_entity_entry> entities;
    bool success;
};
 
struct load_identifiers_result final {
    std::vector<identifier_entry> identifiers;
    bool success;
};
 
struct load_contacts_result final {
    std::vector<contact_entry> contacts;
    bool success;
};
 
class ORES_QT_API entity_detail_operations {
public:
    virtual ~entity_detail_operations() = default;
 
    [[nodiscard]] virtual std::string entity_type_name() const = 0;
 
    [[nodiscard]] virtual bool has_party_category() const = 0;
 
    [[nodiscard]] virtual operation_result save_entity(
        ClientManager* cm, const entity_data& data) const = 0;
 
    [[nodiscard]] virtual operation_result delete_entity(
        ClientManager* cm, const boost::uuids::uuid& id) const = 0;
 
    [[nodiscard]] virtual load_all_entities_result load_all_entities(
        ClientManager* cm) const = 0;
 
    [[nodiscard]] virtual load_identifiers_result load_identifiers(
        ClientManager* cm, const boost::uuids::uuid& entity_id) const = 0;
 
    [[nodiscard]] virtual operation_result save_identifier(
        ClientManager* cm, const identifier_entry& entry) const = 0;
 
    [[nodiscard]] virtual operation_result delete_identifier(
        ClientManager* cm, const boost::uuids::uuid& id) const = 0;
 
    [[nodiscard]] virtual load_contacts_result load_contacts(
        ClientManager* cm, const boost::uuids::uuid& entity_id) const = 0;
 
    [[nodiscard]] virtual operation_result save_contact(
        ClientManager* cm, const contact_entry& entry) const = 0;
 
    [[nodiscard]] virtual operation_result delete_contact(
        ClientManager* cm, const boost::uuids::uuid& id) const = 0;
};
 
}
 
// Forward declarations for domain types used by conversion functions.
namespace ores::refdata::domain {
struct counterparty;
struct party;
}
 
namespace ores::qt {
 
ORES_QT_API entity_data to_entity_data(const refdata::domain::counterparty& cpty);
 
ORES_QT_API entity_data to_entity_data(const refdata::domain::party& party);
 
}
 
#endif