Saxonite/SaxoniteStandardBase/Base/Mgr/SaxActivityMgr-ActivityIndex.cs

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 Saxonite.Base.App;
using Saxonite.Net.Standard.Base.App;
using Saxonite.Net.Standard.Base.Bus;
using System;
using System.Collections.Generic;
using System.Text;

namespace Saxonite.Net.Standard.Base.Mgr
{
	//=======================================================================
	partial class SaxActivityMgr
	{
		//*******************************************************************
		// Activity Mgr - Activity Index
		//*******************************************************************
		// Utilities.
		public Boolean IsValidItemForIndex(ItemId itemId)
		{
			if (!ItemId.IsValid(itemId))
				return false;
			if (!SaxActivityFeedback.ValidItemTypes.Contains((Sax.DataItemType)itemId.Type))
				return false;
			return true;
		}

		//-------------------------------------------------------------------
		public List<SaxActivityIndex> GetActivityIndexListForItem(ItemId itemId)
		{
			ClearErrorState();
			List<SaxActivityIndex> activityIndexEntries = new List<SaxActivityIndex>();
			if (!IsValidItemForIndex(itemId)) return activityIndexEntries;
			SaxActivityIndex.Params prmActivityIndex = new SaxActivityIndex.Params();
			prmActivityIndex.ItemIdsIncluded.Add(itemId);
			return GetActivityIndexList(prmActivityIndex);
		}

		//-------------------------------------------------------------------
		// Create item.
		public abstract SaxActivityIndex CreateActivityIndex(ItemId itemId, SysId sportId, SysId regionId);

		//-------------------------------------------------------------------
		// Retrieve individual items.
		public abstract SaxActivityIndex GetActivityIndex(SaxActivityIndex.Params prmActivityIndex);

		//-------------------------------------------------------------------
		// Validate item data.
		public bool IsValidActivityIndex(SaxActivityIndex activityIndex)
		{
			ClearErrorState();
			if (activityIndex == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidActivityIndexData(activityIndex.GetData(), new SaxActivityIndex.ErrField());
		}
		public virtual bool IsValidActivityIndexData(SaxActivityIndex.Data data, SaxActivityIndex.ErrField errField)
		{
			ClearErrorState();

			//---------------------------------------------------------------
			// Item Id.
			if (errField.ItemId != SacsHierarchyItem.ValidValue.Ignore)
			{
				if (!ItemId.IsValid(data.ItemId))
				{
					errField.ItemId = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("item id must be specified");
				}
				if (!IsValidItemForIndex(data.ItemId))
				{
					errField.ItemId = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("invalid item type specified");
				}
			}
			// Sport.
			if (errField.SportId != SacsHierarchyItem.ValidValue.Ignore && !SysId.IsValid(data.SportId))
			{
				errField.SportId = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Sport must be specified");
			}
			// Region.
			if (errField.RegionId != SacsHierarchyItem.ValidValue.Ignore && !SysId.IsValid(data.RegionId))
			{
				errField.RegionId = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Region must be specified");
			}
			// Effective date.
			if (errField.EffectiveOn != SacsHierarchyItem.ValidValue.Ignore && !DateUtil.IsValid(data.EffectiveOn))
			{
				errField.EffectiveOn = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Effective date must be specified");
			}

			//---------------------------------------------------------------
			// Common properties.
			if (errField.Notes != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Notes, "notes", (long)SaxDbDfn_Core.GetColTextLen(SaxDbDfn_Core.ColumnIdx.ActivityIndex_Notes)))
			{
				errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Status != SacsHierarchyItem.ValidValue.Ignore)
			{
				if (!IsValidValue(data.StatusCode, "status", (long)SaxDbDfn_Core.GetColTextLen(SaxDbDfn_Core.ColumnIdx.ActivityIndex_Status), true, true))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return false;
				}
				if (!SaxActivityIndex.ValidStatuses.Contains(data.Status))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState(ErrorMessage.InvalidStatus);
				}
			}

			// NB Associated data items shouldn't need to be validated as these should be valid on the 'parent' object.
			if (errField.OrganisationIdOwner != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.OrganisationIdOwner))
			{
			}

			if (errField.OrganisationIdOwner != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.OrganisationIdOwner))
			{
			}

			//---------------------------------------------------------------
			return true;
		}

		//-------------------------------------------------------------------
		// ActivityIndex database interface.
		public abstract bool InsertActivityIndex(SaxActivityIndex activityIndex, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateActivityIndex(SaxActivityIndex activityIndex, DbUpdateInfo dbUpdateInfo);
		public virtual bool ActivityIndexCanBeDeleted(SaxActivityIndex activityIndex)
		{
			ClearErrorState();
			return true;
		}
		public abstract bool DeleteActivityIndex(SaxActivityIndex activityIndex, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// ActivityIndex list:
		public abstract ColumnDfn GetActivityIndexColumnDfn(SaxActivityIndex.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetActivityIndexQueryFilter(SaxActivityIndex.Params prmActivityIndex);
		public abstract long GetActivityIndexCount(SaxActivityIndex.Params prmActivityIndex);
		public abstract List<SaxActivityIndex> GetActivityIndexList(SaxActivityIndex.Params prmActivityIndex);
		public abstract DbResultSet ExecuteActivityIndexQuery(List<ColumnDfn> columns, SaxActivityIndex.Params prmActivityIndex);

		//-------------------------------------------------------------------
		/// <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 virtual DataValue GetActivityIndexDataValue(ColumnDfn column, NamedValue.Map values)
		{
			DataValue value = new DataValue();
			switch ((SaxActivityIndex.Column)column.Id)
			{
				//-----------------------------------------------------------
				// Data item type.
				case SaxActivityIndex.Column.ItemType_Code:
					{
						value = new DataValue(DataItemTypeCodes.GetCodeForType(values.GetLong(column.DataName)));
					}
					break;
				case SaxActivityIndex.Column.ItemType_Desc:
					{
						value = new DataValue(DataItemTypeCodes.GetDescForType(values.GetLong(column.DataName)));
					}
					break;

				//-----------------------------------------------------------
				// Notes - limit to 200 chars.
				case SaxActivityIndex.Column.Notes:
					{
						value = new DataValue(SacsHierarchyItem.FormatForDisplay(values.GetValue(column.DataName).ToString(), 200));
					}
					break;

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

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

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