seb-win-refactoring/SafeExamBrowser.Contracts/Behaviour/Operations/IOperation.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 SafeExamBrowser.Contracts.UserInterface;

namespace SafeExamBrowser.Contracts.Behaviour.Operations
{
	public interface IOperation
	{
		/// <summary>
		/// Determines whether the procedure to which this operation belongs to should be aborted.
		/// </summary>
		bool Abort { get; }

		/// <summary>
		/// The progress indicator to be used to show status information to the user. Will be ignored if <c>null</c>.
		/// </summary>
		IProgressIndicator ProgressIndicator { set; }

		/// <summary>
		/// Performs the operation.
		/// </summary>
		void Perform();

		/// <summary>
		/// Repeats the operation.
		/// </summary>
		void Repeat();

		/// <summary>
		/// Reverts all changes which were made when performing the operation.
		/// </summary>
		void Revert();
	}
}