namespace DealerSelection.Common.Entity;

/// <summary>
/// An Attribute that provides a mapping between a property on an object and a fields in a database table.
/// </summary>
[AttributeUsage(AttributeTargets.Property)]
public sealed class FieldMapAttribute : Attribute
{
    readonly string _dbFieldName;

    /// <summary>
    /// Initialize a new FieldMapAttribute
    /// </summary>
    /// <param name="dbFieldName">Name of database field that this property represents</param>
    public FieldMapAttribute(string dbFieldName)
    {
        _dbFieldName = dbFieldName;
    }

    /// <summary>
    /// Name of field that the perperty this attribute is attached to is mapped to.
    /// </summary>
    public string DbFieldName => _dbFieldName;
}