// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser 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 Core.Common.Utils.Settings
{
    /// <summary>
    /// Interface declaring the members of the object that holds settings.
    /// </summary>
    public interface ISettingsHelper
    {
        /// <summary>
        /// Gets the name of the application.
        /// </summary>
        string ApplicationName { get; }

        /// <summary>
        /// Gets the version of the application.
        /// </summary>
        string ApplicationVersion { get; }

        /// <summary>
        /// Gets the application local user settings directory.
        /// </summary>
        /// <param name="subPath">The sub path to use after the local application data folder (if any).</param>
        /// <returns>Directory path where the user settings can be found.</returns>
        string GetApplicationLocalUserSettingsDirectory(params string[] subPath);

        /// <summary>
        /// Gets the common documents directory.
        /// </summary>
        /// <param name="subPath">The sub path to use after the common documents folder (if any).</param>
        /// <returns>Directory path where the common documents can be found.</returns>
        string GetCommonDocumentsDirectory(params string[] subPath);

        /// <summary>
        /// Gets the directory of the current user's temporary folder.
        /// </summary>
        /// <returns>Directory path of the current user's temporary folder.</returns>
        string GetLocalUserTemporaryDirectory();
    }
}