Files
DP44/DataPRO/DbAPI/TestMetaData/ICustomerDetails.cs

69 lines
3.0 KiB
C#
Raw Permalink Normal View History

2026-04-17 14:55:32 -04:00
using DbAPI.Connections;
using DTS.Common.Interface.Database;
using System;
using DTS.Common.Classes.CustomerDetails;
using DTS.Common.Interface.TestMetaData;
namespace DbAPI.CustomerDetails
{
/// <summary>
/// CustomerDetails related functions (GetCustomerDetails, )
/// </summary>
public interface ICustomerDetails
{
/// <summary>
/// Inserts a new record in the CustomerDetails table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="customerDetailsDbRecord"></param>
/// <param name="newId">The Id of the new record in the CustomerDetails table</param>
/// <param name="errorString">Error string returned, possibly from sp_CustomerDetailsUpdate</param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong CustomerDetailsInsert(IUserDbRecord user,
IConnectionDetails connection,
CustomerDetailsDbRecord customerDetailsDbRecord,
out int newId,
out string errorString);
/// <summary>
/// Updates an existing record in the CustomerDetails table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name = "customerDetailsDbRecord"></param>
/// <param name="errorString">Error string returned, possibly from sp_CustomerDetailsUpdate</param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong CustomerDetailsUpdate(IUserDbRecord user,
IConnectionDetails connection,
CustomerDetailsDbRecord customerDetailsDbRecord,
out string errorString);
/// <summary>
/// retrieves all customer details matching search criteria
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="name">Name in the CustomerDetails table</param>
/// <param name="customerDetailsDbRecords">null, or records found</param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong CustomerDetailsGet(IUserDbRecord user,
IConnectionDetails connection,
string name,
out ICustomerDetailsDbRecord[] customerDetailsDbRecords);
/// <summary>
/// Deletes an entry in the CustomerDetails table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="name">Name in the CustomerDetails table</param>
/// <param name="errorString">Error string returned, possibly from sp_CustomerDetailsDelete</param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong CustomerDetailsDelete(IUserDbRecord user,
IConnectionDetails connection,
string name,
out string errorString);
}
}