seb-win-refactoring/SafeExamBrowser.Core.Contracts/OperationModel/IOperation.cs

38 lines
1.1 KiB
C#

/*
* Copyright (c) 2022 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.Core.Contracts.OperationModel.Events;
namespace SafeExamBrowser.Core.Contracts.OperationModel
{
/// <summary>
/// Defines an operation which will be executed as part of an <see cref="IOperationSequence"/>.
/// </summary>
public interface IOperation
{
/// <summary>
/// Event fired when the operation requires user interaction.
/// </summary>
event ActionRequiredEventHandler ActionRequired;
/// <summary>
/// Event fired when the status of the operation has changed.
/// </summary>
event StatusChangedEventHandler StatusChanged;
/// <summary>
/// Performs the operation.
/// </summary>
OperationResult Perform();
/// <summary>
/// Reverts all changes made when executing the operation.
/// </summary>
OperationResult Revert();
}
}