Saxonite/SaxoniteStandardBase/Base/Bus/SaxUserRole.cs

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.Text;

namespace Saxonite.Net.Standard.Base.Bus
{
	//=======================================================================
	// UserRole.
	//=======================================================================
	public abstract class SaxUserRole : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			Id,
			UserAccountId,
			UserRole,
			UserRole_Desc,
			// Login - Admin for System user.
			LastLoginOn,
			LastLoginAt,
			LastInvalidLoginOn,
			LastInvalidLoginAt,
			InvalidLoginCount,
			// User.
			User_EmailAddress,
			User_DisplayName,
			User_Title,
			User_FirstName,
			User_LastName,
			// 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 Sax.UserRole UserRole { get; set; }
			// Login.
			public DateTime? LastLoginAt { get; set; } = null;
			public DateTime? LastInvalidLoginAt { get; set; } = null;
			public short? InvalidLoginCount { 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 UserAccountId
			{
				get { return data.UserAccountId; }
				set { CheckChanged(data.UserAccountId, value); data.UserAccountId = value; }
			}
			public Sax.UserRole UserRole
			{
				get { return data.UserRole; }
				set { CheckChanged((int)data.UserRole, (int)value); data.UserRole = value; }
			}
			// Login.
			public DateTime? LastLoginAt
			{
				get { return data.LastLoginAt; }
				set { CheckChangedNullable(data.LastLoginAt, value); data.LastLoginAt = value; }
			}
			public DateTime? LastInvalidLoginAt
			{
				get { return data.LastInvalidLoginAt; }
				set { CheckChangedNullable(data.LastInvalidLoginAt, value); data.LastInvalidLoginAt = value; }
			}
			public short? InvalidLoginCount
			{
				get { return data.InvalidLoginCount; }
				set { CheckChangedNullable(data.InvalidLoginCount, value); data.InvalidLoginCount = value; }
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				UserAccountId = data.UserAccountId;
				UserRole = data.UserRole;
				// Login.
				LastLoginAt = data.LastLoginAt;
				LastInvalidLoginAt = data.LastInvalidLoginAt;
				InvalidLoginCount = data.InvalidLoginCount;
				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 UserRole { get; set; } = ValidValue.Valid;
			// Login.
			public ValidValue LastLogin { get; set; } = ValidValue.Valid;
			public ValidValue LastInvalidLogin { get; set; } = ValidValue.Valid;
			public ValidValue InvalidLoginCount { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxUserRole(SysId id, SysId userAccountId, Sax.UserRole userRole) : base(id)
		{
			base.SetData(data);
			UserAccountId = userAccountId;
			UserRole = userRole;
			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.UserRole, 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");
			if (SysId.IsValid(UserAccountId) && SysId.ToInt(UserAccountId) != SysId.ToInt(data.UserAccountId))
				throw new NotSupportedException(fn + " User Account Id cannot be changed");
			if (UserRole == 0 && (int)UserRole != (int)UserRole)
				throw new NotSupportedException(fn + " User Role cannot be changed");
			this.data.PopulateFrom(data);
		}
		/// <summary>User Account Id. NB Can only be set where previously invalid.</summary>
		public SysId UserAccountId
		{
			get { return data.UserAccountId; }
			set
			{
				if (SysId.IsValid(UserAccountId) && SysId.ToInt(UserAccountId) != SysId.ToInt(data.UserAccountId))
					throw new NotSupportedException("UserRole.UserAccountId cannot be changed");
				data.UserAccountId = value;
			}
		}
		/// <summary>User Role. Can only be populated on construction.</summary>
		public Sax.UserRole UserRole
		{
			get { return data.UserRole; }
			protected set { data.UserRole = value; }
		}

		// Login - Admin application for System Admin role.
		public DateTime? LastLoginAt
		{
			get { return data.LastLoginAt; }
			set { data.LastLoginAt = value; }
		}
		public DateTime? LastInvalidLoginAt
		{
			get { return data.LastInvalidLoginAt; }
			set { data.LastInvalidLoginAt = value; }
		}
		public short? InvalidLoginCount
		{
			get { return data.InvalidLoginCount; }
			set { data.InvalidLoginCount = value; }
		}

		//-------------------------------------------------------------------
		// Flags - positions 1-16 available.
		// Keep logged in - Admin application for System Admin role.
		public Byte Flag_KeepLoggedIn { get; } = 0x1;
		public bool KeepLoggedIn
		{
			get { return GetFlag(Flag_KeepLoggedIn); }
			set { SetFlag(Flag_KeepLoggedIn, 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
		{
			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<Sax.UserRole> UserRolesIncluded { get; } = new List<Sax.UserRole>();
			// Common properties.
			public String NotesPartial { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.NotDeleted;
		}

		//-------------------------------------------------------------------
	}
	//=======================================================================
	// Item list extension methods.
	public static class SaxUserRoleList
	{
		//-------------------------------------------------------------------
		/// <summary>Retrieve the first entry in the list matching the specified role.</summary>
		public static SaxUserRole GetUserRoleByRole(this List<SaxUserRole> values, Sax.UserRole userRole)
		{
			return values.Find(item => item.UserRole == userRole);
		}

		//-------------------------------------------------------------------
		/// <summary>Retrieve the first entry in the list matching the specified role.</summary>
		public static List<SaxUserRole> GetUserRolesByStatus(this List<SaxUserRole> values, SaStatus status)
		{
			return values.FindAll(item => item.Status == status);
		}

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

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