BusinessMgr-2019/SaBusMgrStandardBase/Base/Mgr/SbmDataItemMgr_ItemLink.cs

using Sarand.BusinessMgr.Net.Standard.Base.App;
using Sarand.BusinessMgr.Net.Standard.Base.Bus;
using Sarand.Net.Standard.Base.App;
using Sarand.Net.Standard.Base.Bus;
using Sarand.Net.Standard.Base.Core;
using Sarand.Net.Standard.Base.Dbas;
using Sarand.Net.Standard.Base.Utils;
using System;
using System.Collections.Generic;

namespace Sarand.BusinessMgr.Net.Standard.Base.Mgr
{
	//=======================================================================
	partial class SbmDataItemMgr
	{
		//*******************************************************************
		//                        I t e m   L i n k s
		//*******************************************************************

		//-------------------------------------------------------------------
		// Utilities.
		public static Sbm.ItemLinkType GetLinkType(Sbm.ApplCodeType applCodeType)
		{
			switch (applCodeType)
			{
				case Sbm.ApplCodeType.SeasonalCategory: return Sbm.ItemLinkType.ItemCodeList_SeasonalCategory;
				case Sbm.ApplCodeType.PostcodeArea: return Sbm.ItemLinkType.ItemCodeList_PostcodeArea;
				case Sbm.ApplCodeType.JobTrade: return Sbm.ItemLinkType.ItemCodeList_JobTrade;
				case Sbm.ApplCodeType.JobEngineer: return Sbm.ItemLinkType.ItemCodeList_JobEngineer;
			}
			return Sbm.ItemLinkType.Unknown;
		}

		// Clean up data issues/inconsistencies.
		public abstract bool DoDbCleanup();
		// Clear all associated data for item - attributes and links.
		public abstract bool ClearDataItem(Sbm.ItemType itemType, SysId itemId);

		//-------------------------------------------------------------------
		//				Retrieve individual itemLinks.
		//-------------------------------------------------------------------
		// ItemLink exists.
		public bool ItemLinkExistsById(SysId itemLinkId)
		{
			ClearErrorState();
			if (!SysId.IsValid(itemLinkId)) return false;
			SbmItemLink.Params prmItemLink = new SbmItemLink.Params();
			prmItemLink.IncludedIds.Add(itemLinkId);
			prmItemLink.StatusCat = SbmItemLink.StatusCat.Any;
			return GetItemLinkCount(prmItemLink) == 1;
		}

		//-------------------------------------------------------------------
		// Get itemLinks.
		public abstract SbmItemLink GetItemLink(SbmItemLink.Params prm);

		public SbmItemLink GetItemLinkById(SysId itemLinkId)
		{
			ClearErrorState();
			if (!SysId.IsValid(itemLinkId)) return null;
			SbmItemLink.Params prmItemLink = new SbmItemLink.Params();
			prmItemLink.IncludedIds.Add(itemLinkId);
			prmItemLink.StatusCat = SbmItemLink.StatusCat.Any;
			return GetItemLink(prmItemLink);
		}

		//-------------------------------------------------------------------
		// Create itemLinks.
		public abstract SbmItemLink CreateItemLink(Sbm.ItemLinkType itemLinkType, Sbm.ItemType itemTypeFrom, SysId itemIdFrom, Sbm.ItemType itemTypeTo, SysId itemIdTo);

		//-------------------------------------------------------------------
		// Has itemLinks.
		public abstract bool HasItemLinks(Sbm.ItemType itemType, SysId itemId);

		//-------------------------------------------------------------------
		// Validate Item Link data.
		public bool IsValidItemLink(SbmItemLink itemLink)
		{
			ClearErrorState();
			if (itemLink == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidItemLinkData(itemLink.GetData(), new SbmItemLink.ErrField());
		}
		public virtual bool IsValidItemLinkData(SbmItemLink.Data data, SbmItemLink.ErrField errField)
		{
			ClearErrorState();
			// ItemLink properties.
			if (errField.ItemLinkType != SacsHierarchyItem.ValidValue.Ignore)
			{
				if ((int)data.ItemLinkType < 1)
				{
					errField.ItemLinkType = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("ItemLink type must be supplied");
				}
			}
			if (errField.ItemTypeFrom != SacsHierarchyItem.ValidValue.Ignore)
			{
				if ((int)data.ItemTypeFrom < 1)
				{
					errField.ItemTypeFrom = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("ItemTypeFrom must be supplied");
				}
			}
			if (errField.ItemIdFrom != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.ItemIdFrom))
			{
				errField.ItemIdFrom = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.ItemTypeTo != SacsHierarchyItem.ValidValue.Ignore)
			{
				if ((int)data.ItemTypeTo < 1)
				{
					errField.ItemTypeFrom = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("ItemTypeTo must be supplied");
				}
			}
			if (errField.ItemIdTo != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.ItemIdTo))
			{
				errField.ItemIdTo = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Seq != SacsHierarchyItem.ValidValue.Ignore && data.Seq < 1)
			{
				errField.Seq = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Sequence must be supplied");
			}
			if (errField.Completed != SacsHierarchyItem.ValidValue.Ignore && DateUtil.IsValid(data.Completed))
			{
				errField.Completed = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.DataContent != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.DataContent, "data content", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.ItemLink_DataContent), true))
			{
				errField.DataContent = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			// Common properties.
			if (!IsValidValue(data.Notes, "notes", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.ItemLink_Notes)))
			{
				errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Status != SacsHierarchyItem.ValidValue.Ignore)
			{
				if (!IsValidValue(data.StatusCode, "status", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.ItemLink_Status), true, true))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return false;
				}
				if (!SbmItemLink.ItemLinkStatuses.Contains(data.Status))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState(ErrorMessage.InvalidStatus);
				}
			}
			// Validate associated data.
			return true;
		}

		//-------------------------------------------------------------------
		// ItemLink database interface.
		public abstract bool InsertItemLink(SbmItemLink itemLink, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateItemLink(SbmItemLink itemLink, DbUpdateInfo dbUpdateInfo);
		public abstract bool StoreFromItemLinks(Sbm.ItemLinkType itemLinkType, Sbm.ItemType itemTypeFrom, SysId itemIdFrom, List<SbmItemLink> itemLinks, DbUpdateInfo dbUpdateInfo);
		public abstract bool StoreToItemLinks(Sbm.ItemLinkType itemLinkType, Sbm.ItemType itemTypeTo, SysId itemIdTo, List<SbmItemLink> itemLinks, DbUpdateInfo dbUpdateInfo);

		public virtual bool ItemLinkCanBeDeleted(SbmItemLink itemLink)
		{
			ClearErrorState();
			if (itemLink == null) return SetErrorState("item not specified");
			return true;
		}
		public abstract bool DeleteItemLink(SbmItemLink itemLink, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// ItemLink list.
		public abstract ColumnDfn GetItemLinkColumnDfn(SbmItemLink.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetItemLinkQueryFilter(SbmItemLink.Params prm);
		public abstract long GetItemLinkCount(SbmItemLink.Params prm);
		public abstract List<SbmItemLink> GetItemLinkList(SbmItemLink.Params prm);
		public abstract DbResultSet ExecuteItemLinkQuery(List<ColumnDfn> columns, SbmItemLink.Params prm);

		//-------------------------------------------------------------------
		//                       D a t a   V a l u e s
		//-------------------------------------------------------------------
		/// <summary>
		/// Extract and format result set data value where specific handling is required.
		/// <para>Where response is an invalid data value, format value using column.FormatValue(values).</para>
		/// </summary>
		public DataValue GetItemLinkDataValue(ColumnDfn column, NamedValue.Map values)
		{
			DataValue value = new DataValue();
			switch ((SbmItemLink.Column)column.Id)
			{
				// Notes.
				case SbmItemLink.Column.Notes:
					value = new DataValue(SacsHierarchyItem.FormatForDisplay(values.GetValue(column.DataName).ToString(), 200));
					break;

				// Status.
				case SbmItemLink.Column.Status_Desc:
				case SbmItemLink.Column.Status_Ind:
					{
						String statusCode = values.GetValue(column.DataName).ToString();
						SaStatus status = SacsSystem.GetStatusForCode(statusCode);
						if (column.Id == (int)SbmItemLink.Column.Status_Desc)
							value = new DataValue(SacsSystem.GetStatusDescForCode(statusCode));
						else if (column.Id == (int)SbmItemLink.Column.Status_Ind)
							value = new DataValue(SbmItemLink.GetStatusTriState(status));
					}
					break;

					//-----------------------------------------------------------
			}
			return value;
		}
		//-------------------------------------------------------------------
	}
	//=======================================================================
}