using GB5Shared.DTO.Framework.Criteria;
using GB5Shared.DTO.Framework.Login;
using MMDAL.DTO.TransactionType;
using System.Threading.Tasks;

namespace MMDAL.CustomCode.TransactionType
{
    /// <summary>
    /// Data Access Layer interface for managing TransactionType records in the database.
    /// Provides methods to retrieve, insert, update, and delete transaction types.
    /// </summary>
    public interface ITransactionTypeDAL
    {
        /// <summary>
        /// Retrieves a single transaction type by its unique identifier.
        /// </summary>
        /// <param name="TransactionTypeId">The unique identifier of the transaction type.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A JSON string representing the transaction type details.</returns>
        Task<string> GetTransactionType(int TransactionTypeId, LoginDTO LoginDTO);

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

        /// <summary>
        /// Inserts a new transaction type record into the database.
        /// </summary>
        /// <param name="TransactionTypeDTO">The transaction type 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> SaveTransactionType(TransactionTypeDTO TransactionTypeDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Updates an existing transaction type record in the database.
        /// </summary>
        /// <param name="TransactionTypeDTO">The updated transaction type 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> UpdateTransactionType(TransactionTypeDTO TransactionTypeDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Deletes a transaction type record by its unique identifier.
        /// </summary>
        /// <param name="TransactionTypeId">The unique identifier of the transaction type 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> DeleteTransactionType(int TransactionTypeId, LoginDTO LoginDTO);
    }
}