using DbAPI.Connections;
using DTS.Common.Interface.Database;
using System;
using DTS.Common.Classes.LabratoryDetails;
using DTS.Common.Interface.TestMetaData;

namespace DbAPI.LabratoryDetails
{
    /// <summary>
    /// LabratoryDetails related functions (GetLabratoryDetails, )
    /// </summary>
    public interface ILabratoryDetails
    {
        /// <summary>
        /// Inserts a new record in the LabratoryDetails table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="labratoryDetailsDbRecord"></param>
        /// <param name="newId">The Id of the new record in the LabratoryDetails table</param>
        /// <param name="errorString">Error string returned, possibly from sp_LabratoryDetailsUpdate</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong LabratoryDetailsInsert(IUserDbRecord user,
            IConnectionDetails connection,
            LabratoryDetailsDbRecord labratoryDetailsDbRecord,
            out int newId,
            out string errorString);

        /// <summary>
        /// Updates an existing record in the LabratoryDetails table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name = "labratoryDetailsDbRecord"></param>
        /// <param name="errorString">Error string returned, possibly from sp_LabratoryDetailsUpdate</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong LabratoryDetailsUpdate(IUserDbRecord user,
            IConnectionDetails connection,
            LabratoryDetailsDbRecord labratoryDetailsDbRecord,
            out string errorString);

        /// <summary>
        /// Updates an existing record or Inserts a new record in the LabratoryDetails table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name = "labratoryDetailsDbRecord"></param>
        /// <param name="errorString">Error string returned, possibly from sp_LabratoryDetailsUpdate</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong LabratoryDetailsUpdateInsert(IUserDbRecord user,
            IConnectionDetails connection,
            LabratoryDetailsDbRecord labratoryDetailsDbRecord,
            out string errorString);

        /// <summary>
        /// retrieves all laboratory details matching search criteria
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="name">Name in the LabratoryDetails table</param>
        /// <param name="labratoryDetailsDbRecords">null, or records found</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong LabratoryDetailsGet(IUserDbRecord user,
            IConnectionDetails connection,
            string name,
            out ILabratoryDetailsDbRecord[] labratoryDetailsDbRecords);

        /// <summary>
        /// Deletes an entry in the LabratoryDetails table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="name">Name in the LabratoryDetails table</param>
        /// <param name="errorString">Error string returned, possibly from sp_LabratoryDetailsDelete</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong LabratoryDetailsDelete(IUserDbRecord user,
            IConnectionDetails connection,
            string name,
            out string errorString);
    }
}