using FrameworkDAL.DTO.GBPeriod;
using GB5Shared.DTO.Framework.Criteria;
using GB5Shared.DTO.Framework.Login;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace FrameworkDAL.CustomCode.GBPeriod
{
    public interface IGBPeriodDAL
    {
        Task<string> GetGBPeriod(int gbPeriodId, LoginDTO loginDTO);
        /// <summary>
        /// Inserts a new GBPeriod record into the database.
        /// Automatically sets created and modified metadata fields.
        /// </summary>
        /// <param name="gbPeriodDTO">The GBPeriod data to insert.</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> SaveGBPeriod(GBPeriodDTO gbPeriodDTO, LoginDTO loginDTO);
        /// <summary>
        /// Updates an existing GBPeriod record in the database.
        /// Automatically updates modified metadata fields.
        /// </summary>
        /// <param name="gbPeriodDTO">The GBPeriod data to update.</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> UpdateGBPeriod(GBPeriodDTO gbPeriodDTO, LoginDTO loginDTO);
        /// <summary>
        /// Deletes a GBPeriod record by its unique identifier.
        /// </summary>
        /// <param name="gbPeriodId">The ID of the GBPeriod to delete.</param>
        /// <param name="loginDTO">The current user's login details.</param>
        /// <returns>
        /// A message string indicating success or failure of the delete operation.
        /// </returns>
        Task<string> DeleteGBPeriod(int gbPeriodId, LoginDTO loginDTO);
        /// <summary>
        /// Retrieves a paginated list of GBPeriod 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 GBPeriod records.</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 GBPeriod records or the total count.</returns>
        Task<string> GetSelectListGBPeriod(int firstNumber, int maxResult, CriteriaDTO criteriaDTO, LoginDTO loginDTO, bool isCount = false);
        /// <summary>
        /// Retrieves a paginated list of GBPeriodDetail records (sub-periods) across all GBPeriods.
        /// 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 GBPeriodDetail records.</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 GBPeriodDetail records or the total count.</returns>
        Task<string> GetSelectListGBPeriodDetail(int firstNumber, int maxResult, CriteriaDTO criteriaDTO, LoginDTO loginDTO, bool isCount = false);
        /// <summary>
        /// Retrieves the full GBPeriod/GBPeriodDetail picklist (no paging) filtered by the supplied criteria.
        /// Mirrors the GB4 Gb4PeriodPicklist behavior used by legacy period-selection pickers.
        /// </summary>
        /// <param name="criteriaDTO">Filter criteria (e.g. PeriodType, SubPeriodName, PeiodFromDate, PeiodToDate).</param>
        /// <param name="loginDTO">The current user's login details.</param>
        /// <returns>A JSON string representing the list of matching GBPeriodDetail picklist records.</returns>
        Task<string> Gb4PeriodPicklist(CriteriaDTO criteriaDTO, LoginDTO loginDTO);
    }
}