/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library is distributed in the hope that it will be useful,   */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of    */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using System.IO;
using System.Text;

using AgentService.Interop;

namespace AgentService.Platform
{

    /// <summary>
    /// Interface IPlatformController. Gives access and
    /// manages the platform.
    /// </summary>
    public interface IPlatformController : ICommandContext
    {
        /// <summary>
        /// Gets access to the platform console sub-system.
        /// </summary>
        IConsole Console
        {
            get;
        }
        /*
        /// <summary>
        /// Gets the module controller reference.
        /// </summary>
        IModuleController Modules
        {
            get;
        }

        /// <summary>
        /// Gets the service controller reference.
        /// </summary>
        IServiceController Services
        {
            get;
        }
        

        #region Platform Related Members

        /// <summary>
        /// Gets the platform state if the
        /// Platform has been bound otherwise
        /// it returns the PlatformState.Unknown 
        /// state
        /// </summary>
        PlatformState PlatformState
        {
            get;
        }
        

        /// <summary>
        /// Gets the platform description, null if the
        /// platform has not been bound
        /// </summary>
        IPlatformDescription PlatformDescription
        {
            get;
        }
        #endregion
        */

        /// <summary>
        /// Starts the AgentService platform, and puts it in the ready state.
        /// </summary>
        void StartPlatform();
        /// <summary>
        /// Makes the platform running, by acivating first the core agents and
        /// then the user agents.
        /// </summary>
        void RunPlatform();
        /// <summary>
        /// Stops the platform and puts it into the ready state.
        /// </summary>
        void StopPlatform();
        /// <summary>
        /// Restarts the AgentService platform. Restart implies the shutdown and start.
        /// </summary>
        void RestartPlatform();
        /// <summary>
        /// Shuts down the AgentService platform.
        /// </summary>
        void ShutdownPlatform();


        /// <summary>
        /// Attaches a shell to the platform.
        /// </summary>
        /// <param name="inputConsole">platform shell, if null the current shell is detached from the platform</param>
        void BindToInput(TextReader inputConsole);
        /// <summary>
        /// Sets the output console for the AgentService platform.
        /// </summary>
        /// <param name="errorConsole">Reference to the TextWriter object used as error console.</param>
        /// <param name="mainConsole">Reference to the TextWriter object used as main console.</param>
        /// <param name="platformConsole">Reference to the TextWriter object used by agents as console.</param>
        void BindToOutputs(TextWriter mainConsole, TextWriter errorConsole, TextWriter platformConsole);
        /// <summary>
        /// Sets the output console for the AgentService platform.
        /// </summary>
        /// <param name="errorConsole">reference to the TextWriter object used as error console</param>
        /// <param name="mainConsole">reference to the TextWriter object used as main console</param>
        /// <param name="warningConsole">reference to the RextWriter object used as warning console</param>
        /// <param name="platformConsole">reference to the TextWriter object used by agents as console</param>
        void BindToOutputs(TextWriter mainConsole, TextWriter errorConsole, TextWriter warningConsole, TextWriter platformConsole);

    }
}