namespace Wayne.ForecourtControl
{
    /// <summary>   
    /// The Forecourt Config interface is used to configure the forecourt 
    /// using XML documents. The Xml document should conform to the 
    /// ForecourtConfig.xsd schema.
    /// </summary>
    public interface IForecourtConfig
    {
        /// <summary>
        /// Reads the Forecourt control configuration and returns
        /// a XML structure.
        /// </summary>
        /// <returns>An Xml document as a string</returns>
        /// <exception cref="ForecourtControlException">If the configuration reading fails.</exception>
        string ReadConfiguration();

        /// <summary>
        /// Writes the specified configuration XML to the forecourt control.
        /// </summary>
        /// <param name="configurationXml">A valid ForecourtConfig xml file.</param>
        /// <exception cref="ForecourtControlException">If the configuration writing fails.</exception>
        void WriteConfiguration(string configurationXml);
    }
}