Saxonite/SaxoniteStandardBase/Base/Mgr/SaxActivityMgr-UserActivity.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.Bus;
using System;
using System.Collections.Generic;
using System.Text;

namespace Saxonite.Net.Standard.Base.Mgr
{
	//=======================================================================
	partial class SaxActivityMgr
	{
		//*******************************************************************
		// Activity Mgr - User Activity
		//*******************************************************************
		// Utilities.

		//-------------------------------------------------------------------
		// Create item.
		public abstract SaxUserActivity CreateUserActivity(SysId userAccountId, ItemId itemId);

		//-------------------------------------------------------------------
		// Retrieve individual items.
		public abstract SaxUserActivity GetUserActivity(SaxUserActivity.Params prmUserActivity);
		public SaxUserActivity GetUserActivityForUserItem(SysId userAccountId, ItemId itemId)
		{
			if (!SysId.IsValid(userAccountId) || !ItemId.IsValid(itemId)) return null;
			SaxUserActivity.Params prmUserActivity = new SaxUserActivity.Params();
			prmUserActivity.UserAccountIdsIncluded.Add(userAccountId);
			prmUserActivity.ItemIdsIncluded.Add(itemId);
			prmUserActivity.StatusCat = SaxUserActivity.StatusCat.Any;
			return ActivityMgr.GetUserActivity(prmUserActivity);
		}

		//-------------------------------------------------------------------
		// Validate item data.
		public bool IsValidUserActivity(SaxUserActivity userActivity)
		{
			ClearErrorState();
			if (userActivity == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidUserActivityData(userActivity.GetData(), new SaxUserActivity.ErrField());
		}
		public virtual bool IsValidUserActivityData(SaxUserActivity.Data data, SaxUserActivity.ErrField errField)
		{
			ClearErrorState();

			//---------------------------------------------------------------
			// User Account.
			if (errField.UserAccountId != SacsHierarchyItem.ValidValue.Ignore && !SysId.IsValid(data.UserAccountId))
			{
				errField.UserAccountId = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("User Account Id must be specified");
			}
			// Item Id.
			if (errField.ItemId != SacsHierarchyItem.ValidValue.Ignore && !ItemId.IsValid(data.ItemId))
			{
				errField.ItemId = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Item Id must be specified");
			}

			//---------------------------------------------------------------
			// Common properties.
			if (errField.Notes != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Notes, "notes", (long)SaxDbDfn_Core.GetColTextLen(SaxDbDfn_Core.ColumnIdx.UserActivity_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.UserActivity_Status), true, true))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return false;
				}
				if (!SaxUserActivity.ValidStatuses.Contains(data.Status))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState(ErrorMessage.InvalidStatus);
				}
			}

			//---------------------------------------------------------------
			// Associated data - ignore for existing or deleted items.
			if (!SysId.IsValid(data.Id) && !data.IsStatusDeleted)
			{
				// User must exist.
				if (errField.UserAccountId != SacsHierarchyItem.ValidValue.Ignore)
				{
					if (SysId.IsValid(data.UserAccountId))
					{
						SaxUserAccount.Params prmUserAccount = new SaxUserAccount.Params();
						prmUserAccount.IdsIncluded.Add(data.UserAccountId);
						prmUserAccount.StatusCat = SaxUserAccount.StatusCat.NotDeleted;
						if (AccountMgr.GetUserAccountCount(prmUserAccount) < 1)
						{
							errField.UserAccountId = SacsHierarchyItem.ValidValue.Invalid;
							return SetErrorState("invalid user specified");
						}
					}
				}
			}

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

		//-------------------------------------------------------------------
		// UserActivity database interface.
		public abstract bool InsertUserActivity(SaxUserActivity userActivity, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateUserActivity(SaxUserActivity userActivity, DbUpdateInfo dbUpdateInfo);
		public virtual bool UserActivityCanBeDeleted(SaxUserActivity userActivity)
		{
			ClearErrorState();
			return true;
		}
		public abstract bool DeleteUserActivity(SaxUserActivity userActivity, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// UserActivity list:
		public abstract ColumnDfn GetUserActivityColumnDfn(SaxUserActivity.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetUserActivityQueryFilter(SaxUserActivity.Params prmUserActivity);
		public abstract long GetUserActivityCount(SaxUserActivity.Params prmUserActivity);
		public abstract List<SaxUserActivity> GetUserActivityList(SaxUserActivity.Params prmUserActivity);
		public abstract DbResultSet ExecuteUserActivityQuery(List<ColumnDfn> columns, SaxUserActivity.Params prmUserActivity);

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

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

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

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

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