Common-VS2019/SacsStandardBase/Base/ReferenceData/SaLanguage.cs

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

namespace Sarand.Net.Standard.Base.ReferenceData
{
	//=======================================================================
	public abstract class SaLanguage : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Hidden,
			Pos,
			Id,
			// Language.
			Code,
			Name,
			LanguageIdPrimary,
			Unicode,
			Translation,
			// Common properties.
			CreateOn_Date,
			UpdateOn_Date,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public String Code { get; set; } = "";
			public String Name { get; set; } = "";
			public SysId LanguageIdPrimary { get; set; } = new SysId();
			public bool Unicode { get; set; } = false;
			public bool Translation { get; set; } = false;
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data ()
			{
				// Language has no status.
			}
			// Properties.
			public String Code
			{
				get { return data.Code; }
				set { CheckChanged(data.Code, value); data.Code = value; }
			}
			public String Name
			{
				get { return data.Name; }
				set { CheckChanged(data.Name, value); data.Name = value; }
			}
			public SysId LanguageIdPrimary
			{
				get { return data.LanguageIdPrimary; }
				set { CheckChanged(data.LanguageIdPrimary, value); data.LanguageIdPrimary = value; }
			}
			public bool Unicode
			{
				get { return data.Unicode; }
				set { CheckChanged(data.Unicode, value); data.Unicode = value; }
			}
			public bool Translation
			{
				get { return data.Translation; }
				set { CheckChanged(data.Translation, value); data.Translation = value; }
			}
			internal void PopulateFrom (Data data)
			{
				Code = data.Code;
				Name = data.Name;
				LanguageIdPrimary = data.LanguageIdPrimary;
				Unicode = data.Unicode;
				Translation = data.Translation;
				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 Code { get; set; } = ValidValue.Valid;
			public ValidValue Name { get; set; } = ValidValue.Valid;
			public ValidValue LanguageIdPrimary { get; set; } = ValidValue.Valid;
			public ValidValue Unicode { get; set; } = ValidValue.Valid;
			public ValidValue Translation { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Static construction.
		static SaLanguage ()
		{
		}

		//-------------------------------------------------------------------
		// Construction.
		protected SaLanguage (SysId id) : base(id)
		{
			base.SetData(data);
			// Language has no status.
		}

		//-------------------------------------------------------------------
		// Statuses - not applicable for languages.

		//-------------------------------------------------------------------
		// 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");
			// Populate individual properties to ensure that 'Changed' indicator is kept up to date.
			this.data.PopulateFrom(data);
		}

		//-------------------------------------------------------------------
		// Properties.
		public String Code
		{
			get { return data.Code; }
			set { data.Code = value; }
		}
		public String Name
		{
			get { return data.Name; }
			set { data.Name = value; }
		}
		public SysId LanguageIdPrimary
		{
			get { return data.LanguageIdPrimary; }
			set { data.LanguageIdPrimary = value; }
		}
		public bool Unicode
		{
			get { return data.Unicode; }
			set { data.Unicode = value; }
		}
		public bool Translation
		{
			get { return data.Translation; }
			set { data.Translation = 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 HasDependentLanguages ();

		//-------------------------------------------------------------------
		//                            P a r a m s
		//-------------------------------------------------------------------
		// List parameters.
		public enum StatusCat
		{
			Any,
		}
		/// <summary>
		/// Item list parameters.
		/// </summary>
		public new class Params : SacsHierarchyItem.Params
		{
			// List filtering.
			public List<SysId> IdsIncluded { get; } = new List<SysId>();
			public List<SysId> IdsExcluded { get; } = new List<SysId>();
			// Item properties.
			public String Code { get; set; }
			public String CodePartial { get; set; }
			public String Name { get; set; }
			public String NamePartial { get; set; }
			public SysId LanguageIdPrimary { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.Any;
		}

		//-------------------------------------------------------------------
	}
	//=======================================================================
	//                 L a n g u a g e   D a t a   L i s t
	//=======================================================================
	public static class SaLanguageList
	{
		public static SaLanguage FindById (this List<SaLanguage> values, SysId languageId)
		{
			if (!SysId.IsValid(languageId)) return null;
			return values.Find(item => item.Id.Equals(languageId));
		}
	}

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