Common-VS2019/SacsBusinessBase/Base/UpdateLog/SaUpdateLogEntry.cs

using System;
using System.Collections.Generic;
using Sarand.Net.Standard.Base.Core;
using Sarand.Net.Standard.Base.Bus;
using Sarand.Net.Standard.Base.Utils;

namespace Sarand.Net.Standard.Base.UpdateLog
{
	//=======================================================================
	public abstract class SaUpdateLogEntry : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos = 0,
			// Log Entry properties.
			ItemType,
			ItemType_Desc,
			ItemId,
			Attribute,
			Location,
			Logged,
			Logged_Date,
			Logged_Time,
			DataBefore,
			DataAfter,
			// Common properties.
			Notes,
			Status,
			Status_Desc,
			Status_Ind,
			CreateOn_Date,
			CreateBy,
			CreateBy_Name,
			UpdateOn_Date,
			Hidden,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public ItemId ItemId { get; set; } = new ItemId();
			public String Attribute { get; set; } = String.Empty;
			public DateTime Logged { get; set; } = DateTime.MinValue;
			public String DataBefore { get; set; } = String.Empty;
			public String DataAfter { get; set; } = String.Empty;
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data ()
			{
				Status = DefaultStatus;
			}
			// Properties.
			public ItemId ItemId
			{
				get { return data.ItemId; }
				 set { CheckChanged(data.ItemId, value); data.ItemId = value; }
			}
			public String Attribute
			{
				get { return data.Attribute; }
				 set { CheckChanged(data.Attribute, value); data.Attribute = value; }
			}
			public DateTime Logged
			{
				get { return data.Logged; }
				 set { CheckChanged(data.Logged, value); data.Logged = value; }
			}
			public String DataBefore
			{
				get { return data.DataBefore; }
				set { CheckChanged(data.DataBefore, value); data.DataBefore = value; }
			}
			public String DataAfter
			{
				get { return data.DataAfter; }
				set { CheckChanged(data.DataAfter, value); data.DataAfter = value; }
			}
			// Population.
			internal void PopulateFrom (Data data)
			{
				ItemId = data.ItemId;
				Attribute = data.Attribute;
				Logged = data.Logged;
				DataBefore = data.DataBefore;
				DataAfter = data.DataAfter;
				base.PopulateFrom(data);
			}
			public Data Clone ()
			{
				Data data = new Data();
				data.PopulateFrom(this);
				return data;
			}
		}

		//-------------------------------------------------------------------
		// Error field - identify properties with validation error.
		public new class ErrField : SacsHierarchyItem.ErrField
		{
			// Identifies the field that has invalid data.
			public ValidValue ItemType { get; set; } = ValidValue.Valid;
			public ValidValue ItemId { get; set; } = ValidValue.Valid;
			public ValidValue Attribute { get; set; } = ValidValue.Valid;
			public ValidValue Logged { get; set; } = ValidValue.Valid;
			public ValidValue DataBefore { get; set; } = ValidValue.Valid;
			public ValidValue DataAfter { get; set; } = ValidValue.Valid;
		}

		//-------------------------------------------------------------------
		// Data members.
		private readonly Data data = new Data();

		//-------------------------------------------------------------------
		// Construction.
		public SaUpdateLogEntry (ItemId itemId, String attribute, DateTime logged) :
			base()
		{
			base.SetData(data);
			ItemId = itemId;
			Attribute = attribute;
			Logged = logged;
			Status = DefaultStatus;
		}

		//-------------------------------------------------------------------
		// Statuses.
		private static readonly List<SaStatus> validStatuses = new List<SaStatus>()
		{
			SaStatus.Logged,
			SaStatus.Deleted
		};
		public static SaStatus DefaultStatus { get { return LoggedStatus; } }
		public static SaStatus LoggedStatus { get { return SaStatus.Logged; } }
		public static List<SaStatus> ValidStatuses { get { return new List<SaStatus>(validStatuses); } }
		public static DataValue.TriStateType GetStatusTriState (SaStatus status)
		{
			switch (status)
			{
				case SaStatus.Logged:
					return DataValue.TriStateType.Green;
				case SaStatus.Deleted:
					return DataValue.TriStateType.Purple;
			}
			return DataValue.TriStateType.Unknown;
		}

		//-------------------------------------------------------------------
		// Properties.
		public Data GetData () { return data.Clone(); }
		public void SetData (Data data)
		{
			// Properties that cannot be changed if previously specified.
			if (ItemId.Type >= 0 && ItemId.Type != data.ItemId.Type)
				throw new NotSupportedException($"{SysUtil.Fn} Item type cannot be changed");
			if (SysId.IsValid(ItemId.Id) && SysId.ToInt(ItemId.Id) != SysId.ToInt(data.ItemId.Id))
				throw new NotSupportedException($"{SysUtil.Fn} Item Id cannot be changed");
			if (!StringUtil.IsEmpty(Attribute) && !Attribute.Equals(data.Attribute))
				throw new NotSupportedException($"{SysUtil.Fn} Attribute cannot be changed");
			if (Logged != DateTime.MinValue && !Logged.Equals(data.Logged))
				throw new NotSupportedException($"{SysUtil.Fn} Logged date/time cannot be changed");
			// Populate individual properties to ensure that 'Changed' indicator is kept up to date.
			this.data.PopulateFrom(data);
		}
		public ItemId ItemId
		{
			get { return data.ItemId; }
			protected set { data.ItemId = value; }
		}
		public String Attribute
		{
			get { return data.Attribute; }
			protected set { data.Attribute = value; }
		}
		public DateTime Logged
		{
			get { return data.Logged; }
			protected set { data.Logged = value; }
		}
		public String DataBefore
		{
			get { return data.DataBefore; }
			set { data.DataBefore = value; }
		}
		public String DataAfter
		{
			get { return data.DataAfter; }
			set { data.DataAfter = value; }
		}

		//-------------------------------------------------------------------
		// List parameters.
		/// <summary>
		/// Item list parameters.
		/// </summary>
		public new class Params : SacsHierarchyItem.Params
		{
			public List<ItemId>     IncludedItemIds    { get; } = new List<ItemId>();
			public List<String>     IncludedAttributes { get; } = new List<String>();
			public DateTime         Logged             { get; set; } = DateTime.MinValue;
			public DateTime         LoggedFrom         { get; set; } = DateTime.MinValue;
			public DateTime         LoggedTo           { get; set; } = DateTime.MinValue;
		}

		//-------------------------------------------------------------------
		//                              L i s t
		//-------------------------------------------------------------------
		public class List : List<SaUpdateLogEntry>
		{
		}

		//-------------------------------------------------------------------
	}

	//=======================================================================
}