"""
                    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.analysis.analysis_collection import AnalysisCollection
from ra2ce.analysis.analysis_protocol import AnalysisProtocol
from ra2ce.analysis.analysis_result.analysis_result_wrapper_protocol import (
    AnalysisResultWrapperProtocol,
)


@runtime_checkable
class AnalysisRunner(Protocol):
    def can_run(
        self, analysis: AnalysisProtocol, analysis_collection: AnalysisCollection
    ) -> bool:
        """
        Validates whether the given `ConfigWrapper` is eligibile for this `AnalysisRunner`.

        Args:
            analysis (AnalysisProtocol): Analysis to be run on this `AnalysisRunner`.
            analysis_collection (AnalysisCollection): Collection of analyses to be run on this `AnalysisRunner`.

        Returns:
            bool: Whether the `ConfigWrapper` can be run or not.
        """

    def run(
        self, analysis_collection: AnalysisCollection
    ) -> list[AnalysisResultWrapperProtocol]:
        """
        Runs this `AnalysisRunner` for the given analysis collection.

        Args:
            analysis_collection (AnalysisCollection): Collection of analyses to be run on this `AnalysisRunner`.

        Returns:
            list[AnalysisResultWrapperProtocol]: List of all results for all ran analysis.
        """
