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

namespace TERASOLUNA.Fw.Client
{
    /// <summary>
    /// エラー処理ハンドラインタフェース。
    /// </summary>
    public interface IErrorHandler
    {
        /// <summary>
        /// エラー表示処理を行います。
        /// </summary>
        /// <param name="resultString">エラーの識別文字列。</param>
        /// <param name="messages"><see cref="MessageInfo"/> のリスト。</param>
        /// <param name="view">エラー処理を行う対象のオブジェクト。</param>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="resultString"/> が null 参照です。
        /// </item>
        /// <item>
        /// <paramref name="messages"/> が null 参照です。
        /// </item>
        /// </list>
        /// </exception>
        /// <exception cref="ArgumentException">
        /// <paramref name="resultString"/> が空文字列です。
        /// </exception>
        void HandleError(string resultString, IList<MessageInfo> messages, object view);

        /// <summary>
        /// エラークリア処理を行います。
        /// </summary>
        /// <param name="view">エラークリアを行う対象のオブジェクト。</param>
        void ClearError(object view);
    }
}
