Common-VS2019/SacsStandardBase/Base/ReferenceData/SaRegion.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.ReferenceData
{
	//=======================================================================
	public abstract class SaRegion : SacsHierarchyItem
    {
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Hidden,
			Pos,
			Id,
			// Region.
			Type,
			Name,
			Parent,
			// Common properties.
			Notes,
			Status,
			Status_Desc,
			Status_Ind,
			CreateOn_Date,
			UpdateOn_Date,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public SaRegionType RegionType { get; set; } = SaRegionType.Unknown;
			public String Name { get; set; } = "";
			public SysId RegionIdParent { get; set; } = new SysId();
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data ()
			{
				Status = DefaultStatus;
			}
			// Properties.
			public SaRegionType RegionType
			{
				get { return data.RegionType; }
				set { CheckChanged((int)data.RegionType, (int)value); data.RegionType = value; }
			}
			public String Name
			{
				get { return data.Name; }
				set { CheckChanged(data.Name, value); data.Name = value; }
			}
			public SysId RegionIdParent
			{
				get { return data.RegionIdParent; }
				set { CheckChanged(data.RegionIdParent, value); data.RegionIdParent = value; }
			}
			internal void PopulateFrom(Data data)
			{
				RegionType = data.RegionType;
				Name = data.Name;
				RegionIdParent = data.RegionIdParent;
				base.PopulateFrom(data);
			}
			public Data Clone()
			{
				Data data = new Data();
				data.PopulateFrom(this);
				return data;
			}
		}

		//-------------------------------------------------------------------
		public new class ErrField : SacsHierarchyItem.ErrField
		{
			// Identifies the field that has invalid data.
			public ValidValue RegionType { get; set; } = ValidValue.Valid;
			public ValidValue Name { get; set; } = ValidValue.Valid;
			public ValidValue RegionIdParent { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaRegion (SysId id, SaRegionType regionType) : base(id)
		{
			RegionType = regionType;
			Status = DefaultStatus;
			base.SetData(data);
		}

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

		//-------------------------------------------------------------------
		// Utilities.

		//-------------------------------------------------------------------
		// Data.
		public Data GetData() { return data.Clone(); }
		public void SetData(Data data)
		{
			// Properties that cannot be changed if previously specified.
			if (SysId.IsValid(Id) && SysId.ToInt(Id) != SysId.ToInt(data.Id))
				throw new NotSupportedException($"{SysUtil.Fn} Id cannot be changed");
			this.data.PopulateFrom(data);
		}

		//-------------------------------------------------------------------
		// Properties.
		public SaRegionType RegionType
		{
			get { return data.RegionType; }
			protected set { data.RegionType = value; }
		}
		public String Name
		{
			get { return data.Name; }
			set { data.Name = value; }
		}
		public SysId RegionIdParent
		{
			get { return data.RegionIdParent; }
			set { data.RegionIdParent = value; }
		}

		//-------------------------------------------------------------------
		//          A s s o c i a t e d   D a t a   E l e m e n t s          
		//-------------------------------------------------------------------
		public abstract bool HasDependentRegions ();
		public abstract bool HasDependentCurrencies ();
		public abstract bool HasDependentTaxCodes ();

		//-------------------------------------------------------------------
		//                            P a r a m s
		//-------------------------------------------------------------------
		// List parameters.
		public enum StatusCat
		{
			Any,
			ActiveOnly,
		}
		/// <summary>
		/// Item list parameters.
		/// </summary>
		public new class Params : SacsHierarchyItem.Params
		{
			// List filtering.
			public List<SysId> IncludedIds { get; } = new List<SysId>();
			public List<SysId> ExcludedIds { get; } = new List<SysId>();
			// Region.
			public SaRegionType RegionType { get; set; } = SaRegionType.Unknown;
			public String Name { get; set; }
			public String NamePartial { get; set; }
			public SysId RegionIdParent { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.Any;
		}

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

	//=======================================================================
	//                 R e g i o n   D a t a   L i s t
	//=======================================================================
	public static class SaRegionList
	{
		/// <summary>Retrieve region with specified Id.</summary>
		public static SaRegion FindById (this List<SaRegion> values, SysId measureId)
		{
			return values.Find(item => item.Id.Equals(measureId));
		}
	}

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