//-----------------------------------------------------------------------
// <copyright file="AbstractFile.cs" company="BTU/IIT">
// The MIT License (MIT). Copyright (c) 2013 BTU/IIT.
// </copyright>
// <author>fiedlchr</author>
// <date>15.10.2013</date>
// <summary>Implements the abstract file class</summary>
//-----------------------------------------------------------------------
namespace CampusAppWPortalLib8.Utility
{
    /// <summary> File class. </summary>
    /// <remarks> fiedlchr, 15.10.2013. </remarks>
    public abstract class AbstractFile
    {
        #region Events

        /// <summary> Delegation of the write callback function prototype. </summary>
        /// <remarks> fiedlchr, 15.10.2013. </remarks>
        public delegate void WriteCallbackFunc();

        #endregion

        #region Method

        #region public

         /// <summary> Read data from file to a string. </summary>
         /// <remarks> fiedlchr, 03.09.2013. </remarks>
         /// <returns> data string. </returns>
         public abstract byte[] ReadFile();

        /// <summary> Write bytes to the file. </summary>
        /// <remarks> fiedlchr, 03.09.2013. </remarks>
        /// <param name="data">             data byte array. </param>
        /// <param name="onSavedCallback">  callback function, called after writing is done. </param>
        /// <param name="onFailedCallback"> callback function, called when writing failed. </param>
        public abstract void WriteFile(byte[] data, WriteCallbackFunc onSavedCallback, WriteCallbackFunc onFailedCallback);

        /// <summary> Check if a file is existing. </summary>
        /// <remarks> fiedlchr, 15.10.2013. </remarks>
        /// <returns> true, if file exists, otherwise false. </returns>
        public abstract bool Exist();

        #endregion

        #endregion
    }
}