Common-VS2019/SacsStandardBase/Base/Interfaces/SaInterfaceProcessMessage.cs

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

namespace Sarand.Net.Standard.Base.Interfaces
{
	//=======================================================================
	public class SaInterfaceProcessMessage : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos = 0,
			Id,
			// Process.
			ProcessId,
			// Message.
			Level,
			Level_Desc,
			Message,
			Filename,
			LineNumber,
			ItemType,
			ItemType_Desc,
			ItemId,
			Item_Caption,
			// Common properties.
			Notes,
			Status,
			Status_Desc,
			Status_Ind,
			CreateOn_Date,
			UpdateOn_Date,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public SysId InterfaceProcessId { get; set; } = null;
			public SaMessageLevel Level { get; set; } = SaMessageLevel.Unknown;
			public String Message { get; set; } = String.Empty;
			public String Filename { get; set; } = String.Empty;
			public int LineNumber { get; set; } = 0;
			public ItemId ItemId { get; set; } = new ItemId();
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data ()
			{
				Status = DefaultStatus;
			}
			// Properties.
			public SysId InterfaceProcessId
			{
				get { return data.InterfaceProcessId; }
				set { CheckChanged(data.InterfaceProcessId, value); data.InterfaceProcessId = value; }
			}
			public SaMessageLevel Level
			{
				get { return data.Level; }
				set { CheckChanged((int)data.Level, (int)value); data.Level = value; }
			}
			public String Message
			{
				get { return data.Message; }
				set { CheckChanged(data.Message, value); data.Message = value; }
			}
			public String Filename
			{
				get { return data.Filename; }
				set { CheckChanged(data.Filename, value); data.Filename = value; }
			}
			public int LineNumber
			{
				get { return data.LineNumber; }
				set { CheckChanged(data.LineNumber, value); data.LineNumber = value; }
			}
			public ItemId ItemId
			{
				get { return data.ItemId; }
				set { if (value == null) value = new ItemId(); CheckChanged(data.ItemId, value); data.ItemId = value; }
			}
			// Population.
			internal void PopulateFrom (Data data)
			{
				InterfaceProcessId = data.InterfaceProcessId;
				Level = data.Level;
				Message = data.Message;
				Filename = data.Filename;
				LineNumber = data.LineNumber;
				ItemId = data.ItemId;
				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 InterfaceProcessId { get; set; } = ValidValue.Valid;
			public ValidValue Level { get; set; } = ValidValue.Valid;
			public ValidValue Message { get; set; } = ValidValue.Valid;
			public ValidValue Filename { get; set; } = ValidValue.Valid;
			public ValidValue LineNumber { get; set; } = ValidValue.Valid;
			public ValidValue ItemId { get; set; } = ValidValue.Valid;
		}

		//-------------------------------------------------------------------
		// Data members.
		private readonly Data data = new Data();
		// Flags.
		public static readonly UInt16 Flag_ = 0x01;

		//-------------------------------------------------------------------
		// Construction.
		public SaInterfaceProcessMessage (SysId id, SysId interfaceProcessId) :
			base(id)
		{
			base.SetData(data);
			InterfaceProcessId = interfaceProcessId;
			Status = DefaultStatus;
		}

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

		//-------------------------------------------------------------------
		// Properties.
		public Data GetData () { return data.Clone(); }
		public void SetData (Data data)
		{
			String fn = GetType().Name + ".SetData";
			// Properties that cannot be changed if previously specified.
			if (SysId.IsValid(Id) && SysId.ToInt(Id) != SysId.ToInt(data.Id))
				throw new NotSupportedException(fn + " Id cannot be changed");
			if (SysId.IsValid(InterfaceProcessId) && SysId.ToInt(InterfaceProcessId) != SysId.ToInt(data.InterfaceProcessId))
				throw new NotSupportedException(fn + " Id cannot be changed");
			// Populate individual properties to ensure that 'Changed' indicator is kept up to date.
			this.data.PopulateFrom(data);
		}
		public SysId InterfaceProcessId
		{
			get { return data.InterfaceProcessId; }
			protected set { data.InterfaceProcessId = value; }
		}
		public SaMessageLevel Level
		{
			get { return data.Level; }
			set { data.Level = value; }
		}
		public String Message
		{
			get { return data.Message; }
			set { data.Message = value; }
		}
		public String Filename
		{
			get { return data.Filename; }
			set { data.Filename = value; }
		}
		public int LineNumber
		{
			get { return data.LineNumber; }
			set { data.LineNumber = value; }
		}
		public ItemId ItemId
		{
			get { return data.ItemId; }
			set { data.ItemId = value; }
		}

		//-------------------------------------------------------------------
		// Flags.

		//-------------------------------------------------------------------
		// List parameters.
		public enum StatusCat
		{
			Any,
			CompletedOnly,
		}
		/// <summary>
		/// Item list parameters.
		/// </summary>
		public new class Params : SacsHierarchyItem.Params
		{
			public List<SysId> IncludedIds { get; } = new List<SysId>();
			public List<SysId> ExcludedIds { get; } = new List<SysId>();
			public SysId InterfaceProcessId  { get; set; } = new SysId();
			public List<ItemId> IncludedItemIds { get; } = new List<ItemId>();
			public StatusCat StatusCat { get; set; } = StatusCat.Any;
		}

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

		//-------------------------------------------------------------------
	}
	//=======================================================================
}