// 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.Collections.Generic;
using System.Data;

namespace TERASOLUNA.Fw.Common.BLogic
{
    /// <summary>
    /// ビジネスロジックの実行に必要な情報を格納するためのクラスです。
    /// </summary>
    /// <remarks>
    /// <para>
    /// <seealso cref="IBLogic.Execute"/> はこのクラスのインスタンスを引数にとります。
    /// </para>
    /// </remarks>
    public class BLogicParam
    {
        /// <summary>
        /// ビジネスロジックの実行に必要なパラメータを格納する <see cref="DataSet"/> です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private DataSet _paramData = null;

        /// <summary>
        /// ビジネスロジックの実行に必要なパラメータを格納する <see cref="IDictionary{String,Object}"/> です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、空の <see cref="Dictionary{String,Object}"/> です。
        /// </remarks>
        private IDictionary<string,object> _items = new Dictionary<string , object>();

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

        /// <summary>
        /// <see cref="BLogicParam"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="paramData">ビジネスロジック入力 <see cref="DataSet"/></param>
        public BLogicParam(DataSet paramData)
        {
            _paramData = paramData;
        }

        /// <summary>
        /// ビジネスロジックの実行に必要なパラメータを格納する <see cref="DataSet"/> を取得または設定します。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public DataSet ParamData
        {
            get { return _paramData; }
            set { _paramData = value; }
        }

        /// <summary>
        /// ビジネスロジックの実行に必要なパラメータを格納する <see cref="IDictionary{String,Object}"/> 
        /// を取得します。
        /// </summary>
        public IDictionary<string, object> Items
        {
            get { return _items; }
        }

    }
}
