seb-win-refactoring/SafeExamBrowser.Contracts/Configuration/IConfigurationRepository.cs

/*
 * Copyright (c) 2018 ETH Zürich, Educational Development and Technology (LET)
 * 
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

using System;
using SafeExamBrowser.Contracts.Configuration.Settings;

namespace SafeExamBrowser.Contracts.Configuration
{
	public interface IConfigurationRepository
	{
		/// <summary>
		/// Retrieves the current session, i.e. the last one which was initialized. If no session has been initialized yet, this
		/// property will be <c>null</c>!
		/// </summary>
		ISession CurrentSession { get; }

		/// <summary>
		/// Retrieves the current settings, i.e. the last ones which were loaded. If no settings have been loaded yet, this property will
		/// be <c>null</c>!
		/// </summary>
		Settings.Settings CurrentSettings { get; }

		/// <summary>
		/// The runtime information for the currently running application instance.
		/// </summary>
		RuntimeInfo RuntimeInfo { get; }

		/// <summary>
		/// Builds a configuration for the client component, given the currently loaded settings, session and runtime information.
		/// </summary>
		ClientConfiguration BuildClientConfiguration();

		/// <summary>
		/// Initializes all relevant data for a new session.
		/// </summary>
		ISession InitializeSession();

		/// <summary>
		/// Attempts to load settings from the specified path.
		/// </summary>
		/// <exception cref="ArgumentException">Thrown if the given path cannot be resolved to a settings file.</exception>
		Settings.Settings LoadSettings(Uri path);

		/// <summary>
		/// Loads the default settings.
		/// </summary>
		Settings.Settings LoadDefaultSettings();
	}
}