// 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.Data;
namespace TERASOLUNA.Fw.Client.Communication
{
    /// <summary>
    /// ファイルダウンロード処理の実行結果を格納するためのクラスです。
    /// </summary>
    /// <remarks>
    /// <seealso cref="BinaryFileDownloadCommunicator.Download"/> はこのクラスのインスタンスを返却します。
    /// </remarks>
    public class DownloadResult : CommunicationResult
    {
        /// <summary>
        /// ダウンロードしたファイルのファイルパスです。
        /// </summary>
        /// <remarks>
        /// ファイルがローカルに保存されていない場合は null 参照です。
        /// </remarks>
        private string _downloadFilePath = null;
        
        /// <summary>
        /// 新しい <see cref="DownloadResult"/> のインスタンスを初期化します。
        /// </summary>
        /// <param name="downloadFilePath">ダウンロードしたファイルのパス文字列。</param>
        public DownloadResult(string downloadFilePath)
            : this(downloadFilePath, null)
        {
        }

        /// <summary>
        /// 新しい <see cref="DownloadResult"/> のインスタンスを初期化します。
        /// </summary>
        /// <param name="downloadFilePath">ダウンロードしたファイルのパス文字列。</param>
        /// <param name="resultData">サーバ処理の結果データを保持する <see cref="DataSet"/></param>
        public DownloadResult(string downloadFilePath, DataSet resultData)
            : base(resultData)
        {
            _downloadFilePath = downloadFilePath;
        }

        /// <summary>
        /// ダウンロードしたファイルのファイルパスを取得します。
        /// </summary>
        /// <remarks>
        /// ファイルがローカルに保存されていない場合は null 参照です。
        /// </remarks>
        /// <value>
        /// ダウンロードしたファイルのファイルパス。
        /// </value>
        public string DownloadFilePath
        {
            get
            {
                return _downloadFilePath;
            }
            protected set
            {
                _downloadFilePath = value;
            }
        }
	
    }
}
