using GB5Shared.DTO.Framework.Criteria;
using GB5Shared.DTO.Framework.Login;

namespace MMDAL.CustomCode.Allocation
{
    /// <summary>
    /// Interface defining the Data Access Layer contract for Allocation operations.
    /// </summary>
    public interface IAllocationDAL
    {
        /// <summary>
        /// Fetches a single allocation header record by its primary key.
        /// </summary>
        Task<string> GetAllocation(int AllocationId, LoginDTO LoginDTO);

        /// <summary>
        /// Executes a paginated SQL Server query to load allocation picklist records.
        /// Supports dynamic filtering by OU, item code/name, document header, biz transaction type,
        /// item-wise grouping, and pending quantity rules.
        /// </summary>
        /// <param name="FirstNumber">Zero-based row offset for pagination.</param>
        /// <param name="MaxResult">Maximum rows to return.</param>
        /// <param name="CriteriaDTO">Structured filter criteria from the UI.</param>
        /// <param name="LoginDTO">User session and connection context.</param>
        /// <returns>JSON-serialized <c>List&lt;AllocationNewDTO&gt;</c>.</returns>
        Task<string> LoadFromAllocationPicklist(int FirstNumber, int MaxResult, CriteriaDTO CriteriaDTO, LoginDTO LoginDTO);

        /// <summary>
        /// Oracle-specific path for loading pending allocation data.
        /// Mirrors the logic of <see cref="LoadFromAllocationPicklist"/> but targets Oracle's
        /// trigger-based TPendingAllocation schema. Supports multi-head-type routing
        /// (MM Document, Indent), biz transaction type filtering, item/party/OU filters,
        /// and quantity-type pending checks (Good/Rejected/Rework/Other).
        /// </summary>
        /// <param name="CriteriaDTO">Structured filter criteria from the UI.</param>
        /// <param name="LoginDTO">User session and Oracle connection context.</param>
        /// <returns>JSON-serialized <c>List&lt;AllocationNewDTO&gt;</c>.</returns>
        Task<string> GetPendingAllocationForOracle(CriteriaDTO CriteriaDTO, LoginDTO LoginDTO);

        /// <summary>
        /// GB4 Source: AllocationDAL.GetPendingNewListForProductionPlan ("production plan For Hilife").
        /// GB4 route: /Allocation/PendingAllocationSelectList. Head-type/NeedAllTag branching
        /// (MM Document compact/full, Indent) mirrors <see cref="GetPendingAllocationForOracle"/>;
        /// the MM-Document compact branch additionally joins MLABEL/MGCM for warp-type/label
        /// (fabric design) columns specific to this variant.
        /// </summary>
        /// <returns>JSON-serialized <c>List&lt;AllocationNewDTO&gt;</c>.</returns>
        Task<string> GetPendingNewListForProductionPlan(CriteriaDTO CriteriaDTO, LoginDTO LoginDTO);
    }
}