// 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.Client
{
    /// <summary>
    /// キャンセル処理のインターフェイスです。
    /// </summary>
    /// <remarks>
    /// ビジネスロジックなどでキャンセル処理を行いたい場合は、<see cref="ICancelable"/> を実装してください。
    /// </remarks>
    public interface ICancelable
    {
        /// <summary>
        /// 処理がキャンセルされたかどうかを示す値を取得または設定します。
        /// </summary>
        /// <remarks>
        /// 処理がキャンセルされた場合は true。それ以外の場合は false。既定値は false です。
        /// </remarks>
        /// <value>
        /// キャンセルフラグ。
        /// </value>
        bool Cancelled
        {
            get;
            set;
        }

        /// <summary>
        /// 実行中の処理をキャンセルします。
        /// </summary>
        /// <remarks>
        /// <para>
        /// 実行中の処理をキャンセルするために呼び出します。
        /// </para>
        /// <para>
        /// 既定では何も処理を行わない空のメソッドとなっています。
        /// キャンセルを行いたい場合は、本メソッドをオーバーライドしてキャンセル処理を記述してください。
        /// </para>
        /// <para>
        /// キャンセル処理の最後で、<see cref="Cancelled"/> を true に設定してください。
        /// </para>
        /// </remarks>
        void Cancel();
    }
}
