/*********************************************************************/
/*                                                                   */
/*                     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.ServiceModel;
using System.IO;
using System.Collections.Generic;
using System.Text;

namespace AgentService.Platform
{
    /// <summary>
    /// Interface IConsole. Exposes all the consoles used by
    /// the platform.
    /// </summary>
    public interface IConsole
    {
        /// <summary>
        /// Gets the input console. The input console
        /// provides the same facilities as the standard
        /// input for console application.
        /// </summary>
        TextReader Input
        {
            get;
        }
        /// <summary>
        /// Gets the platform main console. The main console
        /// represents the main standard ouput of the platform.
        /// </summary>
        TextWriter Main
        {
            get;
        }
        /// <summary>
        /// Gets the platform error console. The error console
        /// represents the standard error output of the platform.
        /// </summary>
        TextWriter Error
        {
            get;
        }
        /// <summary>
        /// Gets the platform warning console. The warning console
        /// is used either by the platform or by all those software
        /// components wich have a reference to the platform controller
        /// to post warning messages.
        /// </summary>
        TextWriter Warning
        {
            get;
        }

    }

    /// <summary>
    /// Interface IPlatformConsole. Gives access to the console of the AgentService 
    /// platform and offers the functionality to append messages to the console.
    /// </summary>
    public interface IAgentConsole
    {
        /// <summary>
        /// Appends a formatted message to the console
        /// </summary>
        /// <param name="source">string identifier of the entity who appends the message</param>
        /// <param name="message">formatted message</param>
        /// <param name="objects">arguments used in the formatted message</param>
        void AppendMessage(string source, string message, params object[] objects);

        /// <summary>
        /// Appends a message to the console
        /// </summary>
        /// <param name="source">string identifier of the entity who appends the message</param>
        /// <param name="message">message appended to the console</param>
        void AppendMessage(string source, string message);
    }

    /// <summary>
    /// Interface IPlatformConsole. Extends the IConsole and provides additional
    /// facility provided by the IAgentConsole interface. The console is
    /// extended with another field representing an additional console used
    /// by agents to post messages. IPlatformConsole provides shortcut methods to
    /// write to the three managed consoles.
    /// </summary>
    public interface IPlatformConsole : IConsole
    {
        IAgentConsole BlackBoard
        {
            get;
        }
   		/// <summary>
		/// Writes a line to the platform's output console and formats it properly.
		/// </summary>
		/// <param name="message">message content</param>
        void WriteLineMessage(string message);
		/// <summary>
		/// Writes a message to the platform's output console and formats it properly.
		/// </summary>
		/// <param name="message">message content</param>
        void WriteMessage(string message); 
		/// <summary>
		/// Appends a message to the current line of the platform's output console and 
		/// moves to new line.
		/// </summary>
		/// <param name="message">message content</param>
		void AppendMessage(string message);
		/// <summary>
		/// Writes an error to the ErrorConsole
		/// </summary>
		/// <param name="message">error description</param>
		void WriteError(string message);
		/// <summary>
		/// Writes an error to the Error console.
		/// </summary>
		/// <param name="message">error description</param>
		/// <param name="args">arguments</param>
		void WriteError(string message, params object[] args);
        /// <summary>
        /// Writes a warning message to the Warning console.
        /// </summary>
        /// <param name="message">warning message</param>
        void WriteWarning(string message);
        /// <summary>
        /// Writes a warning message to the Warning console.
        /// </summary>
        /// <param name="message">warning message</param>
        /// <param name="args">arguments</param>
        void WriteWarning(string message, params object[] args);
    }
}