using WorkFlow.Domain.Entities;

namespace WorkFlow.Application.Contracts.Repositories;

/// <summary>
/// Repository for retrieving <see cref="ProfileObject"/> entities from the database.
/// </summary>
public interface IProfileObjRepository
{
    /// <summary>
    /// Retrieves the list of <see cref="ProfileObject"/> associated with a given user ID and profile ID by calling a database function.
    /// </summary>
    /// <param name="userId">The unique identifier of the user whose profile is to be retrieved.</param>
    /// <param name="profileId">The unique identifier of the profile whose object is to be retrieved.</param>
    /// <param name="cancel">Propagates notification that operations should be canceled.</param>
    /// <returns>
    /// A task that represents the asynchronous operation. The task result contains the <see cref="ProfileObject"/> object if found; otherwise, <c>null</c>.
    /// </returns>
    /// <remarks>
    /// Logs an error if no profile is found, or if multiple profiles are returned, indicating potential data issues.
    /// </remarks>
    public Task<IEnumerable<ProfileObject>> ReadAsync(int userId, int profileId, CancellationToken cancel = default);
}