using DbAPI.Connections;
using DTS.Common.Interface.Database;
using DTS.Common.Interface.TestSetups;

namespace DbAPI.TestSetups
{
    /// <summary>
    /// defines functions to create, retrieve, update, delete graphs
    /// </summary>
    public interface IRegionsOfInterest
    {
        /// <summary>
        /// Removes records from the TestSetupROIs and ROIPeriodChannels tables
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="testSetupId">The value that matches the Primary key of the TestSetups table</param>
        /// <returns></returns>
        ulong RegionsOfInterestDelete(IUserDbRecord user,
            IConnectionDetails connection,
            int testSetupId);
        /// <summary>
        /// Inserts records into the TestSetupROIs and ROIPeriodChannels tables
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="testSetupId">The value that matches the Primary key of the TestSetups table</param>
        /// <param name="regionOfInterest">The class that is split between the TestSetupROIs and ROIPeriodChannels tables</param>
        /// <returns></returns>
        ulong RegionsOfInterestInsert(IUserDbRecord user,
            IConnectionDetails connection,
            int clientDbVersion,
            int testSetupId,
            DTS.Common.Interface.RegionOfInterest.IRegionOfInterest regionOfInterest);
        /// <summary>
        /// Gets records from the TestSetupROIs and ROIPeriodChannels tables
        /// </summary>
        /// <param name="user"></param>
        /// <param name="connection"></param>
        /// <param name="testSetupId">The value that matches the Primary key of the TestSetups table</param>
        /// <param name="records">The array of records combined from the TetSetupROIs and ROIPeriodChannels tables</param>
        /// <returns></returns>
        ulong RegionsOfInterestGet(IUserDbRecord user,
            IConnectionDetails connection,
            int clientDbVersion,
            int testSetupId,
            out DTS.Common.Interface.RegionOfInterest.IRegionOfInterest[] records);
        ulong TestSetupROIsDelete(IUserDbRecord user,
            IConnectionDetails connection,
            int testSetupId);
        ulong TestSetupROIsInsert(IUserDbRecord user,
            IConnectionDetails connection,
            int testSetupId,
            DTS.Common.Interface.RegionOfInterest.IRegionOfInterest regionOfInterest,
            out int testSetupROIId);
        ulong TestSetupROIsGet(IUserDbRecord user,
            IConnectionDetails connection,
            int testSetupId,
            out ITestSetupROIRecord[] records);
        ulong ROIPeriodChannelsInsert(IUserDbRecord user,
            IConnectionDetails connection,
            int clientDbVersion,
            int testSetupROIId,
            string channelName,
            long channelId);
        ulong ROIPeriodChannelsGet(IUserDbRecord user,
            IConnectionDetails connection,
            int clientDbVersion,
            int testSetupROIId,
            out IROIPeriodChannelRecord[] roiPeriodChannelRecords);
    }
}