// 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.Configuration;

namespace TERASOLUNA.Fw.Web.Configuration.ExceptionCode
{
    /// <summary>
    /// 例外コード設定ファイルの exceptionCode 要素を表します。
    /// </summary>
    /// <remarks>
    /// <see cref="ExceptionCodeElement"/> は、エラー画面遷移設定ファイル内の exceptionCode 要素を表します。 
    /// 詳細については <see cref="ConfigurationElement"/> を参照してください。
    /// </remarks>
    public sealed class ExceptionCodeElement : ConfigurationElement
    {
        /// <summary>
        /// exceptionType 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "exceptionType" です。
        /// </remarks>
        private const string EXCEPTION_TYPE_ATTRIBUTE_NAME = "exceptionType";

        /// <summary>
        /// code 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "code" です。
        /// </remarks>
        private const string CODE_ATTRIBUTE_NAME = "code";

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

        /// <summary>
        /// <see cref="ExceptionCodeElement"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="exceptionType">exceptionType 属性の値。Type の名前空間を含み、アセンブリを含まない、型の完全修飾名。</param>
        /// <param name="code">code 属性の値。<paramref name="exceptionType"/> の型に対する例外コード。</param>
        /// <remarks>
        /// exceptionType 属性、code 属性の値を exceptionType、code で初期化します。
        /// </remarks>
        public ExceptionCodeElement(string exceptionType, string code)
        {
            this[EXCEPTION_TYPE_ATTRIBUTE_NAME] = exceptionType;
            this[CODE_ATTRIBUTE_NAME] = code;
        }

        /// <summary>
        /// exceptionType 属性の値を取得します。
        /// </summary>
        /// <value>
        /// exceptionType 属性の値。
        /// </value>
        [ConfigurationProperty(EXCEPTION_TYPE_ATTRIBUTE_NAME, IsRequired = true, IsKey = true)]
        public string ExceptionType
        {
            get
            {
                return (string)this[EXCEPTION_TYPE_ATTRIBUTE_NAME];
            }
        }

        /// <summary>
        /// code 属性の値を取得します。
        /// </summary>
        /// <value>
        /// code 属性の値。
        /// </value>
        [ConfigurationProperty(CODE_ATTRIBUTE_NAME, IsRequired = true)]
        public string Code
        {
            get
            {
                return (string)this[CODE_ATTRIBUTE_NAME];
            }
        }
    }
}
