using FrameworkDAL.DTO.ECMRights;
using GB5Shared.DTO.Framework.Criteria;
using GB5Shared.DTO.Framework.Login;
using System.Threading.Tasks;

namespace FrameworkDAL.CustomCode.ECMRights
{
    /// <summary>
    /// Data Access Layer interface for managing ECM Rights records in the database.
    /// Provides methods to retrieve, insert, update, and delete ECM Rights entries.
    /// </summary>
    public interface IECMRightsDAL
    {
        /// <summary>
        /// Retrieves a single ECM Rights record by its unique identifier.
        /// </summary>
        /// <param name="ECMRightsId">The unique identifier of the ECM Rights.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A JSON string representing the ECM Rights details.</returns>
        Task<string> GetECMRights(int ECMRightsId, LoginDTO LoginDTO);

        /// <summary>
        /// Retrieves a paginated list of ECMRights records based on specified filter criteria.
        /// Can optionally return the total count of records instead of the list.
        /// </summary>
        /// <param name="firstNumber">The starting index of records to fetch (for pagination).</param>
        /// <param name="maxResult">The maximum number of records to fetch.</param>
        /// <param name="criteriaDTO">Filter criteria for selecting ECMRights.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <param name="isCount">If true, returns the total count of matching records instead of the list.</param>
        /// <returns>A JSON string representing either the list of ECMRights records or the total count.</returns>
        Task<string> GetSelectListECMRights(int firstNumber, int maxResult, CriteriaDTO criteriaDTO, LoginDTO LoginDTO, bool isCount = false);

        /// <summary>
        /// Inserts a new ECM Rights record into the database.
        /// </summary>
        /// <param name="ECMRightsDTO">The ECM Rights 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> SaveECMRights(ECMRightsDTO ECMRightsDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Updates an existing ECM Rights record in the database.
        /// </summary>
        /// <param name="ECMRightsDTO">The updated ECM Rights 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> UpdateECMRights(ECMRightsDTO ECMRightsDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Deletes an ECM Rights record by its unique identifier.
        /// </summary>
        /// <param name="ECMRightsId">The unique identifier of the ECM Rights to delete.</param>
        /// <param name="LoginDTO">The current user's login details.</param>
        /// <returns>A string indicating success or failure of the delete operation.</returns>
        Task<string> DeleteECMRights(int ECMRightsId, LoginDTO LoginDTO);
    }
}