namespace Deltares.Standard.Specifications
{
    /// <summary>
    /// Abstract specification class that implements base properties
    /// </summary>
    /// <typeparam name="TCandidate">The type of the candidate.</typeparam>
    public abstract class SpecificationBase<TCandidate> : ISpecification<TCandidate>
    {
        protected SpecificationBase()
        {
            Name = this.GetType().Name;
        }

        /// <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>
        public string Name { get; set; }

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

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

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