319 lines
15 KiB
C#
319 lines
15 KiB
C#
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 Sarand.Net.Standard.Base.Interfaces;
|
|
using Sarand.Net.Standard.Base.ItemOptions;
|
|
using Sarand.Net.Standard.Base.Utils;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
|
|
namespace Sarand.BusinessMgr.Net.Standard.Base.Mgr
|
|
{
|
|
//=======================================================================
|
|
// Commodity Manager - Portfolio Item.
|
|
//=======================================================================
|
|
partial class SbmCommodityMgr
|
|
{
|
|
//-------------------------------------------------------------------
|
|
// Utilities.
|
|
|
|
//-------------------------------------------------------------------
|
|
// Associated data.
|
|
public abstract bool PortfolioItemHasChildItems(SysId portfolioItemId);
|
|
public abstract long GetChildPortfolioItemCount(SysId portfolioItemIdParent, Sbm.PortfolioItemType portfolioItemType = Sbm.PortfolioItemType.Unknown);
|
|
public abstract bool IsPortfolioItemReferencedByOtherItems(SysId portfolioItemId);
|
|
// Clear all descendent items.
|
|
public abstract bool ClearPortfolioItemChildItems(SysId portfolioItemId, DbUpdateInfo dbUpdateInfo);
|
|
// Dependent data should only be cleared when removing a portfolio item.
|
|
// Data owned by this item is deleted (eg. interface data items & document references).
|
|
// NB This method does not clear child portfolio items.
|
|
public abstract bool ClearPortfolioItemDependentData(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
|
|
//-------------------------------------------------------------------
|
|
// Portfolio item properties.
|
|
public abstract List<Sbm.PortfolioItemType> GetPortfolioItemTypesInUse();
|
|
public abstract ushort GetMinSeqForParent(SysId parentItemId, Sbm.PortfolioItemType portfolioItemType);
|
|
public abstract ushort GetMaxSeqForParent(SysId parentItemId, Sbm.PortfolioItemType portfolioItemType);
|
|
public abstract List<SysId> GetCategoryItemIds(SysId parentItemId);
|
|
public abstract List<SysId> GetCommodityItemIds(SysId parentItemId, ref List<SysId> commodityIds, bool includeSubCategories = false);
|
|
public abstract bool ResequenceChildren(SysId parentItemId);
|
|
public bool ItemIsPublishedToWebStore(SbmPortfolioItem portfolioItem)
|
|
{
|
|
if (portfolioItem == null || !SysId.IsValid(portfolioItem.Id)) return false;
|
|
bool publishedToWebStore = false;
|
|
String optionName_Portfolio = InterfaceOptionCodes.GetCodeForType(Sbm.InterfaceOption.Portfolio);
|
|
|
|
// Build list of portfolios that are published to website(s):
|
|
List<SysId> portfolioIdsPublished = new List<SysId>();
|
|
List<SaInterfaceConsole.SaInterfaceDfn> interfaceDfns = InterfaceConsole.GetInterfaceDfns(UserContext.OrganisationInterfaceContext, SaInterfaceCategory.Website, (short)Sbm.InterfaceType_Website.WebStore, false);
|
|
foreach (SaInterfaceConsole.SaInterfaceDfn interfaceDfn in interfaceDfns)
|
|
{
|
|
// Retrieve Portfolio Item Id option.
|
|
foreach (SaItemOption itemOption in ItemOptionConsole.GetItemOptionsForItem(new SbmItemId(Sbm.ItemType.PortfolioItem, portfolioItem.Id)))
|
|
{
|
|
if (itemOption.Name.EqualsCI(optionName_Portfolio))
|
|
{
|
|
SysId portfolioItemId = new SysId(StringUtil.ToInt(itemOption.Value));
|
|
if (SysId.IsValid(portfolioItemId) && !portfolioIdsPublished.Contains(portfolioItemId))
|
|
portfolioIdsPublished.Add(portfolioItemId);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Is this item identified against the interface:
|
|
publishedToWebStore = portfolioIdsPublished.Contains(portfolioItem.Id);
|
|
|
|
// Otherwise, check the item's parents back up the hierarchy:
|
|
SysId itemIdParent = portfolioItem.ItemIdParent;
|
|
while (!publishedToWebStore && SysId.IsValid(itemIdParent))
|
|
{
|
|
if (portfolioIdsPublished.Contains(itemIdParent))
|
|
{
|
|
publishedToWebStore = true;
|
|
}
|
|
else
|
|
{
|
|
// Retrieve the parent and make a note of its parent.
|
|
SbmPortfolioItem parentPortfolioItem = GetPortfolioItemById(itemIdParent);
|
|
if (parentPortfolioItem != null)
|
|
itemIdParent = parentPortfolioItem.ItemIdParent;
|
|
else
|
|
itemIdParent = new SysId();
|
|
}
|
|
}
|
|
return publishedToWebStore;
|
|
}
|
|
|
|
//-------------------------------------------------------------------
|
|
// Create Item.
|
|
public abstract SbmPortfolioItem CreatePortfolioItem(Sbm.PortfolioItemType portfolioItemType);
|
|
|
|
//-------------------------------------------------------------------
|
|
// Retrieve individual portfolioItems.
|
|
//-------------------------------------------------------------------
|
|
/// <summary>Locate item by Id</summary>
|
|
public bool PortfolioItemExistsById(SysId portfolioItemId)
|
|
{
|
|
ClearErrorState();
|
|
if (!SysId.IsValid(portfolioItemId)) return false;
|
|
SbmPortfolioItem.Params prmPortfolioItem = new SbmPortfolioItem.Params();
|
|
prmPortfolioItem.IdsIncluded.Add(portfolioItemId);
|
|
prmPortfolioItem.StatusCat = SbmPortfolioItem.StatusCat.Any;
|
|
return GetPortfolioItemCount(prmPortfolioItem) == 1;
|
|
}
|
|
/// <summary>Locate Item by parent Id and full code.</summary>
|
|
public bool PortfolioItemExistsByParentCode(SysId parentItemId, String code)
|
|
{
|
|
ClearErrorState();
|
|
if (!SysId.IsValid(parentItemId) || StringUtil.IsEmpty(code)) return false;
|
|
SbmPortfolioItem.Params prmPortfolioItem = new SbmPortfolioItem.Params();
|
|
prmPortfolioItem.ParentItemId = parentItemId;
|
|
prmPortfolioItem.CodeFull = code;
|
|
prmPortfolioItem.StatusCat = SbmPortfolioItem.StatusCat.Any;
|
|
return GetPortfolioItemCount(prmPortfolioItem) == 1;
|
|
}
|
|
|
|
//-------------------------------------------------------------------
|
|
// Get Item.
|
|
public abstract SbmPortfolioItem GetPortfolioItem(SbmPortfolioItem.Params prm);
|
|
/// <summary>Retrieve item by Id</summary>
|
|
public SbmPortfolioItem GetPortfolioItemById(SysId portfolioItemId)
|
|
{
|
|
ClearErrorState();
|
|
if (!SysId.IsValid(portfolioItemId)) return null;
|
|
SbmPortfolioItem.Params prmPortfolioItem = new SbmPortfolioItem.Params();
|
|
prmPortfolioItem.IdsIncluded.Add(portfolioItemId);
|
|
prmPortfolioItem.StatusCat = SbmPortfolioItem.StatusCat.Any;
|
|
return GetPortfolioItem(prmPortfolioItem);
|
|
}
|
|
/// <summary>Retrieve Item by parent Id and full code.</summary>
|
|
public SbmPortfolioItem GetPortfolioItemByParentCode(SysId parentItemId, String code)
|
|
{
|
|
ClearErrorState();
|
|
if (!SysId.IsValid(parentItemId) || StringUtil.IsEmpty(code)) return null;
|
|
SbmPortfolioItem.Params prmPortfolioItem = new SbmPortfolioItem.Params();
|
|
prmPortfolioItem.ParentItemId = parentItemId;
|
|
prmPortfolioItem.CodeFull = code;
|
|
prmPortfolioItem.StatusCat = SbmPortfolioItem.StatusCat.Any;
|
|
return GetPortfolioItem(prmPortfolioItem);
|
|
}
|
|
/// <summary>Retrieve Item by parent Id, item type and sequence.</summary>
|
|
public SbmPortfolioItem GetPortfolioItemByParentTypeSeq(SysId parentItemId, Sbm.PortfolioItemType portfolioItemType, ushort sequence)
|
|
{
|
|
ClearErrorState();
|
|
if (!SysId.IsValid(parentItemId) || (int)portfolioItemType < 1 || sequence < 0) return null;
|
|
SbmPortfolioItem.Params prmPortfolioItem = new SbmPortfolioItem.Params();
|
|
prmPortfolioItem.ParentItemId = parentItemId;
|
|
prmPortfolioItem.PortfolioItemType = portfolioItemType;
|
|
prmPortfolioItem.Sequence = sequence;
|
|
prmPortfolioItem.StatusCat = SbmPortfolioItem.StatusCat.Any;
|
|
return GetPortfolioItem(prmPortfolioItem);
|
|
}
|
|
|
|
//-------------------------------------------------------------------
|
|
// Validate PortfolioItem data.
|
|
public bool IsValidPortfolioItem(SbmPortfolioItem portfolioItem)
|
|
{
|
|
ClearErrorState();
|
|
if (portfolioItem == null) return SetErrorState(ErrorMessage.ItemNotSpecified);
|
|
return IsValidPortfolioItemData(portfolioItem.GetData(), new SbmPortfolioItem.ErrField());
|
|
}
|
|
public virtual bool IsValidPortfolioItemData(SbmPortfolioItem.Data data, SbmPortfolioItem.ErrField errField)
|
|
{
|
|
ClearErrorState();
|
|
// Validate the identity.
|
|
if (errField.AffiliateIdOwner != SacsHierarchyItem.ValidValue.Ignore && !SysId.IsValid(data.AffiliateIdOwner))
|
|
{
|
|
errField.AffiliateIdOwner = SacsHierarchyItem.ValidValue.Invalid;
|
|
return SetErrorState("invalid owner");
|
|
}
|
|
if (errField.Type != SacsHierarchyItem.ValidValue.Ignore && (int)data.Type < 1)
|
|
{
|
|
errField.Type = SacsHierarchyItem.ValidValue.Invalid;
|
|
return SetErrorState("invalid type");
|
|
}
|
|
|
|
// Validate the text attributes.
|
|
if (errField.Code != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Code, "code", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_Code), data.Type != Sbm.PortfolioItemType.Commodity))
|
|
{
|
|
errField.Code = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (errField.ShortCut != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.ShortCut, "short cut code", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_ShortCut)))
|
|
{
|
|
errField.ShortCut = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (errField.Caption != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Caption, "caption", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_Caption), data.Type != Sbm.PortfolioItemType.Commodity))
|
|
{
|
|
errField.Caption = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (errField.DescBrief != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.DescBrief, "brief desc", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_DescBrief)))
|
|
{
|
|
errField.DescBrief = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (errField.DescDetail != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.DescDetail, "detail desc", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_DescDetail)))
|
|
{
|
|
errField.DescDetail = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
// Commodity must be specified for commodity items.
|
|
if (errField.CommodityId != SacsHierarchyItem.ValidValue.Ignore && data.Type == Sbm.PortfolioItemType.Commodity && !SysId.IsValid(data.CommodityId))
|
|
{
|
|
errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
|
|
return SetErrorState("commodity must be specified");
|
|
}
|
|
// Another item can only be referenced for hierarchy items.
|
|
if (errField.ItemIdRef != SacsHierarchyItem.ValidValue.Ignore && data.Type == Sbm.PortfolioItemType.Category && SysId.IsValid(data.ItemIdRef))
|
|
{
|
|
errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
|
|
return SetErrorState("Only hierarchy items can reference other items");
|
|
}
|
|
// Common properties.
|
|
if (errField.Notes != SacsHierarchyItem.ValidValue.Ignore && !IsValidValue(data.Notes, "notes", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_Notes)))
|
|
{
|
|
errField.Notes = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (errField.Status != SacsHierarchyItem.ValidValue.Ignore)
|
|
{
|
|
if (!IsValidValue(data.StatusCode, "status", (long)Internals.GetColTextLen(SbmDbDfn.ColumnIdx.PortfolioItem_Status), true, true))
|
|
{
|
|
errField.Status = SacsHierarchyItem.ValidValue.Invalid;
|
|
return false;
|
|
}
|
|
if (!SbmPortfolioItem.ValidStatuses.Contains(data.Status))
|
|
{
|
|
errField.Status = SacsHierarchyItem.ValidValue.Invalid;
|
|
return SetErrorState(ErrorMessage.InvalidStatus);
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
//-------------------------------------------------------------------
|
|
// Store item.
|
|
public abstract bool InsertPortfolioItem(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
public abstract bool UpdatePortfolioItem(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
// Verify moving item.
|
|
public abstract bool CanMoveItemUp(SbmPortfolioItem portfolioItem);
|
|
public abstract bool CanMoveItemDown(SbmPortfolioItem portfolioItem);
|
|
// Move item.
|
|
public abstract bool MoveItemUp(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
public abstract bool MoveItemDown(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
// Delete item.
|
|
public virtual bool PortfolioItemCanBeDeleted(SbmPortfolioItem portfolioItem)
|
|
{
|
|
ClearErrorState();
|
|
return true;
|
|
}
|
|
public abstract bool DeletePortfolioItem(SbmPortfolioItem portfolioItem, DbUpdateInfo dbUpdateInfo);
|
|
|
|
//-------------------------------------------------------------------
|
|
// Item list.
|
|
public abstract ColumnDfn GetPortfolioItemColumnDfn(SbmPortfolioItem.Column columnId, String caption = "", int width = 0);
|
|
public abstract List<String> GetPortfolioItemQueryFilter(SbmPortfolioItem.Params prm);
|
|
public abstract long GetPortfolioItemCount(SbmPortfolioItem.Params prm);
|
|
public abstract List<SbmPortfolioItem> GetPortfolioItemList(SbmPortfolioItem.Params prm);
|
|
public abstract DbResultSet ExecutePortfolioItemQuery(List<ColumnDfn> columns, SbmPortfolioItem.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 GetPortfolioItemDataValue(ColumnDfn column, NamedValue.Map values)
|
|
{
|
|
DataValue value = new DataValue();
|
|
switch ((SbmPortfolioItem.Column)column.Id)
|
|
{
|
|
//-----------------------------------------------------------
|
|
// Portfolio Item Type.
|
|
case SbmPortfolioItem.Column.Type_Desc:
|
|
{
|
|
Sbm.PortfolioItemType portfolioItemType = (Sbm.PortfolioItemType)values.GetValue(column.DataName).AsLong();
|
|
value = new DataValue(PortfolioItemTypes.GetDescForType(portfolioItemType, portfolioItemType.ToString()));
|
|
break;
|
|
}
|
|
|
|
//-----------------------------------------------------------
|
|
// Notes.
|
|
case SbmPortfolioItem.Column.Notes:
|
|
value = new DataValue(SacsHierarchyItem.FormatForDisplay(values.GetValue(column.DataName).ToString(), 200));
|
|
break;
|
|
|
|
// Status.
|
|
case SbmPortfolioItem.Column.Status_Desc:
|
|
case SbmPortfolioItem.Column.Status_Ind:
|
|
{
|
|
String statusCode = values.GetValue(column.DataName).ToString();
|
|
SaStatus status = SacsSystem.GetStatusForCode(statusCode);
|
|
if (column.Id == (int)SbmPortfolioItem.Column.Status_Desc)
|
|
value = new DataValue(SacsSystem.GetStatusDescForCode(statusCode));
|
|
else if (column.Id == (int)SbmPortfolioItem.Column.Status_Ind)
|
|
value = new DataValue(SbmPortfolioItem.GetStatusTriState(status));
|
|
break;
|
|
}
|
|
|
|
//-----------------------------------------------------------
|
|
default:
|
|
value = values.GetValue(column.DataName);
|
|
break;
|
|
|
|
}
|
|
return value;
|
|
}
|
|
|
|
//-------------------------------------------------------------------
|
|
}
|
|
//=======================================================================
|
|
}
|