// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of the DAM Engine.
//
// The DAM Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero 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 Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero 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.

using System;
using System.Collections;

namespace Deltares.DamEngine.Calculators.General
{
    /// <summary>
    /// Application context class, which governs application wide overrides for visibility,
    /// enabledness or domain data collections.
    /// </summary>
    public interface IContext
    {
        /// <summary>
        /// Method indicating a visibility override value for a given instance object.
        /// </summary>
        /// <param name="source">Object being evaluated.</param>
        /// <param name="member">Name of the member which is part of <paramref name="source"/>.</param>
        /// <returns>True if visible; False if hidden; Null if no override.</returns>
        bool? IsVisible(object source, string member);

        /// <summary>
        /// Method indicating if the enabled override value for a given instance object.
        /// </summary>
        /// <param name="source">Object being evaluated.</param>
        /// <param name="member">Name of the member which is part of <paramref name="source"/>.</param>
        /// <returns>True if enabled; False if disabled; Null if no override.</returns>
        bool? IsEnabled(object source, string member);

        /// <summary>
        /// Method returning a collection of domain object for list or enum type members;
        /// </summary>
        /// <param name="source">Object being evaluated.</param>
        /// <param name="member">Name of the member which is part of <paramref name="source"/>.</param>
        /// <returns>A collection of domain object; Null if no override.</returns>
        ICollection GetDomain(object source, string member);

        /// <summary>
        /// Indicates to <see cref="Validator"/> whether to perform the validation on the property or the method
        /// </summary>
        /// <param name="source">Object being evaluated.</param>
        /// <param name="member">Name of the member which is part of <paramref name="source"/>.</param>
        /// <returns>True or false if validation should be (or not be) performed; Null if no preference is given, but left over to the caller.</returns>
        bool? ShouldValidate(object source, string member);

        /// <summary>
        /// Gets the minimum value for a member.
        /// </summary>
        /// <param name="source">The source.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        double? GetMinimum(object source, string member);

        /// <summary>
        /// Gets the maximum value for a member.
        /// </summary>
        /// <param name="source">The source.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        double? GetMaximum(object source, string member);

        /// <summary>
        /// Gets the format string for a member.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="source">The source.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        string GetFormat(Type type, object source, string member);

        /// <summary>
        /// Gets the default value for a memner.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        object GetDefault(Type type, string member);
        // waar is dit het handigst te implementeren (qua gebruik van)?

        /// <summary>
        /// Gets the property order for UI display purposes.
        /// </summary>
        /// <param name="type">The type.</param>
        /// <param name="member">The member.</param>
        /// <returns></returns>
        int[] GetPropertyOrder(Type type, string member);
        // is dit handig? Zo ja, dan ook een idee voor de andere attr?
    }
}