// 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 TERASOLUNA.Fw.Common.BLogic;

namespace TERASOLUNA.Fw.Client.BLogic
{
    /// <summary>
    /// ビジネスロジックの基底クラスです。
    /// </summary>
    /// <remarks>
    /// キャンセル処理と進行状況イベントの通知処理を実装しています。
    /// クライアントアプリケーションのビジネスロジックは、<see cref="ClientBLogicBase"/> を継承し、
    /// <see cref="ClientBLogicBase.Execute"/> を実装してください。。
    /// </remarks>
    public abstract class ClientBLogicBase : IBLogic, ICancelable, IProgressChangedEventInvoker
    {
        /// <summary>
        /// ビジネスロジックがキャンセルされたかどうかを示す値です。
        /// </summary>
        private bool _cancelled = false;

        /// <summary>
        /// <see cref="OnProgressChanged"/> が呼び出されたときに発生します。
        /// </summary>
        public event ExecuteProgressChangedEventHandler ProgressChanged;

        /// <summary>
        /// ビジネスロジックがキャンセルされたかどうかを示す値を取得または設定します。
        /// </summary>
        /// <remarks>
        /// ビジネスロジックがキャンセルされた場合は true。それ以外の場合は false。既定値は false です。
        /// </remarks>
        /// <value>
        /// キャンセルフラグ。
        /// </value>
        public bool Cancelled
        {
            get
            {
                return _cancelled;
            }
            set
            {
                _cancelled = value;
            }
        }

        /// <summary>
        /// <see cref="ClientBLogicBase"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        protected ClientBLogicBase()
        {
        }

        /// <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>
        public abstract BLogicResult Execute(BLogicParam param);

        /// <summary>
        /// ビジネスロジックの実行をキャンセルします。
        /// </summary>
        /// <remarks>
        /// <para>
        /// ビジネスロジックの実行をキャンセルするために呼び出します。このメソッドは
        /// <see cref="Execute"/> が実行されているスレッドとは別のスレッドで実行されるため、
        /// スレッドセーフに実装する必要があります。
        /// </para>
        /// <para>
        /// 既定では何も処理を行わない空のメソッドとなっています。
        /// </para>
        /// <para>
        /// キャンセルを行いたい場合は、本メソッドをオーバーライドしてキャンセル処理を記述してください。
        /// </para>
        /// <para>
        /// キャンセル処理の最後で、<see cref="Cancelled"/> を true に設定してください。
        /// </para>
        /// </remarks>
        public virtual void Cancel()
        {
        }

        /// <summary>
        /// 進行状況イベントに登録されたイベントハンドラに対して通知をします。
        /// </summary>
        /// <param name="e">
        /// イベントデータを格納している <see cref="ExecuteProgressChangedEventArgs"/>。
        /// </param>
        protected virtual void OnProgressChanged(ExecuteProgressChangedEventArgs e)
        {
            if (this.ProgressChanged != null)
            {
                ProgressChanged(this, e);
            }
        }
    }
}
