Saxonite/Workspace/SaxoniteStandardBase/Base/Bus/SaxUserActivity.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
{
	//=======================================================================
	// UserActivity.
	//=======================================================================
	public abstract class SaxUserActivity : SaxDisposableHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			Id,
			// User.
			UserAccountId,
			User_EmailAddress,
			User_DisplayName,
			User_Title,
			User_FirstName,
			User_LastName,
			// Activity.
			ItemType,
			ItemType_Code,
			ItemType_Desc,
			ItemId,
			FirstListedAt,
			LastListedAt,
			FirstViewedAt,
			LastViewedAt,
			Reaction,
			FirstReactedAt,
			LastReactedAt,
			// 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 UserAccountId { get; set; }
			public ItemId ItemId { get; set; } = new ItemId();
			public bool CurrentlyListed {get; set; }
			public DateTime ListedAtFirst { get; set; }
			public DateTime? ListedAtLast { get; set; } = null;
			public DateTime? ViewedAtFirst { get; set; } = null;
			public DateTime? ViewedAtLast { get; set; } = null;
			public Sax.ActivityReaction Reaction { get; set; }
			public DateTime? ReactedAtFirst { get; set; } = null;
			public DateTime? ReactedAtLast { get; set; } = null;
			public String UserActivityData { get; set; }
		}

		//-------------------------------------------------------------------
		// Data.
		public new class Data : SacsHierarchyItem.Data
		{
			// Data members.
			private readonly DataProperties data = new DataProperties();
			// Construction.
			public Data()
			{
				Status = DefaultStatus;
			}
			// Properties.
			public SysId UserAccountId
			{
				get { return data.UserAccountId; }
				set { CheckChanged(data.UserAccountId, value); data.UserAccountId = value; }
			}
			public ItemId ItemId
			{
				get { return data.ItemId; }
				set { CheckChanged(data.ItemId, value); data.ItemId = value; }
			}
			public bool CurrentlyListed
			{
				get { return data.CurrentlyListed; }
				set { CheckChanged(data.CurrentlyListed, value); data.CurrentlyListed = value; }
			}
			public DateTime ListedAtFirst
			{
				get { return data.ListedAtFirst; }
				set { CheckChanged(data.ListedAtFirst, value); data.ListedAtFirst = value; }
			}
			public DateTime? ListedAtLast
			{
				get { return data.ListedAtLast; }
				set { CheckChangedNullable(data.ListedAtLast, value); data.ListedAtLast = value; }
			}
			public DateTime? ViewedAtFirst
			{
				get { return data.ViewedAtFirst; }
				set { CheckChangedNullable(data.ViewedAtFirst, value); data.ViewedAtFirst = value; }
			}
			public DateTime? ViewedAtLast
			{
				get { return data.ViewedAtLast; }
				set { CheckChangedNullable(data.ViewedAtLast, value); data.ViewedAtLast = value; }
			}
			public Sax.ActivityReaction Reaction
			{
				get { return data.Reaction; }
				set { CheckChanged((int)data.Reaction, (int)value); data.Reaction = value; }
			}
			public DateTime? ReactedAtFirst
			{
				get { return data.ReactedAtFirst; }
				set { CheckChangedNullable(data.ReactedAtFirst, value); data.ReactedAtFirst = value; }
			}
			public DateTime? ReactedAtLast
			{
				get { return data.ReactedAtLast; }
				set { CheckChangedNullable(data.ReactedAtLast, value); data.ReactedAtLast = value; }
			}
			public String UserActivityData
			{
				get { return data.UserActivityData; }
				set { CheckChanged(data.UserActivityData, value); data.UserActivityData = value; }
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				UserAccountId = data.UserAccountId;
				ItemId = data.ItemId;
				CurrentlyListed = data.CurrentlyListed;
				ListedAtFirst = data.ListedAtFirst;
				ListedAtLast = data.ListedAtLast;
				ViewedAtFirst = data.ViewedAtFirst;
				ViewedAtLast = data.ViewedAtLast;
				Reaction = data.Reaction;
				ReactedAtFirst = data.ReactedAtFirst;
				ReactedAtLast = data.ReactedAtLast;
				UserActivityData = data.UserActivityData;
				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 UserAccountId { get; set; } = ValidValue.Valid;
			public ValidValue ItemId { get; set; } = ValidValue.Valid;
			public ValidValue CurrentlyListed { get; set; } = ValidValue.Valid;
			public ValidValue ListedAtFirst { get; set; } = ValidValue.Valid;
			public ValidValue ListedAtLast { get; set; } = ValidValue.Valid;
			public ValidValue ViewedAtFirst { get; set; } = ValidValue.Valid;
			public ValidValue ViewedAtLast { get; set; } = ValidValue.Valid;
			public ValidValue Reaction { get; set; } = ValidValue.Valid;
			public ValidValue ReactedAtFirst { get; set; } = ValidValue.Valid;
			public ValidValue ReactedAtLast { get; set; } = ValidValue.Valid;
			public ValidValue UserActivityData { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxUserActivity(SysId id, SysId userAccountId, ItemId itemId) : base(id)
		{
			base.SetData(data);
			UserAccountId = userAccountId;
			ItemId = itemId;
			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.UserActivity, Id);
		}

		//-------------------------------------------------------------------
		// 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(UserAccountId) && SysId.ToInt(UserAccountId) != SysId.ToInt(data.UserAccountId))
				throw new NotSupportedException($"{SysUtil.Fn} User Account 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");
			this.data.PopulateFrom(data);
		}
		public SysId UserAccountId
		{
			get { return data.UserAccountId; }
			protected set { data.UserAccountId = value; }
		}
		public ItemId ItemId
		{
			get { return data.ItemId; }
			protected set { data.ItemId = value; }
		}
		public bool CurrentlyListed
		{
			get { return data.CurrentlyListed; }
			set { data.CurrentlyListed = value; }
		}
		public DateTime ListedAtFirst
		{
			get { return data.ListedAtFirst; }
			set { data.ListedAtFirst = value; }
		}
		public DateTime? ListedAtLast
		{
			get { return data.ListedAtLast; }
			set { data.ListedAtLast = value; }
		}
		public DateTime? ViewedAtFirst
		{
			get { return data.ViewedAtFirst; }
			set { data.ViewedAtFirst = value; }
		}
		public DateTime? ViewedAtLast
		{
			get { return data.ViewedAtLast; }
			set { data.ViewedAtLast = value; }
		}
		public Sax.ActivityReaction Reaction
		{
			get { return data.Reaction; }
			set { data.Reaction = value; }
		}
		public DateTime? ReactedAtFirst
		{
			get { return data.ReactedAtFirst; }
			set { data.ReactedAtFirst = value; }
		}
		public DateTime? ReactedAtLast
		{
			get { return data.ReactedAtLast; }
			set { data.ReactedAtLast = value; }
		}
		public String UserActivityData
		{
			get { return data.UserActivityData; }
			set { data.UserActivityData = 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>();
			public List<SysId> UserAccountIdsIncluded { get; } = new List<SysId>();
			public List<ItemId> ItemIdsIncluded { get; } = new List<ItemId>();
			// Common properties.
			public String NotesPartial { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.NotDeleted;
			// Table aliases - blank if not specified/linked.
			public String Alias_UserActivity { get; set; }
		}

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

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