"""
                GNU GENERAL PUBLIC LICENSE
                  Version 3, 29 June 2007

Risk Assessment and Adaptation for Critical Infrastructure (RA2CE).
Copyright (C) 2023-2026 Stichting Deltares

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, see <http://www.gnu.org/licenses/>.
"""

from typing import Protocol, runtime_checkable

from ra2ce.common.validation.validation_report import ValidationReport


@runtime_checkable
class AnalysisConfigDataProtocol(Protocol):
    """
    Reflects all common settings that damages and losses analysis sections might contain.
    """

    name: str
    save_gpkg: bool
    save_csv: bool

    def validate_integrity(self) -> ValidationReport:
        """
        Validates the integrity of the config data instance. This includes checking for required fields,
        valid value ranges, and consistency between related fields.

        Returns:
            ValidationReport: The validation report containing the results of the integrity check.
        """
        pass
