using DTS.Common.Enums;
using System;

namespace DTS.Common.Interface.Sensors.SensorsList
{
    public interface IStreamInputSetting
    {
        /// <summary>
        /// ID in the database for the stream output setting
        /// only positive numbers are valid database ids
        /// </summary>
        int DatabaseId { get; set; }
        /// <summary>
        /// whether the stream output is checked in a list with a checkbox
        /// </summary>
        bool Included { get; set; }
        /// <summary>
        /// the serial number / setting name 
        /// </summary>
        string SerialNumber { get; set; }
        /// <summary>
        /// description or comment of setting
        /// </summary>
        string Description { get; set; }

        /// <summary>
        /// the user who last modified setting
        /// </summary>
        string LastModifiedBy { get; set; }
        /// <summary>
        /// when the setting was last modified
        /// </summary>
        DateTime LastModified { get; set; }
        /// <summary>
        /// returns true if stream output matches filter criteria
        /// </summary>
        /// <param name="term"></param>
        /// <returns></returns>
        bool Filter(string term);
        /// <summary>
        /// whether the stream output is associated with a channel
        /// </summary>
        bool Assigned { get; set; }
        /// <summary>
        /// whether the stream output is online or not
        /// </summary>
        bool Online { get; set; }
        /// <summary>
        /// the isocode for the stream output
        /// </summary>
        string ISOCode { get; set; }
        /// <summary>
        /// the iso channel name for the stream output
        /// </summary>
        string ISOChannelName { get; set; }
        /// <summary>
        /// the user code for the stream output
        /// </summary>
        string UserCode { get; set; }
        /// <summary>
        /// the user channel name for the stream output
        /// </summary>
        string UserChannelName { get; set; }
        /// <summary>
        /// marks the stream output setting as broken or not
        /// broken sensors do not appear in selectable lists of sensors in edit test setup or edit group
        /// </summary>
        bool Broken { get; set; }
        /// <summary>
        /// marks the stream output setting as donotuse
        /// donotuse sensors do not appear in selectable lists of sensors in edit test setup or edit group
        /// </summary>
        bool DoNotUse { get; set; }
        ///<summary>
        /// udp address setting value
        ///</summary>
        string UDPAddress { get; set; }
    }
}