using GB5Shared.DTO.Framework.Criteria;
using GB5Shared.DTO.Framework.Login;
using AdminDAL.DTO.FinanceBook;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace AdminDAL.CustomCode.FinanceBook
{
    /// <summary>
    /// Data Access Layer interface for managing Finance Book records in the database.
    /// Provides methods to retrieve, insert, update, and delete Finance Book entries.
    /// </summary>
    public interface IFinanceBookDAL
    {
        /// <summary>
        /// Retrieves a single Finance Book by its unique identifier.
        /// </summary>
        /// <param name="FinanceBookId">The unique identifier of the Finance Book.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A JSON string representing the Finance Book details.</returns>
        Task<string> GetFinanceBook(int FinanceBookId, LoginDTO LoginDTO);

        /// <summary>
        /// Retrieves a list of Finance Books based on specified criteria.
        /// Typically used for populating dropdowns or picklists.
        /// </summary>
        /// <param name="CriteriaDTO">Filter criteria for selecting Finance Books.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A JSON string representing a list of Finance Books.</returns>
        Task<string> GetSelectListFinanceBook(CriteriaDTO CriteriaDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Inserts a new Finance Book record into the database.
        /// </summary>
        /// <param name="FinanceBookDTO">The Finance Book data to save.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>The number of rows affected (should be 1 if successful).</returns>
        Task<int> SaveFinanceBook(FinanceBookDTO FinanceBookDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Updates an existing Finance Book record in the database.
        /// </summary>
        /// <param name="FinanceBookDTO">The updated Finance Book data.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>The number of rows affected (should be 1 if successful).</returns>
        Task<int> UpdateFinanceBook(FinanceBookDTO FinanceBookDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Deletes a Finance Book record by its unique identifier.
        /// </summary>
        /// <param name="FinanceBookId">The unique identifier of the Finance Book to delete.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A JSON string indicating success or failure of the delete operation.</returns>
        Task<string> DeleteFinanceBook(int FinanceBookId, LoginDTO LoginDTO);
    }
}