// 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.Page
{
    /// <summary>
    /// ページ設定ファイルの page 要素を表します。
    /// </summary>
    /// <remarks>
    /// <see cref="PageElement"/> は、ページ設定ファイル内の page 要素を表します。 
    /// 詳細については <see cref="ConfigurationElement"/> を参照してください。
    /// </remarks>
    public sealed class PageElement : ConfigurationElement
    {
        /// <summary>
        /// name 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "name" です。
        /// </remarks>
        private const string NAME_ATTRIBUTE_NAME = "name";

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

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

        /// <summary>
        /// setToken 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "setToken" です。
        /// </remarks>
        private const string NAME_ATTRIBUTE_SETTOKEN = "setToken";
        
        /// <summary>
        /// checkToken 属性の属性名です。
        /// </summary>
        /// <remarks>
        /// この定数の値は "checkToken" です。
        /// </remarks>
        private const string NAME_ATTRIBUTE_CHECKTOKEN = "checkToken";

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

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

        /// <summary>
        /// <see cref="PageElement"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="name">name 属性。</param>
        /// <param name="path">path 属性。</param>
        /// <param name="preventDoubleSubmit">preventDoubleSubmit 属性。</param>
        /// <param name="setToken">setToken 属性。</param>
        /// <param name="checkToken">checkToken 属性。</param>
        /// <param name="updateToken">updateToken 属性。</param>
        /// <remarks>
        /// 属性を指定した値で初期化します。
        /// </remarks>
        public PageElement(string name, string path, string preventDoubleSubmit, string setToken, string checkToken, string updateToken)
        {
            this[NAME_ATTRIBUTE_NAME] = name;
            this[NAME_ATTRIBUTE_PATH] = path;
            this[NAME_ATTRIBUTE_PDS] = preventDoubleSubmit;
            this[NAME_ATTRIBUTE_SETTOKEN] = setToken;
            this[NAME_ATTRIBUTE_CHECKTOKEN] = checkToken;
            this[NAME_ATTRIBUTE_UPDATETOKEN] = updateToken;
        }

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

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

        /// <summary>
        /// preventDoubleSubmit 属性の値を取得します。
        /// </summary>
        /// <value>
        /// preventDoubleSubmit 属性の値。
        /// </value>
        [ConfigurationProperty(NAME_ATTRIBUTE_PDS, DefaultValue = "on")]
        public string Pds
        {
            get
            {
                return (string)this[NAME_ATTRIBUTE_PDS];
            }
        }

        /// <summary>
        /// setToken 属性の値を取得します。
        /// </summary>
        /// <value>
        /// setToken 属性の値。
        /// </value>
        [ConfigurationProperty(NAME_ATTRIBUTE_SETTOKEN, DefaultValue = "on")]
        public string SetToken
        {
            get
            {
                return (string)this[NAME_ATTRIBUTE_SETTOKEN];
            }
        }

        /// <summary>
        /// checkToken 属性の値を取得します。
        /// </summary>
        /// <value>
        /// checkToken 属性の値。
        /// </value>
        [ConfigurationProperty(NAME_ATTRIBUTE_CHECKTOKEN, DefaultValue = "on")]
        public string CheckToken
        {
            get
            {
                return (string)this[NAME_ATTRIBUTE_CHECKTOKEN];
            }
        }

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

    }
}
