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

namespace DbAPI.TestEngineerDetails
{
    /// <summary>
    /// TestEngineerDetails related functions (GetTestEngineerDetails, )
    /// </summary>
    public interface ITestEngineerDetails
    {
        /// <summary>
        /// Inserts a new record in the TestEngineerDetails table
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="testEngineerDetailsDbRecord"></param>
        /// <param name="newId">The Id of the new record in the TestEngineerDetails table</param>
        /// <param name="errorString">Error string returned, possibly from sp_TestEngineerDetailsUpdate</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong TestEngineerDetailsInsert(IUserDbRecord user,
            IConnectionDetails connection,
            TestEngineerDetailsDbRecord testEngineerDetailsDbRecord,
            out int newId,
            out string errorString);

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

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

        /// <summary>
        /// retrieves all test engineers matching search criteria
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="name">Name in the TestEngineerDetails table</param>
        /// <param name="testEngineerDetailsDbRecords">null, or records found</param>
        /// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
        ulong TestEngineerDetailsGet(IUserDbRecord user,
            IConnectionDetails connection,
            string name,
            out ITestEngineerDetailsDbRecord[] testEngineerDetailsDbRecords);

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