seb-win-refactoring/SafeExamBrowser.Contracts/Behaviour/IClientController.cs

49 lines
1.3 KiB
C#

/*
* 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.Communication;
using SafeExamBrowser.Contracts.Configuration;
using SafeExamBrowser.Contracts.Configuration.Settings;
namespace SafeExamBrowser.Contracts.Behaviour
{
// TODO: Interface really needed?!
public interface IClientController
{
/// <summary>
/// The client host used for communication handling.
/// </summary>
IClientHost ClientHost { set; }
/// <summary>
/// The runtime information to be used during application execution.
/// </summary>
RuntimeInfo RuntimeInfo { set; }
/// <summary>
/// The session identifier of the currently running session.
/// </summary>
Guid SessionId { set; }
/// <summary>
/// The settings to be used during application execution.
/// </summary>
Settings Settings { set; }
/// <summary>
/// Reverts any changes, releases all used resources and terminates the client.
/// </summary>
void Terminate();
/// <summary>
/// Tries to start the client. Returns <c>true</c> if successful, otherwise <c>false</c>.
/// </summary>
bool TryStart();
}
}