using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using xModels.Base;

namespace xPushService.Interfaces
{
    public interface IXBaseEntityHub<TEntity, TKey>
    where TEntity : XBaseEntity<TKey>
    {
        /// <summary>
        /// Notify a New Entity added ...
        /// </summary>
        /// <param name="entity"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task Add(
            TEntity entity,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify a New Entity added ...
        /// </summary>
        /// <param name="entity"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task AddOrUpdate(
            TEntity entity,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify Add Many Entities ...
        /// </summary>
        /// <param name="entities"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task AddMany(
            IEnumerable<TEntity> entities,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify an Entity Deleted ...
        /// </summary>
        /// <param name="entity"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task Delete(
            TEntity entity,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify Delete Many Entities ...
        /// </summary>
        /// <param name="entities"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task DeleteMany(
            IEnumerable<TEntity> entities,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify an Entity Updated ...
        /// </summary>
        /// <param name="entity"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task Update(
            TEntity entity,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Notify Update Many Entities ...
        /// </summary>
        /// <param name="entities"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task UpdateMany(
            IEnumerable<TEntity> entities,
            CancellationToken cancellationToken = default
        );
    }
}