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

namespace TERASOLUNA.Fw.Common.Validation
{
    /// <summary>
    /// 入力値検証を呼び出すインターフェイスを定義します。
    /// </summary>
    /// <remarks>
    /// 入力値検証機能を独自に実装する場合は、このインターフェイスを実装してください。
    /// </remarks>
    public interface IValidator
    {
        /// <summary>
        /// 入力値検証設定ファイルパスです。
        /// </summary>
        /// <value>入力値検証設定ファイルパス。</value>
        string ValidationFilePath
        {
            get;
            set;
        }

        /// <summary>
        /// 入力値検証を実施する際に利用するルールセット文字列です。
        /// </summary>
        /// <value>ルールセット文字列。</value>
        string RuleSet
        {
            get;
            set;
        }

        /// <summary>
        /// <see cref="DataSet"/> 全体を検証します。
        /// </summary>
        /// <param name="dataSet">検証対象の <see cref="DataSet"/> 。</param>
        /// <returns>検証結果を格納した <see cref="ValidationResult"/> 。</returns>
        /// <remarks>
        /// 戻り値に null は返しません。
        /// </remarks>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="dataSet"/> が null 参照です。
        /// </exception>
        /// <exception cref="InvalidOperationException ">
        /// 入力値検証設定ファイルが未指定、またはルールセット文字列が未指定です。
        /// </exception>
        ValidationResult Validate(DataSet dataSet);
    }
}
