Common-VS2019/SacsStandardBase/Base/Security/SaSecurityMgr-SecurityItem.cs

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

namespace Sarand.Net.Standard.Base.Security
{
	//=======================================================================
	partial class SaSecurityMgr
	{
		//*******************************************************************
		//                    S e c u r i t y   I t e m s
		//*******************************************************************
		// Associated data.
		public bool SecurityItemHasLinks(SysId securityItemId)
		{
			return (SecurityItemIsSourceOfLinks(securityItemId) || SecurityItemIsTargetOfLinks(securityItemId));
		}
		public abstract bool SecurityItemIsSourceOfLinks(SysId securityItemId);
		public abstract bool SecurityItemIsTargetOfLinks(SysId securityItemId);
		public abstract bool SecurityItemHasLinksWith(SysId securityItemIdOwner, SysId securityItemIdTarget);

		//-------------------------------------------------------------------
		// Retrieve individual security items.
		public abstract bool SecurityItemExistsById(SysId id);
		public abstract bool SecurityItemExistsByTypeCode(SaSecurity.ItemType securityItemType, String code);
		public abstract SaSecurityItem GetSecurityItemById(SysId id);
		public abstract SaSecurityItem GetSecurityItemByTypeId(SaSecurity.ItemType securityItemType, SysId id);
		public abstract SaSecurityItem GetSecurityItemByTypeEmail(SaSecurity.ItemType securityItemType, String emailAddress);
		public abstract SaSecurityItem GetSecurityItemByTypeCode(SaSecurity.ItemType securityItemType, String code);
		public abstract SaSecurityItem GetSecurityItem(SaSecurityItem.Params prmSecItem);

		// Create Security Item.
		public abstract SaSecurityItem CreateSecurityItem(SaSecurity.ItemType securityItemType);

		//-------------------------------------------------------------------
		// Validate Security Item.
		public bool IsValidSecurityItem(SaSecurityItem securityItem)
		{
			ClearErrorState();
			if (securityItem == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidSecurityItemData(securityItem.GetData(), new SaSecurityItem.ErrField());
		}
		public virtual bool IsValidSecurityItemData(SaSecurityItem.Data data, SaSecurityItem.ErrField errField)
		{
			ClearErrorState();
			if (errField.ItemType != SacsHierarchyItem.ValidValue.Ignore && (int)data.ItemType < 1)
			{
				SetErrorState("security item type must be supplied");
				errField.ItemType = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Code != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Code, "code", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_Code), true))
			{
				errField.Code = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.EmailAddress != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.EmailAddress, "email address", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_EmailAddress)))
			{
				errField.EmailAddress = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Description != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Description, "description", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_Description), true))
			{
				errField.Description = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Location != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Location, "location", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_Location)))
			{
				errField.Location = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Password != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.PasswordEncrypted, "password", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_EncPword)))
			{
				errField.Password = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			// Common properties.
			if (errField.Notes != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Notes, "notes", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_Notes)))
			{
				errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Status != SacsHierarchyItem.ValidValue.Ignore)
			{
				if (!IsValidValue(data.StatusCode, "status", (long)SaSecurityDbDfn.GetColTextLen(SaSecurityDbDfn.ColumnIdx.SaSecItem_Status), true, true))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return false;
				}
				if (!SaSecurityItem.ValidStatuses.Contains(data.Status))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState(ErrorMessage.InvalidStatus);
				}
			}
			return true;
		}

		//-------------------------------------------------------------------
		// SecurityItem database interface.
		public abstract bool InsertSecurityItem(SaSecurityItem securityItem, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateSecurityItem(SaSecurityItem securityItem, DbUpdateInfo dbUpdateInfo);
		public virtual bool SecurityItemCanBeDeleted(SaSecurityItem securityItem)
		{
			ClearErrorState();
			if (SecurityItemHasLinks(securityItem.Id)) return SetErrorState("security item has links");
			return true;
		}
		public abstract bool DeleteSecurityItem(SaSecurityItem securityItem, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// Item list.
		public abstract ColumnDfn GetSecurityItemColumnDfn(SaSecurityItem.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetSecurityItemQueryFilter(SaSecurityItem.Params prm);
		public abstract long GetSecurityItemCount(SaSecurityItem.Params prm);
		public abstract List<SaSecurityItem> GetSecurityItemList(SaSecurityItem.Params prm);
		public abstract DbResultSet ExecuteSecurityItemQuery(List<ColumnDfn> columns, SaSecurityItem.Params prm);

		//-------------------------------------------------------------------
		/// <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 GetSecurityItemDataValue(ColumnDfn column, NamedValue.Map values)
		{
			DataValue value = new DataValue();
			switch ((SaSecurityItem.Column)column.Id)
			{
				//-----------------------------------------------------------
				// Item type.
				case SaSecurityItem.Column.ItemType_Desc:
					SaSecurity.ItemType securityItemType = (SaSecurity.ItemType)values.GetValue(column.DataName).AsLong();
					value = new DataValue(securityItemTypes.GetCodeForType(securityItemType, securityItemType.ToString()));
					break;

				//-----------------------------------------------------------
				// Notes.
				case SaSecurityItem.Column.Notes:
					value = new DataValue(SacsHierarchyItem.FormatForDisplay(values.GetValue(column.DataName).ToString(), 200));
					break;

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

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

		//-------------------------------------------------------------------
	}
	//=======================================================================
}