using RSecurityBackend.Models.Auth.Db;
using RSecurityBackend.Models.Auth.Memory;
using RSecurityBackend.Models.Generic;
using System;
using System.Threading.Tasks;

namespace RSecurityBackend.Services
{
    /// <summary>
    /// User Groups Service
    /// </summary>
    public interface IUserRoleService
    {
        /// <summary>
        /// returns all user roles
        /// </summary>
        /// <returns></returns>
        Task<RServiceResult<RAppRole[]>> GetAllRoles();

        /// <summary>
        /// returns user role information
        /// </summary>       
        /// <param name="roleName"></param>        
        /// <returns></returns>
        Task<RServiceResult<RAppRole>> GetRoleInformation(string roleName);


        /// <summary>
        /// adds a new user role
        /// </summary>
        /// <param name="newRoleInfo">new role info</param>
        /// <returns>update user role info (id)</returns>
        Task<RServiceResult<RAppRole>> AddRole(RAppRole newRoleInfo);

        /// <summary>
        /// modify existing user role
        /// </summary>
        /// <param name="roleName"></param>
        /// <param name="editedRole"></param>
        /// <returns></returns>
        Task<RServiceResult<bool>> ModifyRole(string roleName, RAppRole editedRole);

        /// <summary>
        /// delete user role
        /// </summary>
        /// <param name="roleName"></param>
        /// <returns>true if succeeds</returns>
        Task<RServiceResult<bool>> DeleteRole(string roleName);

        /// <summary>
        /// Has role specified permission
        /// </summary>
        /// <param name="roleName"></param>
        /// <param name="securableItemShortName"></param>
        /// <param name="operationShortName"></param>
        /// <returns></returns>
        Task<RServiceResult<bool>> HasPermission(string roleName, string securableItemShortName, string operationShortName);

        /// <summary>
        /// gets list of SecurableItem, should be reimplemented in end user applications
        /// </summary>
        /// <returns></returns>
        SecurableItem[] GetSecurableItems();

        /// <summary>
        /// Lists role permissions
        /// </summary>
        /// <param name="roleName"></param>
        /// <returns></returns>
        Task<RServiceResult<SecurableItem[]>> GetRoleSecurableItemsStatus(string roleName);

        /// <summary>
        /// Saves role permissions
        /// </summary>
        /// <param name="roleName"></param>
        /// <param name="securableItems"></param>
        /// <returns></returns>
        Task<RServiceResult<bool>> SetRoleSecurableItemsStatus(string roleName, SecurableItem[] securableItems);
    }
}