Saxonite/Workspace/SaxoniteStandardBase/Base/Bus/SaxOrganisationEvent.cs

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

namespace Saxonite.Net.Standard.Base.Bus
{
	//=======================================================================
	// Organisation Event.
	//=======================================================================
	public abstract class SaxOrganisationEvent : SaxDisposableHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			Id,
			// Organisation.
			OrganisationId,
			Organisation_Name,
			Organisation_LogoCount,
			// Sport.
			SportIdPrimary,
			Sport_Name,
			// Region.
			RegionIdCountry,
			Region_Name,
			// Event.
			EventAt_Date,
			EventAt_DateTime,
			EventTo_Date,
			EventTo_DateTime,
			EventTypeCode,
			EventType_Desc,
			Summary,
			Details,
			PublishedAt_Date,
			PublishedAt_DateTime,
			ExpiresAt_Date,
			ExpiresAt_DateTime,
			// 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 OrganisationId { get; set; }
			public SysId SportIdPrimary { get; set; }
			public SysId RegionIdCountry { get; set; }
			public DateTime EventAt { get; set; }
			public DateTime? EventTo { get; set; }
			public Sax.EventType EventType { get; set; }
			public String Summary { get; set; } = String.Empty;
			public String Details { get; set; } = String.Empty;
			public String EventData { get; set; } = String.Empty;
			public DateTime? PublishedAt { get; set; } = null;
			public DateTime? ExpiresAt { get; set; } = null;
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data()
			{
				Status = DefaultStatus;
			}
			// Properties.
			public SysId OrganisationId
			{
				get { return data.OrganisationId; }
				set { CheckChanged(data.OrganisationId, value); data.OrganisationId = value; }
			}
			public SysId SportIdPrimary
			{
				get { return data.SportIdPrimary; }
				set { CheckChanged(data.SportIdPrimary, value); data.SportIdPrimary = value; }
			}
			public SysId RegionIdCountry
			{
				get { return data.RegionIdCountry; }
				set { CheckChanged(data.RegionIdCountry, value); data.RegionIdCountry = value; }
			}
			public DateTime EventAt
			{
				get { return data.EventAt; }
				set { CheckChanged(data.EventAt, value); data.EventAt = value; }
			}
			public DateTime? EventTo
			{
				get { return data.EventTo; }
				set { CheckChangedNullable(data.EventTo, value); data.EventTo = value; }
			}
			public Sax.EventType EventType
			{
				get { return data.EventType; }
				set { CheckChanged((int)data.EventType, (int)value); data.EventType = value; }
			}
			public String Summary
			{
				get { return data.Summary; }
				set { CheckChanged(data.Summary, value); data.Summary = value; }
			}
			public String Details
			{
				get { return data.Details; }
				set { CheckChanged(data.Details, value); data.Details = value; }
			}
			public String EventData
			{
				get { return data.EventData; }
				set { CheckChanged(data.EventData, value); data.EventData = value; }
			}
			public DateTime? PublishedAt
			{
				get { return data.PublishedAt; }
				set { CheckChangedNullable(data.PublishedAt, value); data.PublishedAt = value; }
			}
			public DateTime? ExpiresAt
			{
				get { return data.ExpiresAt; }
				set { CheckChangedNullable(data.ExpiresAt, value); data.ExpiresAt = value; }
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				OrganisationId = data.OrganisationId;
				SportIdPrimary = data.SportIdPrimary;
				RegionIdCountry = data.RegionIdCountry;
				EventAt = data.EventAt;
				EventTo = data.EventTo;
				EventType = data.EventType;
				Summary = data.Summary;
				Details = data.Details;
				EventData = data.EventData;
				PublishedAt = data.PublishedAt;
				ExpiresAt = data.ExpiresAt;
				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 OrganisationId { get; set; } = ValidValue.Valid;
			public ValidValue SportIdPrimary { get; set; } = ValidValue.Valid;
			public ValidValue RegionIdCountry { get; set; } = ValidValue.Valid;
			public ValidValue EventAt { get; set; } = ValidValue.Valid;
			public ValidValue EventTo { get; set; } = ValidValue.Valid;
			public ValidValue EventType { get; set; } = ValidValue.Valid;
			public ValidValue Summary { get; set; } = ValidValue.Valid;
			public ValidValue Details { get; set; } = ValidValue.Valid;
			public ValidValue EventData { get; set; } = ValidValue.Valid;
			public ValidValue PublishedAt { get; set; } = ValidValue.Valid;
			public ValidValue ExpiresAt { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxOrganisationEvent(SysId id, SysId organisationId) : base(id)
		{
			base.SetData(data);
			this.OrganisationId = organisationId;
			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.OrganisationEvent, Id);
		}

		/// <summary>
		/// Time of exactly midnight is treated as invalid.
		/// <para>- Valid start time of midnight is stored with at least +1 minute (00:01:00).</para>
		/// </summary>
		public static bool HasValidEventTime(DateTime? eventDateTime)
		{
			return DateUtil.IsValid(eventDateTime) && DateUtil.Format(eventDateTime, "HH:mm:ss") != "00:00:00";
		}

		public bool HasValidEventAtTime()
		{
			return HasValidEventTime(EventAt);
		}

		public bool HasValidEventToTime()
		{
			return HasValidEventTime(EventTo);
		}

		//-------------------------------------------------------------------
		// Properties.
		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");
			if (SysId.IsValid(OrganisationId) && SysId.ToInt(OrganisationId) != SysId.ToInt(data.OrganisationId))
				throw new NotSupportedException($"{SysUtil.Fn} Organisation Id cannot be changed");
			this.data.PopulateFrom(data);
		}
		public SysId OrganisationId
		{
			get { return data.OrganisationId; }
			protected set { data.OrganisationId = value; }
		}
		public SysId SportIdPrimary
		{
			get { return data.SportIdPrimary; }
			set { data.SportIdPrimary = value; }
		}
		public SysId RegionIdCountry
		{
			get { return data.RegionIdCountry; }
			set { data.RegionIdCountry = value; }
		}
		public DateTime EventAt
		{
			get { return data.EventAt; }
			set { data.EventAt = value; }
		}
		public DateTime? EventTo
		{
			get { return data.EventTo; }
			set { data.EventTo = value; }
		}
		public Sax.EventType EventType
		{
			get { return data.EventType; }
			set { data.EventType = value; }
		}
		public String Summary
		{
			get { return data.Summary; }
			set { data.Summary = value; }
		}
		public String Details
		{
			get { return data.Details; }
			set { data.Details = value; }
		}
		public String EventData
		{
			get { return data.EventData; }
			set { data.EventData = value; }
		}
		public DateTime? PublishedAt
		{
			get { return data.PublishedAt; }
			set { data.PublishedAt = value; }
		}
		public DateTime? ExpiresAt
		{
			get { return data.ExpiresAt; }
			set { data.ExpiresAt = value; }
		}

		//-------------------------------------------------------------------
		// Flags - positions 1-16 available.

		//-------------------------------------------------------------------
		//                   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
		{
			Any,
			ActiveOnly,
			InactiveOnly,
			NotDeleted,
			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>();
			/// <summary>Restrict to User Account via User Organisations and Organisations.</summary>
			public List<SysId> UserAccountIdsIncluded { get; } = new List<SysId>();
			public List<SysId> OrganisationIdsIncluded { get; } = new List<SysId>();
			public List<SysId> SportIdsIncluded { get; set; } = new List<SysId>();
			public List<SysId> RegionIdsIncluded { get; } = new List<SysId>();
			public DateTime EventFrom { get; set; }
			public DateTime EventTo { get; set; }
			public String SummaryPartial { get; set; }
			/// <summary>General filter value - position, outline, sport, body etc. </summary>
			public String EventFilter { get; set; }
			public String NotesPartial { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.ActiveOnly;
			// Table aliases - blank if not linked.
			public String Alias_Organisation { get; set; }
			public String Alias_UserOrganisation { get; set; }
			public String Alias_UserAccount { get; set; }
		}

		//-------------------------------------------------------------------
	}
	//=======================================================================
	// Item list extension methods.
	public static class SaxOrganisationEventList
	{
	}

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