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

namespace TERASOLUNA.Fw.Common.BLogic
{
    /// <summary>
    /// TERASOLUNA が提供するサービス層のクラスを実装することができるインターフェイスです。
    /// </summary>
    public interface IBLogic
    {
        /// <summary>
        /// ビジネスロジックを実行します。
        /// </summary>
        /// <remarks>
        /// ビジネスロジックが実行するメソッドの抽象メソッドです。
        /// <para>
        /// 戻り値に null は返しません。
        /// </para>
        /// <para>
        /// ビジネスロジックは本メソッドをオーバーライドしなければなりません。
        /// </para>
        /// </remarks>
        /// <param name="param">
        /// ビジネスロジック入力情報を格納した <see cref="BLogicParam"/> 。
        /// </param>
        /// <returns>
        /// ビジネスロジックの実行結果を格納した <see cref="BLogicResult"/> 。
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="paramData"/> が null 参照です。
        /// </exception>
        BLogicResult Execute(BLogicParam param);
    }
}
