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


namespace TERASOLUNA.Fw.Common
{
    /// <summary>
    /// メッセージ情報を保持します。
    /// </summary>
    public class MessageInfo
    {
        /// <summary>
        /// メッセージ本文。
        /// </summary>
        private string _message = null;

        /// <summary>
        /// メッセージキーを表します。
        /// </summary>
        private string _key = null;

        /// <summary>
        /// メッセージ詳細情報オブジェクトです。
        /// </summary>
        private object _detail = null;

        /// <summary>
        /// メッセージ本文を取得または設定します。
        /// </summary>
        /// <value>
        /// メッセージ本文。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public string Message
        {
            get
            {
                return _message;
            }
            set
            {
                _message = value;
            }
        }

        /// <summary>
        /// メッセージキーを取得または設定します。
        /// </summary>
        /// <value>
        /// メッセージキー。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public string Key
        {
            get 
            { 
                return _key; 
            }
            set 
            { 
                _key = value; 
            }
        }

        /// <summary>
        /// メッセージ詳細情報オブジェクトを取得または設定します。
        /// </summary>
        /// <value>
        /// メッセージ詳細情報オブジェクト。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public object Detail
        {
            get
            { 
                return _detail; 
            }
            set 
            { 
                _detail = value; 
            }
        }
	
        /// <summary>
        /// 指定したメッセージ本文を利用して、
        /// <see cref="MessageInfo"/>
        /// の新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="message">設定するメッセージ。</param>
        /// <remarks>
        /// <seealso cref="MessageInfo(string, string)"/> を呼び出します。
        /// <see cref="MessageType"/> は規定値で <seealso cref="MessageType.None"/> を設定します。
        /// </remarks>
        public MessageInfo(string message)
            : this(null, message)
        {
        }
        
        /// <summary>
        /// 指定したメッセージキー、メッセージ本文を使用して、
        /// <see cref="MessageInfo"/>
        /// の新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="key">メッセージキー。</param>
        /// <param name="message">メッセージ本文。</param>
        public MessageInfo(string key, string message)
        {
            _key = key;
            _message = message;
        }
    }
}
