Saxonite/SaxoniteStandardBase/Base/Bus/SaxArticle.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
{
	//=======================================================================
	// Article.
	//=======================================================================
	public abstract partial class SaxArticle : SacsHierarchyItem
	{
		//-------------------------------------------------------------------
		// Columns.
		public enum Column
		{
			Pos,
			Id,
			// Author.
			UserAccountIdAuthor,
			Author_DisplayName,
			Author_Title,
			Author_FirstName,
			Author_LastName,
			// Organisation.
			OrganisationId,
			Organisation_Name,
			Organisation_LogoCount,
			// Sport.
			SportIdPrimary,
			Sport_Name,
			// Region.
			RegionIdPrimary,
			Region_Name,
			// Article.
			Headline,
			Summary,
			ItemImageIdThumbnail,
			PublishedAt_Date,
			PublishedAt_DateTime,
			// Feedback.
			Feedback_ViewCount,
			Feedback_FeedbackCount,
			Feedback_FeedbackTotal,
			Feedback_FeedbackAverage,
			// 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 UserAccountIdAuthor { get; set; }
			public SysId OrganisationId { get; set; }
			public String Headline { get; set; } = String.Empty;
			public String Summary { get; set; } = String.Empty;
			public SysId ItemImageIdThumbnail { get; set; }
			public SysId SportIdPrimary { get; set; }
			public SysId RegionIdPrimary { get; set; }
			public String BodyData { get; set; } = String.Empty;
			public DateTime? PublishedAt { 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 UserAccountIdAuthor
			{
				get { return data.UserAccountIdAuthor; }
				set { CheckChanged(data.UserAccountIdAuthor, value); data.UserAccountIdAuthor = value; }
			}
			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 RegionIdPrimary
			{
				get { return data.RegionIdPrimary; }
				set { CheckChanged(data.RegionIdPrimary, value); data.RegionIdPrimary = value; }
			}
			public String Headline
			{
				get { return data.Headline; }
				set { CheckChanged(data.Headline, value); data.Headline = value; }
			}
			public String Summary
			{
				get { return data.Summary; }
				set { CheckChanged(data.Summary, value); data.Summary = value; }
			}
			public SysId ItemImageIdThumbnail
			{
				get { return data.ItemImageIdThumbnail; }
				set { CheckChanged(data.ItemImageIdThumbnail, value); data.ItemImageIdThumbnail = value; }
			}
			public String BodyData
			{
				get { return data.BodyData; }
				set { CheckChanged(data.BodyData, value); data.BodyData = value; }
			}
			public DateTime? PublishedAt
			{
				get { return data.PublishedAt; }
				set { CheckChangedNullable(data.PublishedAt, value); data.PublishedAt = value; }
			}
			// Population.
			internal void PopulateFrom(Data data)
			{
				UserAccountIdAuthor = data.UserAccountIdAuthor;
				OrganisationId = data.OrganisationId;
				SportIdPrimary = data.SportIdPrimary;
				RegionIdPrimary = data.RegionIdPrimary;
				Headline = data.Headline;
				Summary = data.Summary;
				ItemImageIdThumbnail = data.ItemImageIdThumbnail;
				BodyData = data.BodyData;
				PublishedAt = data.PublishedAt;
				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 UserAccountIdAuthor { get; set; } = ValidValue.Valid;
			public ValidValue OrganisationId { get; set; } = ValidValue.Valid;
			public ValidValue SportIdPrimary { get; set; } = ValidValue.Valid;
			public ValidValue RegionIdPrimary { get; set; } = ValidValue.Valid;
			public ValidValue Headline { get; set; } = ValidValue.Valid;
			public ValidValue Summary { get; set; } = ValidValue.Valid;
			public ValidValue ItemImageIdThumbnail { get; set; } = ValidValue.Valid;
			public ValidValue BodyData { get; set; } = ValidValue.Valid;
			public ValidValue PublishedAt { get; set; } = ValidValue.Valid;
		}

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

		//-------------------------------------------------------------------
		// Construction.
		protected SaxArticle(SysId id, SysId UserAccountIdAuthor, SysId organisationId) : base(id)
		{
			base.SetData(data);
			this.UserAccountIdAuthor = UserAccountIdAuthor;
			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.Article, 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(UserAccountIdAuthor) && SysId.ToInt(UserAccountIdAuthor) != SysId.ToInt(data.UserAccountIdAuthor))
				throw new NotSupportedException(fn + " UserAccountIdAuthor cannot be changed");
			if (SysId.IsValid(OrganisationId) && SysId.ToInt(OrganisationId) != SysId.ToInt(data.OrganisationId))
				throw new NotSupportedException(fn + " OrganisationId cannot be changed");
			this.data.PopulateFrom(data);
		}
		public SysId UserAccountIdAuthor
		{
			get { return data.UserAccountIdAuthor; }
			protected set { data.UserAccountIdAuthor = value; }
		}
		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 RegionIdPrimary
		{
			get { return data.RegionIdPrimary; }
			set { data.RegionIdPrimary = value; }
		}
		public String Headline
		{
			get { return data.Headline; }
			set { data.Headline = value; }
		}
		public String Summary
		{
			get { return data.Summary; }
			set { data.Summary = value; }
		}
		public SysId ItemImageIdThumbnail
		{
			get { return data.ItemImageIdThumbnail; }
			set { data.ItemImageIdThumbnail = value; }
		}
		public String BodyData
		{
			get { return data.BodyData; }
			set { data.BodyData = value; }
		}
		public DateTime? PublishedAt
		{
			get { return data.PublishedAt; }
			set { data.PublishedAt = 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> UserAccountIdsAuthorIncluded { get; } = new List<SysId>();
			/// <summary>Restrict to articles belonging to organisation.</summary>
			public List<SysId> OrganisationIdsIncluded { get; } = new List<SysId>();
			/// <summary>Exclude articles belonging to organisations. Ignored if any organisations specified.</summary>
			public bool ExcludeOrganisationArticles { get; set; }
			public List<SysId> SportIdsIncluded { get; set; } = new List<SysId>();
			public List<SysId> RegionIdsIncluded { get; } = new List<SysId>();
			public String HeadlinePartial { get; set; }
			public String SummaryPartial { get; set; }
			/// <summary>General filter value - headline, summary, sport, body etc. </summary>
			public String ArticleFilter { get; set; }
			// Common properties.
			public String NotesPartial { get; set; }
			public StatusCat StatusCat { get; set; } = StatusCat.ActiveOnly;
		}

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

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