using DbAPI.Connections;
using DTS.Common.Interface.Database;
using DTS.Common.Interface.Groups.GroupList;
using System.Collections.Generic;
using DTS.Common.Interface.Groups;
using DTS.Common.Classes.Groups;

namespace DbAPI.GroupHardware
{
    /// <summary>
    /// GroupHardware related functions
    /// </summary>
    public interface IGroupHardware
    {
        /// <summary>
        /// Inserts a new record in the GroupHardware table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="groupHardware"></param>
        /// <param name="newId"></param>
        /// <param name="errorMessage"></param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong GroupHardwareInsert(IUserDbRecord user,
            IConnectionDetails connection,
            GroupHardwareDbRecord groupHardware,
            out int newId,
            out string errorMessage);

        /// <summary>
        /// Gets one or more records from the GroupHardware table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="groupId"></param>
        /// <param name="serialNumber"></param>
        /// <param name="embedded"></param>
        /// <param name="groupHardwareRecords"></param>
        /// <returns></returns>
        ulong GroupHardwareGet(IUserDbRecord user,
            IConnectionDetails connection,
            int? groupId,
            string serialNumber,
            bool? embedded,
            out GroupHardwareDbRecord[] groupHardwareRecords);

        /// <summary>
        /// Deletes an entry in the GroupHardware table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="groupId">Id in the GroupHardware table</param>
        /// <param name="dasId">Id in the GroupHardware table</param>
        /// <param name="errorString">Error string returned, possibly from sp_GroupsDelete</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong GroupHardwareDelete(IUserDbRecord user,
            IConnectionDetails connection,
            int? groupId,
            int? dasId,
            out string errorString);
    }
}