namespace CardReaderService
{
    /// <summary>
    /// An object used to detail an element that can be configured in the system.
    /// </summary>
    public class ConfigurationProperty
    {
        /// <summary>
        /// Unique Id for the configuration property.
        /// </summary>
        public string Id { get; set; }
        /// <summary>
        /// The display name of the configuration
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// The group under which this configuration falls (e.g.: TCP Settings  - "TCP" or similar.)
        /// </summary>
        /// <remarks>Application Specific grouping.</remarks>
        public string Group { get; set; }

        /// <summary>
        /// The actual value of the Configuration property
        /// </summary>
        public string Value { get; set; }

        /// <summary>
        /// The source of the configuration properties. 
        /// </summary>
        /// <remarks>
        /// Using this property allows aggregation of configuration settings
        /// by any configuration managers
        /// </remarks>
        /// <example>{TYPE}.getType().Name (or other suitably unique identifier)</example>
        public string Source { get; set; }

        /// <summary>
        /// The type of the configuration
        /// </summary>
        /// <remarks>
        /// This can be used for UI proofing/validation to ensure a user 
        /// enters expected format (e.g.: enters a date time for a datetime type)
        /// </remarks>
        public ConfigurationType Type { get; set; }

        /// <summary>
        /// Specifies whether the configuration setting can be set by user or is readonly
        /// </summary>
        public bool ReadOnly { get; set; }

        //TODO: in future, add access level, could go read level/edit level
        //public UserAccessLevel UserLevel {get;set;}
    }
}