// 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.Data;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Common.BLogic
{
    /// <summary>
    /// ビジネスロジックの実行結果を格納するためのクラスです。
    /// </summary>
    /// <remarks>
    /// <para>
    /// <seealso cref="IBLogic.Execute"/> はこのクラスのインスタンスを返却します。
    /// </para>
    /// </remarks>
    public class BLogicResult
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(BLogicResult));

        /// <summary>
        /// ビジネスロジックで正常に処理が終了した時、<see cref="BLogicResult"/> に渡す結果文字列です。
        /// </summary>
        /// <remarks>
        /// <para>
        /// この定数の値は "success" です。
        /// </para>
        /// </remarks>
        public static readonly string SUCCESS = "success";

        /// <summary>
        /// ビジネスロジックの実行結果を表す結果文字列です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private string _resultString = null;

        /// <summary>
        /// ビジネスロジックの実行結果を格納する <see cref="DataSet"/> です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private DataSet _resultData = null;

        /// <summary>
        /// エラーメッセージを保持するリストです。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、空の <see cref="List{MessageInfo}"/> です。
        /// </remarks>
        private IList<MessageInfo> _errors = new List<MessageInfo>();

        /// <summary>
        /// ビジネスロジックの実行結果情報を格納した <see cref="Dictionary{String,Object}"/> です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、空の <see cref="Dictionary{String,Object}"/> です。
        /// </remarks>
        private IDictionary<string, object> _items = new Dictionary<string, object>();

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

        /// <summary>
        /// <see cref="BLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="resultString">ビジネスロジックの結果文字列。</param>
        public BLogicResult(string resultString) : this(resultString, null)
        {
        }

        /// <summary>
        /// <see cref="BLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="resultString">ビジネスロジックの結果文字列。</param>
        /// <param name="resultData">ビジネスロジック出力 <see cref="DataSet"/></param>
        public BLogicResult(string resultString, DataSet resultData)
        {
            _resultString = resultString;
            _resultData = resultData;
        }

        /// <summary>
        /// ビジネスロジックの実行結果を表す結果文字列を取得または設定します。
        /// </summary>
        /// <value>
        /// ビジネスロジックの結果文字列。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public string ResultString
        {
            get
            {
                return _resultString;
            }
            set
            {
                _resultString = value;
            }
        }

        /// <summary>
        /// ビジネスロジック出力 <see cref="DataSet"/> を取得または設定します。
        /// </summary>
        /// <value>
        /// ビジネスロジック出力 <see cref="DataSet"/> 。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public DataSet ResultData
        {
            get
            {
                return _resultData;
            }
            set
            {
                _resultData = value;
            }
        }

        /// <summary>
        /// 実行結果のエラーメッセージリストを取得します。
        /// </summary>
        /// <value>
        /// 実行結果のエラーメッセージリスト。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、空の <see cref="List{MessageInfo}"/> インスタンスです。
        /// </remarks>
        public IList<MessageInfo> Errors
        {
            get
            {
                return _errors;
            }
        }

        /// <summary>
        /// ビジネスロジックの実行結果情報を格納した <see cref="IDictionary{String,Object}"/> 
        /// を取得します。
        /// </summary>
        public IDictionary<string, object> Items
        {
            get { return _items; }
        }

        /// <summary>
        /// 実行結果のエラーメッセージを一括して追加します。
        /// </summary>
        /// <remarks>
        /// 実行結果のエラーメッセージを <paramref name="Errors"/> に追加します。
        /// </remarks>
        /// <param name="messages">追加したいエラーメッセージリスト。</param>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="messages"/> が null 参照です。
        /// </exception>
        public virtual void AddErrors(IList<MessageInfo> messages)
        {
            if (messages == null)
            {
                ArgumentNullException exception = new ArgumentNullException("messages");
                if(_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Properties.Resources.E_NULL_ARGUMENT, "messages"), exception);
                }
                throw exception;
            } 
            
            foreach (MessageInfo message in messages)
            {
                _errors.Add(message);
            }
        }
    }
}
