Saxonite/SaxoniteStandardBase/Base/Bus/SaxActivityIndex.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
{
	//=======================================================================
	// ActivityIndex.
	//=======================================================================
	public abstract class SaxActivityIndex : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			// Item.
			ItemType,
			ItemType_Code,
			ItemType_Desc,
			ItemId,
			// Author.
			// Organisation.
			OrganisationIdOwner,
			OrganisationOwner_Name,
			OrganisationOwner_LogoCount,
			// User Activity.
			UserActivity_UserAccountId,
			UserActivity_ListedAtLast,
			UserActivity_ViewedAtLast,
			UserActivity_Reaction,
			UserActivity_ReactedAtLast,
			// Article.
			Article_Headline,
			Article_Summary,
			// Organisation opportunity.
			Opportunity_Position,
			Opportunity_Outline,
			// Sport.
			SportId,
			Sport_Name,
			// Region.
			RegionId,
			Region_Name,
			// Properties.
			EffectiveOn,
			ExpiresOn,
			// Associated data.
			// Derived properties.
			// Common.
			Notes,
			Flags,
			Status,
			Status_Desc,
			Status_Ind,
			CreateOn_Date,
			UpdateOn_Date,
		}

		//-------------------------------------------------------------------
		/// <summary>Properties other than common.</summary>
		public class DataProperties
		{
			public ItemId ItemId { get; set; } = new ItemId();
			public SysId UserAccountIdOwner { get; set; }
			public SysId OrganisationIdOwner { get; set; }
			public SysId SportId { get; set; }
			public SysId RegionId { get; set; }
			public DateTime EffectiveOn { get; set; }
			public DateTime? ExpiresOn { 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 ItemId ItemId
			{
				get { return data.ItemId; }
				set { CheckChanged(data.ItemId, value); data.ItemId = value; }
			}
			public SysId UserAccountIdOwner
			{
				get { return data.UserAccountIdOwner; }
				set { CheckChanged(data.UserAccountIdOwner, value); data.UserAccountIdOwner = value; }
			}
			public SysId OrganisationIdOwner
			{
				get { return data.OrganisationIdOwner; }
				set { CheckChanged(data.OrganisationIdOwner, value); data.OrganisationIdOwner = value; }
			}
			public SysId SportId
			{
				get { return data.SportId; }
				set { CheckChanged(data.SportId, value); data.SportId = value; }
			}
			public SysId RegionId
			{
				get { return data.RegionId; }
				set { CheckChanged(data.RegionId, value); data.RegionId = value; }
			}
			public DateTime EffectiveOn
			{
				get { return data.EffectiveOn; }
				set
				{
					// Values are restricted to whole date, ie. no time.
					CheckChanged(data.EffectiveOn, value.Date);
					data.EffectiveOn = value.Date;
				}
			}
			public DateTime? ExpiresOn
			{
				get { return data.ExpiresOn; }
				set
				{
					// Values are restricted to whole date, ie. no time.
					CheckChangedNullable(data.ExpiresOn, value?.Date);
					data.ExpiresOn = value?.Date;
				}
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				ItemId = data.ItemId;
				UserAccountIdOwner = data.UserAccountIdOwner;
				OrganisationIdOwner = data.OrganisationIdOwner;
				SportId = data.SportId;
				RegionId = data.RegionId;
				EffectiveOn = data.EffectiveOn;
				ExpiresOn = data.ExpiresOn;
				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 ItemId { get; set; } = ValidValue.Valid;
			public ValidValue UserAccountIdOwner { get; set; } = ValidValue.Valid;
			public ValidValue OrganisationIdOwner { get; set; } = ValidValue.Valid;
			public ValidValue SportId { get; set; } = ValidValue.Valid;
			public ValidValue RegionId { get; set; } = ValidValue.Valid;
			public ValidValue EffectiveOn { get; set; } = ValidValue.Valid;
			public ValidValue ExpiresOn { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxActivityIndex(ItemId itemId, SysId sportId, SysId regionId) : base()
		{
			base.SetData(data);
			ItemId = itemId;
			SportId = sportId;
			RegionId = regionId;
			Status = DefaultStatus;
		}

		//-------------------------------------------------------------------
		// Item Types.
		private readonly static List<Sax.DataItemType> validItemTypes = new List<Sax.DataItemType>()
			{ Sax.DataItemType.Article, Sax.DataItemType.OrganisationEvent, Sax.DataItemType.OrganisationOpportunity };
		public static List<Sax.DataItemType> ValidItemTypes { get { return new List<Sax.DataItemType>(validItemTypes); } }

		//-------------------------------------------------------------------
		// Status.
		private static readonly List<SaStatus> validStatuses = new List<SaStatus>()
		{
			SaStatus.Active,
		};
		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.
		/// <summary>
		/// Match the item to the sport and region.
		/// </summary>
		public bool MatchesSportRegion(SysId sportId, SysId regionId)
		{
			if (!SportId.Equals(sportId)) return false;
			if (!RegionId.Equals(regionId)) return false;
			return true;
		}

		//-------------------------------------------------------------------
		// Properties.
		public override bool ItemHasId { get; } = false;
		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 (ItemId.IsValid(ItemId) && ItemId.Type != data.ItemId.Type && SysId.ToInt(ItemId.Id) != SysId.ToInt(data.ItemId.Id))
				throw new NotSupportedException($"{SysUtil.Fn} Item Id cannot be changed");
			if (SysId.IsValid(SportId) && SysId.ToInt(SportId) != SysId.ToInt(data.SportId))
				throw new NotSupportedException($"{SysUtil.Fn} Sport Id cannot be changed");
			if (SysId.IsValid(RegionId) && SysId.ToInt(RegionId) != SysId.ToInt(data.RegionId))
				throw new NotSupportedException($"{SysUtil.Fn} Region Id cannot be changed");
			this.data.PopulateFrom(data);
		}
		public ItemId ItemId
		{
			get { return data.ItemId; }
			protected set { data.ItemId = value; }
		}
		public SysId UserAccountIdOwner
		{
			get { return data.UserAccountIdOwner; }
			set { data.UserAccountIdOwner = value; }
		}
		public SysId OrganisationIdOwner
		{
			get { return data.OrganisationIdOwner; }
			set { data.OrganisationIdOwner = value; }
		}
		public SysId SportId
		{
			get { return data.SportId; }
			protected set { data.SportId = value; }
		}
		public SysId RegionId
		{
			get { return data.RegionId; }
			protected set { data.RegionId = value; }
		}
		public DateTime EffectiveOn
		{
			get { return data.EffectiveOn; }
			set { data.EffectiveOn = value; }
		}
		public DateTime? ExpiresOn
		{
			get { return data.ExpiresOn; }
			set { data.ExpiresOn = 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
		//-------------------------------------------------------------------
		/// <summary>
		/// Combination Sport and Region Ids to index activities.
		/// </summary>
		public class SportRegionIds
		{
			public SportRegionIds(SysId sportId, SysId regionId)
			{
				SportId = sportId;
				RegionId = regionId;
			}
			public SysId SportId { get; }
			public SysId RegionId { get; }
		}
		/// <summary>
		/// Item list parameters.
		/// </summary>
		public new class Params : SacsHierarchyItem.Params
		{
			// List filtering.
			public List<ItemId> ItemIdsIncluded { get; } = new List<ItemId>();
			/// <summary>Activities must match one of the sport/region combinations specified.</summary>
			public List<SportRegionIds> SportRegionIdsIncluded { get; } = new List<SportRegionIds>();
			/// <summary>Owner User Accounts - to include activities in result for users regardless of sports/regions.</summary>
			public List<SysId> UserAccountIdsOwnerIncluded { get; } = new List<SysId>();
			/// <summary>Owner Organisations - to include activities in result for organisations regardless of sport/region combinations.</summary>
			public List<SysId> OrganisationIdsOwnerIncluded { get; } = new List<SysId>();
			/// <summary>User Account - to include User Activity data in result.</summary>
			public SysId UserAccountId { get; set; }
			public DateTime EffectiveFrom { get; set; }
			public DateTime EffectiveTo { get; set; }
			/// <summary>Not Expired - either Expiry date not set or is after specified date.</summary>
			public DateTime NotExpiredOn { get; set; }
			// Table aliases - blank if not linked.
			public String Alias_ActivityIndex { get; set; }
		}

		//-------------------------------------------------------------------
	}
	//=======================================================================
	// Item list extension methods.
	public static class SaxActivityIndexList
	{
		/// <summary>
		/// Get first entry that matches the sport and region.
		/// </summary>
		public static SaxActivityIndex GetActivityIndexBySportRegion(this List<SaxActivityIndex> values, SysId sportId, SysId regionId)
		{
			return values.Find(item => item.MatchesSportRegion(sportId, regionId));
		}
	}

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