// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;

namespace Microsoft.ClearScript
{
    /// 
    /// Defines common script engine exception properties.
    /// 
    public interface IScriptEngineException
    {
        /// 
        /// Gets the error message.
        /// 
        string Message { get; }

        /// 
        /// Gets an HRESULT error code if one is available, zero otherwise.
        /// 
        int HResult { get; }

        /// 
        /// Gets the name associated with the script engine instance.
        /// 
        string EngineName { get; }

        /// 
        /// Gets a detailed error message if one is available, null otherwise.
        /// 
        string ErrorDetails { get; }

        /// 
        /// Gets a value that indicates whether the exception represents a fatal error.
        /// 
        bool IsFatal { get; }

        /// 
        /// Gets a value that indicates whether script code execution had started before the current exception was thrown.
        /// 
        bool ExecutionStarted { get; }

        /// 
        /// Gets the script exception that caused the current exception to be thrown, or null if one was not specified.
        /// 
        dynamic ScriptException { get; }

        /// 
        /// Gets the script exception that caused the current exception to be thrown, or null if one was not specified, without engaging the dynamic infrastructure.
        /// 
        object ScriptExceptionAsObject { get; }

        /// 
        /// Gets the host exception that caused the current exception to be thrown, or null if one was not specified.
        /// 
        Exception InnerException { get; }
    }
}