// Copyright (c) 2008, NTT DATA Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using TERASOLUNA.Fw.Common;

namespace TERASOLUNA.Fw.Client.Communication
{
    /// <summary>
    /// 通信時にサーバで例外が発生したことを表す例外クラスです。
    /// </summary>
    [Serializable]
    public class ServerException : Exception
    {
        /// <summary>
        /// サーバで発生したエラータイプ(例外種別)。
        /// </summary>
        private string _errorType = null;

        /// <summary>
        /// サーバで発生した例外のメッセージのリスト。
        /// </summary>
        private IList<MessageInfo> _errors = new List<MessageInfo>();

        /// <summary>
        /// サーバで発生したエラータイプ(例外種別)を取得します。
        /// </summary>
        /// <value>サーバで発生したエラータイプ(例外種別)。</value>
        public string ErrorType
        {
            get
            {
                return _errorType;
            }
        }

        /// <summary>
        /// サーバで発生した例外のメッセージのリストを取得します。
        /// </summary>
        /// <value>サーバで発生した例外のメッセージのリスト。</value>
        public IList<MessageInfo> Errors
        {
            get
            {
                return _errors;
            }
        }

        /// <summary>
        /// <see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタ。
        /// </remarks>
        public ServerException()
            : base()
        {
        }

        /// <summary>
        /// 指定したエラー メッセージを使用して、<see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">例外の原因を説明するエラー メッセージ。</param>
        /// <remarks>
        /// コンストラクタ。
        /// </remarks>
        public ServerException(string message)
            : base(message)
        {
        }

        /// <summary>
        /// 指定したエラー メッセージと、この例外の原因である内部例外への参照を使用して、
        /// <see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">例外の原因を説明するエラー メッセージ。</param>
        /// <param name="innerException">現在の例外の原因である例外。内部例外が指定されていない場合は、null 参照。</param>
        public ServerException(string message, Exception innerException)
            : base(message, innerException)
        {
        }

        /// <summary>
        /// 指定したエラー メッセージと、サーバで発生したエラータイプ(例外種別)を使用して、
        /// <see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>コンストラクタ。</remarks>
        /// <param name="message">例外の原因を説明するエラー メッセージ。</param>
        /// <param name="errorType">サーバで発生したエラータイプ(例外種別)。</param>
        public ServerException(string message, string errorType)
            : base(message)
        {
            _errorType = errorType;
        }

        /// <summary>
        /// 指定したエラー メッセージ、サーバで発生したエラータイプ(例外種別)とエラーメッセージリストを使用して、
        /// <see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">例外の原因を説明するエラー メッセージ。</param>
        /// <param name="errorType">サーバで発生したエラータイプ(例外種別)。</param>
        /// <param name="errors">サーバで発生した例外のメッセージのリスト。</param>
        public ServerException(string message, string errorType, IList<MessageInfo> errors)
            : this(message, errorType)
        {
            _errors = errors;
        }

        /// <summary>
        /// シリアル化したデータを使用して、<see cref="ServerException"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="info">シリアル化されたオブジェクト データを保持するオブジェクト。</param>
        /// <param name="context">転送元または転送先に関するコンテキスト情報。</param>
        /// <remarks>デシリアライズされる際に呼び出されます。</remarks>
        protected ServerException(SerializationInfo info, StreamingContext context)
            : base(info, context)
        {
        }
    }
}
