seb-win-refactoring/SafeExamBrowser.Configuration.Contracts/DataFormats/ParseResult.cs

/*
 * Copyright (c) 2024 ETH Zürich, IT Services
 * 
 * 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.Collections.Generic;
using SafeExamBrowser.Configuration.Contracts.Cryptography;

namespace SafeExamBrowser.Configuration.Contracts.DataFormats
{
	/// <summary>
	/// Defines the result of a data parsing operation by an <see cref="IDataParser"/>.
	/// </summary>
	public class ParseResult
	{
		/// <summary>
		/// The encryption parameters which were used to decrypt the data, or <c>null</c> if it was not encrypted.
		/// </summary>
		public EncryptionParameters Encryption { get; set; }

		/// <summary>
		/// The original format of the data.
		/// </summary>
		public FormatType Format { get; set; }

		/// <summary>
		/// The parsed settings data. Might be <c>null</c> or in an undefinable state, depending on <see cref="Status"/>.
		/// </summary>
		public IDictionary<string, object> RawData { get; set; }

		/// <summary>
		/// The status result of the parsing operation.
		/// </summary>
		public LoadStatus Status { get; set; }
	}
}