BusinessMgr-2019/SaBusMgrStandardBase/Base/Mgr/SbmProcessMgr_Process.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 System;
using System.Collections.Generic;

namespace Sarand.BusinessMgr.Net.Standard.Base.Mgr
{
	//=======================================================================
	partial class SbmProcessMgr
	{
		//*******************************************************************
		//                         P r o c e s s e s
		//*******************************************************************
		//-------------------------------------------------------------------
		// Utilities.
		/// <summary>Are processes defined for the specified category?</summary>
		public abstract bool HasProcesses(Sbm.ProcessCategory processCategory);

		//-------------------------------------------------------------------
		//					Retrieve individual processes.
		//-------------------------------------------------------------------

		//-------------------------------------------------------------------
		// Process exists.
		public bool ProcessExistsById(SysId processId)
		{
			ClearErrorState();
			if (!SysId.IsValid(processId)) return false;
			SbmProcess.Params prmProcess = new SbmProcess.Params();
			prmProcess.IncludedIds.Add(processId);
			prmProcess.StatusCat = SbmProcess.StatusCat.Any;
			return GetProcessCount(prmProcess) == 1;
		}

		//-------------------------------------------------------------------
		// Get Process.
		public abstract SbmProcess GetProcess(SbmProcess.Params prm);

		public SbmProcess GetProcessById(SysId processId)
		{
			ClearErrorState();
			if (!SysId.IsValid(processId)) return null;
			SbmProcess.Params prmProcess = new SbmProcess.Params();
			prmProcess.IncludedIds.Add(processId);
			prmProcess.StatusCat = SbmProcess.StatusCat.Any;
			return GetProcess(prmProcess);
		}
		public SbmProcess GetProcessBySeq(short seq)
		{
			ClearErrorState();
			if (seq < 1) return null;
			SbmProcess.Params prmProcess = new SbmProcess.Params();
			prmProcess.Seq = seq;
			prmProcess.StatusCat = SbmProcess.StatusCat.Any;
			return GetProcess(prmProcess);
		}

		public abstract short GetProcessSeqMax();

		// Create process.
		public abstract SbmProcess CreateProcess(Sbm.ProcessCategory processCategory);

		//-------------------------------------------------------------------
		// Validate process data.
		public bool IsValidProcess(SbmProcess process)
		{
			ClearErrorState();
			if (process == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidProcessData(process.GetData(), new SbmProcess.ErrField());
		}
		public virtual bool IsValidProcessData(SbmProcess.Data data, SbmProcess.ErrField errField)
		{
			// Process properties.
			ClearErrorState();
			//Validate the identity.
			if (!SysId.IsValid(data.AffiliateIdOwner)) return SetErrorState("invalid affiliate owner");
			if ((int)data.ProcessCategory < 1) return SetErrorState("invalid category");
			if ((int)data.ProcessType < 1) return SetErrorState("invalid type");
			// Validate the text attributes.
			if (errField.DescBrief != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.DescBrief, "description brief", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.Process_DescBrief), true))
			{
				errField.DescBrief = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.DescOutline != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.DescOutline, "description outline", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.Process_DescOutline), true))
			{
				errField.DescOutline = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}

			// Common properties.
			if (!IsValidValue(data.Notes, "notes", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.Process_Notes)))
			{
				errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Status != SacsHierarchyItem.ValidValue.Ignore)
			{
				if (!IsValidValue(data.StatusCode, "status", (long)SbmDbDfn.GetColTextLen(SbmDbDfn.ColumnIdx.Process_Status), true, true))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return false;
				}
				if (!SbmProcess.ProcessStatuses.Contains(data.Status))
				{
					errField.Status = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState(ErrorMessage.InvalidStatus);
				}
			}
			return true;
		}

		//-------------------------------------------------------------------
		// Process database interface.
		public abstract bool InsertProcess(SbmProcess process, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateProcess(SbmProcess process, DbUpdateInfo dbUpdateInfo);
		public virtual bool ProcessCanBeDeleted(SbmProcess process)
		{
			ClearErrorState();
			return true;
		}
		public abstract bool DeleteProcess(SbmProcess process, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// Process list.
		public abstract ColumnDfn GetProcessColumnDfn(SbmProcess.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetProcessQueryFilter(SbmProcess.Params prm);
		public abstract long GetProcessCount(SbmProcess.Params prm);
		public abstract List<SbmProcess> GetProcessList(SbmProcess.Params prm);
		public abstract DbResultSet ExecuteProcessQuery(List<ColumnDfn> columns, SbmProcess.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 GetProcessDataValue(ColumnDfn column, NamedValue.Map values)
		{
			DataValue value = new DataValue();
			switch ((SbmProcess.Column)column.Id)
			{
				//--------------------------------------------------------------- -
				// Process TypeDesc.
				case SbmProcess.Column.Type_Desc:
					{
						Sbm.ProcessType processType = (Sbm.ProcessType)values.GetValue(column.DataName).AsLong();
						value = new DataValue(ProcessTypes.GetDescForType(processType, ((int)processType).ToString()));
						break;
					}
				// Process CategoryDesc.
				case SbmProcess.Column.Category_Desc:
					{
						Sbm.ProcessCategory processCategory = (Sbm.ProcessCategory)values.GetValue(column.DataName).AsLong();
						value = new DataValue(processCategories.GetDescForType(processCategory, ((int)processCategory).ToString()));
						break;
					}

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

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

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