Common-VS2019/SacsBusinessBase/Base/ReferenceData/SaReferenceDataMgr_TaxCode.cs

using System;
using System.Collections.Generic;
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 Sarand.Net.Standard.Base.Utils;

namespace Sarand.Net.Standard.Base.ReferenceData
{
	//=======================================================================
	// Reference Data manager - Tax Codes.
	//=======================================================================
	public abstract partial class SaReferenceDataMgr : SacsItemMgr
	{
		//-------------------------------------------------------------------
		// Utilities.
		public String GetTaxCode(SaTaxCodeType taxCode)
		{
			switch (taxCode)
			{
				case SaTaxCodeType.Zero: return "T0";
				case SaTaxCodeType.Std: return "T1";
				case SaTaxCodeType.Exempt: return "T3";
			}
			return "";
		}
		//-------------------------------------------------------------------
		// Retrieve individual taxCodes.
		public abstract bool TaxCodeExistsById(SysId id);
		public abstract bool TaxCodeExistsByCode(String code);
		public abstract SaTaxCode GetTaxCodeById(SysId id);
		public abstract SaTaxCode GetTaxCodeByCode(String code);
		public abstract SaTaxCode GetTaxCode(SaTaxCode.Params prm);

		// Create taxCode.
		public abstract SaTaxCode CreateTaxCode();

		//-------------------------------------------------------------------
		// Validate taxCode data.
		public bool IsValidTaxCode(SaTaxCode taxCode)
		{
			ClearErrorState();
			if (taxCode == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
			return IsValidTaxCodeData(taxCode.GetData(), new SaTaxCode.ErrField());
		}
		public virtual bool IsValidTaxCodeData(SaTaxCode.Data data, SaTaxCode.ErrField errField)
		{
			ClearErrorState();
			// TaxCode properties.
			if (errField.Code != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Code, "code", (long)SaReferenceDataDbDfn.GetColTextLen(SaReferenceDataDbDfn.ColumnIdx.TaxCode_Code), true))
			{
				errField.Code = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.CodeAlt1 != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.CodeAlt1, "codeAlt1", (long)SaReferenceDataDbDfn.GetColTextLen(SaReferenceDataDbDfn.ColumnIdx.TaxCode_CodeAlt1)))
			{
				errField.CodeAlt1 = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.CodeAlt2 != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.CodeAlt2, "codeAlt2", (long)SaReferenceDataDbDfn.GetColTextLen(SaReferenceDataDbDfn.ColumnIdx.TaxCode_CodeAlt2)))
			{
				errField.CodeAlt2 = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Description != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Description, "description", (long)SaReferenceDataDbDfn.GetColTextLen(SaReferenceDataDbDfn.ColumnIdx.TaxCode_Description), true))
			{
				errField.Description = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.EffectFrom != SacsHierarchyItem.ValidValue.Ignore && errField.EffectTo != SacsHierarchyItem.ValidValue.Ignore && DateUtil.IsValid(data.EffectFrom) && DateUtil.IsValid(data.EffectTo))
			{
				if (data.EffectFrom.CompareTo(data.EffectTo) > 0)
				{
					errField.EffectFrom = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("Invalid effective date range");
				}
			}
			if (errField.TaxRate != SacsHierarchyItem.ValidValue.Ignore && (short)data.TaxRate < 1)
			{
				errField.TaxRate = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("Tax Rate must be supplied");
			}
			if (errField.TaxRatePrev != SacsHierarchyItem.ValidValue.Ignore && (short)data.TaxRatePrev < 1)
			{
				errField.TaxRatePrev = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState("previous tax rate must be supplied");
			}
			// Common properties.
			if (errField.Notes != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Notes, "notes", (long)SaReferenceDataDbDfn.GetColTextLen(SaReferenceDataDbDfn.ColumnIdx.TaxCode_Notes)))
			{
				errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
				return false;
			}
			if (errField.Status != SacsHierarchyItem.ValidValue.Ignore && !SaTaxCode.ValidStatuses.Contains(data.Status))
			{
				errField.Status = SacsHierarchyItem.ValidValue.Invalid;
				return SetErrorState(ErrorMessage.InvalidStatus);
			}
			// Validate associated data.
			if (errField.RegionId != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.RegionId))
			{
				if (!RegionExistsById(data.RegionId))
				{
					errField.RegionId = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("Tax code's region not found");
				}
			}
			if (errField.TaxCodeIdLink != SacsHierarchyItem.ValidValue.Ignore && SysId.IsValid(data.TaxCodeIdLink))
			{
				if (!TaxCodeExistsById(data.TaxCodeIdLink))
				{
					errField.TaxCodeIdLink = SacsHierarchyItem.ValidValue.Invalid;
					return SetErrorState("Tax code's parent not found");
				}
			}
			return true;
		}

		//-------------------------------------------------------------------
		// TaxCode database interface.
		public abstract bool InsertTaxCode(SaTaxCode taxCode, DbUpdateInfo dbUpdateInfo);
		public abstract bool UpdateTaxCode(SaTaxCode taxCode, DbUpdateInfo dbUpdateInfo);
		public virtual bool TaxCodeCanBeDeleted(SaTaxCode taxCode)
		{
			ClearErrorState();
			if (taxCode.HasDependentTaxCodes()) return SetErrorState("Has dependent tax codes");
			return true;
		}
		public abstract bool DeleteTaxCode(SaTaxCode taxCode, DbUpdateInfo dbUpdateInfo);

		//-------------------------------------------------------------------
		// TaxCode list.
		public abstract ColumnDfn GetTaxCodeColumnDfn(SaTaxCode.Column columnId, String caption = "", int width = 0);
		public abstract List<String> GetTaxCodeQueryFilter(SaTaxCode.Params prm);
		public abstract long GetTaxCodeCount(SaTaxCode.Params prm);
		public abstract List<SaTaxCode> GetTaxCodeList(SaTaxCode.Params prm);
		public abstract DbResultSet ExecuteTaxCodeQuery(List<ColumnDfn> columns, SaTaxCode.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 virtual DataValue GetTaxCodeDataValue(ColumnDfn column, NamedValue.Map values)
		{
			DataValue value = new DataValue();
			switch ((SaTaxCode.Column)column.Id)
			{

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

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

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

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