// Copyright (C) Stichting Deltares 2025. All rights reserved.
// 
// This file is part of the application DAM - UI.
// 
// DAM - UI 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/>.
// 
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

namespace Deltares.Standard.Specifications;

/// <summary>
/// 
/// </summary>
public interface ISpecification
{
    /// <summary>
    /// Gets or sets the name of the specification. (Short description)
    /// </summary>
    /// <value>
    /// The name string value should be a required property for each specification.
    /// </value>
    string Name { get; set; }

    /// <summary>
    /// Gets or sets the description of the specification. (Long description)
    /// </summary>
    /// <value>
    /// The description string value.
    /// </value>
    string Description { get; set; }

    /// <summary>
    /// Determines whether the candidate satisfies the specification.
    /// </summary>
    /// <param name="candidate">The candidate.</param>
    /// <returns>
    ///   <c>true</c> if the candidate satisfies the specification otherwise, <c>false</c>.
    /// </returns>
    bool IsSatisfiedBy(object candidate);
}

/// <summary>
/// 
/// </summary>
/// <typeparam name="TCandidate">The type of the candidate.</typeparam>
public interface ISpecification<in TCandidate> : ISpecification
{
    /// <summary>
    /// Determines whether the candidate satisfies the specification.
    /// </summary>
    /// <param name="candidate">The candidate.</param>
    /// <returns>
    ///   <c>true</c> if the candidate satisfies the specification otherwise, <c>false</c>.
    /// </returns>
    bool IsSatisfiedBy(TCandidate candidate);
}