Saxonite/SaxoniteStandardBase/Base/Bus/Reference/SaxGolfUsgaProvince.cs

using NPOI.SS.Formula.Functions;
using Sarand.Net.Standard.Base.Bus;
using Sarand.Net.Standard.Base.Core;
using Saxonite.Net.Standard.Base.App;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Saxonite.Net.Standard.Base.Bus.Reference
{
	//=======================================================================
	// Golf - USGA Province.
	//=======================================================================
	public abstract class SaxGolfUsgaProvince : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			Id,
			CountryId,
			Country_Name,
			ProvinceCode,
			EntProvinceCode,
			ProvinceName,
			// Associated data.
			// Common.
			Notes,
			Flags,
			Status,
			Status_Desc,
			Status_Ind,
			CreateOn_Date,
			UpdateOn_Date,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public SysId CountryId { get; set; }
			public String ProvinceCode { get; set; } = String.Empty;
			public String EntProvinceCode { get; set; } = String.Empty;
			public String ProvinceName { 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 SysId CountryId
			{
				get { return data.CountryId; }
				set { CheckChanged(data.CountryId, value); data.CountryId = value; }
			}
			public String ProvinceCode
			{
				get { return data.ProvinceCode; }
				set { CheckChanged(data.ProvinceCode, value); data.ProvinceCode = value; }
			}
			public String EntProvinceCode
			{
				get { return data.EntProvinceCode; }
				set { CheckChanged(data.EntProvinceCode, value); data.EntProvinceCode = value; }
			}
			public String ProvinceName
			{
				get { return data.ProvinceName; }
				set { CheckChanged(data.ProvinceName, value); data.ProvinceName = value; }
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				CountryId = data.CountryId;
				ProvinceCode = data.ProvinceCode;
				EntProvinceCode = data.EntProvinceCode;
				ProvinceName = data.ProvinceName;
				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 CountryId { get; set; } = ValidValue.Valid;
			public ValidValue ProvinceCode { get; set; } = ValidValue.Valid;
			public ValidValue EntProvinceCode { get; set; } = ValidValue.Valid;
			public ValidValue ProvinceName { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxGolfUsgaProvince(SysId id, SysId countryId) : base(id)
		{
			base.SetData(data);
			this.CountryId = countryId;
			Status = DefaultStatus;
		}

		//-------------------------------------------------------------------
		// Status.
		private static readonly List<SaStatus> validStatuses = new List<SaStatus>()
		{
			SaStatus.Active,
			SaStatus.Inactive,
			SaStatus.Deleted,
		};
		public static SaStatus DefaultStatus { get { return SaStatus.Active; } }
		public static List<SaStatus> ValidStatuses { get { return new List<SaStatus>(validStatuses); } }
		public static DataValue.TriStateType GetStatusTriState(SaStatus status)
		{
			if (status == SaStatus.Active) return DataValue.TriStateType.Green;
			if (status == SaStatus.Inactive) return DataValue.TriStateType.Red;
			if (status == SaStatus.Deleted) return DataValue.TriStateType.Purple;
			return DataValue.TriStateType.Unknown;
		}

		//-------------------------------------------------------------------
		// Utilities.
		public ItemId GetItemId()
		{
			return new ItemId((short)Sax.DataItemType.Golf_UsgaProvince, Id);
		}

		//-------------------------------------------------------------------
		// 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");
			this.data.PopulateFrom(data);
		}
		public SysId CountryId
		{
			get { return data.CountryId; }
			set { data.CountryId = value; }
		}
		public String ProvinceCode
		{
			get { return data.ProvinceCode; }
			set { data.ProvinceCode = value; }
		}
		public String EntProvinceCode
		{
			get { return data.EntProvinceCode; }
			set { data.EntProvinceCode = value; }
		}
		public String ProvinceName
		{
			get { return data.ProvinceName; }
			set { data.ProvinceName = value; }
		}

		//-------------------------------------------------------------------
		// Flags - positions 1-16 available.
		public const byte Flag_Priority = 0x01;
		public bool Priority
		{
			get { return GetFlag(Flag_Priority); }
			set { SetFlag(Flag_Priority, value); }
		}

		//-------------------------------------------------------------------
		//                   A s s o c i a t e d   D a t a
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
		//                            P a r a m s
		//-------------------------------------------------------------------
		// List parameters.
		public enum StatusCat
		{
			NotDeleted = 0,
			ActiveOnly,
			InactiveOnly,
			Any,
			DeletedOnly,
		}
		/// <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>();
			public List<SysId> CountryIdsIncluded { get; } = new List<SysId>();
			/// <summary>Generic filter - partial province code or name.</summary>
			public String ProvinceFilter { get; set; }
			public String ProvinceCodeFull { get; set; }
			public String ProvinceNameFull { get; set; }
			public String ProvinceNamePartial { get; set; }
			// Flags.
			public FlagState PriorityFlagState { get; set; } = FlagState.Either;
			// Associated data.
			public BoolState HasFacilities { get; set; } = BoolState.Either;
			// Common properties.
			public String NotesPartial { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.ActiveOnly;
			// Table aliases - blank if not linked.
			public String Alias_Country { get; set; }
		}

		//-------------------------------------------------------------------
	}
	//=======================================================================
	// Item list extension methods.
	public static class SaxGolfUsgaProvinceList
	{
		//-------------------------------------------------------------------
		public static SaxGolfUsgaProvince GetProvinceById(this IEnumerable<SaxGolfUsgaProvince> values, SysId provinceId)
		{
			if (!SysId.IsValid(provinceId)) return null;
			foreach (SaxGolfUsgaProvince province in values)
				if (province.Id.Equals(provinceId)) return province;
			return null;
		}

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

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