// 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 System.Collections.ObjectModel;
using System.IO;
using TERASOLUNA.Fw.Common;
using TERASOLUNA.Fw.Common.BLogic;
using TERASOLUNA.Fw.Common.Logging;

namespace TERASOLUNA.Fw.Web.BLogic
{
    /// <summary>
    /// ダウンロードを伴うビジネスロジックが返却する情報を格納するクラスです。
    /// </summary>
    public class FileDownloadBLogicResult : BLogicResult
    {
        /// <summary>
        /// <see cref="ILog"/> 実装クラスのインスタンスです。
        /// </summary>
        /// <remarks>
        /// ログ出力に利用します。
        /// </remarks>
        private static ILog _log = LogFactory.GetLogger(typeof(FileDownloadBLogicResult));

        /// <summary>
        /// ダウンロード対象のファイル情報です。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private FileInfo _downloadFileInfo = null;

        /// <summary>
        /// ダウンロードデータです。
        /// </summary>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        private ReadOnlyCollection<byte> _downloadData = null;

        /// <summary>
        /// ファイル情報を取得します。
        /// </summary>
        /// <value>
        /// ファイル情報。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public FileInfo DownloadFileInfo
        {
            get
            {
                return _downloadFileInfo;
            }
        }

        /// <summary>
        /// ダウンロードデータを取得します。
        /// </summary>
        /// <value>
        /// ダウンロードデータ。
        /// </value>
        /// <remarks>
        /// デフォルトの値は、 null です。
        /// </remarks>
        public ReadOnlyCollection<byte> DownloadData
        {
            get
            {
                return _downloadData;
            }
        }

        /// <summary>
        /// <see cref="FileDownloadBLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <remarks>
        /// デフォルトコンストラクタです。
        /// </remarks>
        protected FileDownloadBLogicResult()
        {
        }

        /// <summary>
        /// ファイル情報を使用して、<see cref="FileDownloadBLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="fileInfo">
        /// ダウンロード対象となるファイルのパス情報が格納された <see cref="FileInfo"/> オブジェクト。
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="fileInfo"/> が null 参照です。
        /// </exception>
        public FileDownloadBLogicResult(FileInfo fileInfo)
        {
            if (fileInfo == null)
            {
                ArgumentNullException exception = new ArgumentNullException("fileInfo");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Properties.Resources.E_NULL_ARGUMENT, "fileInfo"), exception);
                }
                throw exception;
            }
            _downloadFileInfo = fileInfo;
        }

        /// <summary>
        /// ファイル情報とダウンロードデータを使用して、<see cref="FileDownloadBLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="fileInfo">
        /// ダウンロードデータに対応付けるファイル名が格納された　<see cref="FileInfo"/>　オブジェクト。
        /// </param>
        /// <param name="data">
        /// ダウンロードデータ本体。
        /// </param>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="fileInfo"/> が null 参照です。
        /// </item>
        /// <item>
        /// <paramref name="data"/> が null 参照です。
        /// </item>
        /// </list>
        /// </exception>
        public FileDownloadBLogicResult(FileInfo fileInfo, byte[] data)
            : this(fileInfo)
        {
            if (data == null)
            {
                ArgumentNullException exception = new ArgumentNullException("data");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(
                        Properties.Resources.E_NULL_ARGUMENT, "data"), exception);
                }
                throw exception;
            }
            _downloadData = new ReadOnlyCollection<byte>(data);
        }

        /// <summary>
        /// 実行結果文字列とエラーメッセージリストを使用して、<see cref="FileDownloadBLogicResult"/> クラスの新しいインスタンスを初期化します。
        /// </summary>
        /// <param name="resultStr">設定するビジネスロジック実行結果文字列。</param>
        /// <param name="errorMsgList">設定するエラーメッセージのリスト。</param>
        /// <remarks>
        /// 引数の値をBLogicResultのメンバ変数へ設定します。
        /// </remarks>
        /// <exception cref="ArgumentNullException">
        /// 以下のような場合に例外をスローします。
        /// <list type="bullet">
        /// <item>
        /// <paramref name="resultStr"/> が null 参照です。
        /// </item>
        /// <item>
        /// <paramref name="errorMsgList"/> が null 参照です。
        /// </item>
        /// </list>
        /// </exception>
        public FileDownloadBLogicResult(string resultStr, IList<MessageInfo> errorMsgList) 
        {
            if (resultStr == null)
            {
                ArgumentNullException exception = new ArgumentNullException("resultStr");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(Properties.Resources.E_NULL_ARGUMENT, "resultStr"), exception);
                }
                throw exception;
            }

            ResultString = resultStr;

            if (errorMsgList == null)
            {
                ArgumentNullException exception = new ArgumentNullException("errorMsgList");
                if (_log.IsErrorEnabled)
                {
                    _log.Error(string.Format(Properties.Resources.E_NULL_ARGUMENT, "errorMsgList"), exception);
                }
                throw exception;
            }

            foreach (MessageInfo message in errorMsgList)
            {
                Errors.Add(message);
            }
        }

    }
}
