Files
DP44/DataPRO/DbAPI/Groups/IGroups.cs
2026-04-17 14:55:32 -04:00

71 lines
2.5 KiB
C#

using DbAPI.Connections;
using DTS.Common.Interface.Database;
using DTS.Common.Interface.Groups.GroupList;
using System.Collections.Generic;
using DTS.Common.Interface.Groups;
namespace DbAPI.Groups
{
/// <summary>
/// Group related functions (GetChannels, )
/// </summary>
public interface IGroups
{
/// <summary>
/// Inserts a new record in the Groups table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="group"></param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong GroupsInsert(IUserDbRecord user,
IConnectionDetails connection,
ref IGroupDbRecord group);
/// <summary>
/// Updates a record in the Groups table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="group"></param>
/// <returns>0 (ERROR_SUCCESS) on success, all other values are error codes</returns>
ulong GroupsUpdate(IUserDbRecord user,
IConnectionDetails connection,
IGroupDbRecord group);
/// <summary>
///
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="id"></param>
/// <param name="serialNumber"></param>
/// <param name="displayName"></param>
/// <param name="embedded"></param>
/// <param name="staticGroupId"></param>
/// <param name="groups"></param>
/// <returns></returns>
ulong GroupsGet(IUserDbRecord user,
IConnectionDetails connection,
int? id,
string serialNumber,
string displayName,
bool? embedded,
int? staticGroupId,
out IGroupDbRecord[] groups);
/// <summary>
/// Deletes an entry in the Groups table
/// </summary>
/// <param name="user"></param>
/// <param name="connection"></param>
/// <param name="id">Id in the Groups 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 GroupsDelete(IUserDbRecord user,
IConnectionDetails connection,
long id,
out string errorString);
}
}