using System.Windows.Input;
using DTS.Common.Enums;
using DTS.Common.Enums.Channels;

namespace DTS.Common.Interface.Channels.ChannelCodes
{
    /// <summary>
    /// used to describe the behavior of channelcodes for the UI
    /// </summary>
    public interface IChannelCode
    {
        /// <summary>
        /// id of the channel code in the database
        /// </summary>
        int Id { get; }
        /// <summary>
        /// codevalue (either user code or isocode depending on codetype)
        /// </summary>
        string Code { get; set; }
        /// <summary>
        /// name associated with code (either user channel name or iso channel name)
        /// </summary>
        string Name { get; set; }
        /// <summary>
        /// the type of code (iso or user)
        /// </summary>
        ChannelEnumsAndConstants.ChannelCodeType CodeType { get; }
        /// <summary>
        /// handler for paste command
        /// this is used for when data is pasted into either a channel code or name
        /// it's needed because you can paste many rows, a CSV for example, into one field
        /// </summary>
        ICommand PasteCommand { get; set; }
        /// <summary>
        /// the status of the item in the UI
        /// (failed/success/etc)
        /// </summary>
        UIItemStatus ItemStatus { get; set; }
    }
}