Product.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Linq.Expressions;
  5. using InABox.Core;
  6. using PRSClasses;
  7. namespace Comal.Classes
  8. {
  9. public interface IProduct : IEntity
  10. {
  11. }
  12. [UserTracking("Product Management")]
  13. public class Product : Entity, IPersistent, IRemotable, IIssues, ILicense<ProductManagementLicense>, IExportable, IImportable, IMergeable
  14. {
  15. [UniqueCodeEditor(Visible = Visible.Default, Editable = Editable.Enabled)]
  16. [EditorSequence(1)]
  17. public string Code { get; set; }
  18. [TextBoxEditor]
  19. [EditorSequence(2)]
  20. public string Name { get; set; }
  21. [MemoEditor]
  22. [EditorSequence(3)]
  23. public string Notes { get; set; }
  24. [EditorSequence(4)]
  25. public ProductDimensionUnitLink UnitOfMeasure { get; set; }
  26. private class ProductInstanceLookup : LookupDefinitionGenerator<ProductInstance, Product>
  27. {
  28. public override Filter<ProductInstance>? DefineFilter(Product[] items)
  29. {
  30. if (items.Length == 0)
  31. {
  32. return new Filter<ProductInstance>().None();
  33. }
  34. else
  35. {
  36. var filter = new Filters<ProductInstance>();
  37. foreach (var item in items)
  38. {
  39. filter.Add(new Filter<ProductInstance>(x => x.Product.ID).IsEqualTo(item.ID));
  40. }
  41. return filter.Combine();
  42. }
  43. }
  44. public override Columns<Product> DefineFilterColumns() => Columns.None<Product>().Add(x => x.ID);
  45. }
  46. [LookupDefinition(typeof(ProductInstanceLookup))]
  47. [EditorSequence(5)]
  48. [RequiredColumn]
  49. public ProductInstanceLink DefaultInstance { get; set; }
  50. [EditorSequence(6)]
  51. public ProductGroupLink Group { get; set; }
  52. [EditorSequence(7)]
  53. [DataModelTableName("Image")]
  54. public ImageDocumentLink Image { get; set; }
  55. [URLEditor]
  56. [EditorSequence(8)]
  57. public string URL { get; set; }
  58. [TimestampEditor]
  59. [EditorSequence(9)]
  60. public DateTime Expired { get; set; }
  61. [EnumLookupEditor(typeof(ProductPricingStrategy))]
  62. [EditorSequence("Pricing", 1)]
  63. public ProductPricingStrategy PricingStrategy { get; set; } = ProductPricingStrategy.Standard;
  64. private class SupplierProductLookup : LookupDefinitionGenerator<SupplierProduct, Product>
  65. {
  66. public override Filter<SupplierProduct> DefineFilter(Product[] items)
  67. {
  68. var id = items != null && items.Length == 1 ? items[0].ID : CoreUtils.FullGuid;
  69. return new Filter<SupplierProduct>(x => x.Product.ID).IsEqualTo(id);
  70. }
  71. public override Columns<Product> DefineFilterColumns()
  72. => Columns.None<Product>().Add(x => x.ID);
  73. }
  74. [LookupDefinition(typeof(SupplierProductLookup))]
  75. [EditorSequence("Pricing", 2)]
  76. public ProductSupplierLink Supplier { get; set; }
  77. [CheckBoxEditor]
  78. [EditorSequence("Pricing", 3)]
  79. public bool UseDefaultSupplierPricing { get; set; } = true;
  80. [CurrencyEditor(Visible = Visible.Optional)]
  81. [EditorSequence("Pricing", 4)]
  82. public double BaseCost { get; set; }
  83. [Aggregate(typeof(ProductComponentCost))]
  84. [CurrencyEditor(Visible = Visible.Optional)] //, Editable = Editable.Disabled)]
  85. [EditorSequence("Pricing", 5)]
  86. public double ComponentCost { get; set; }
  87. [CurrencyEditor(Visible = Visible.Optional, Editable = Editable.Disabled)]
  88. [EditorSequence("Pricing", 6)]
  89. public double NettCost { get; set; }
  90. [Obsolete("Replaced with ProductInstance.AverageCost", true)]
  91. [CurrencyEditor(Visible = Visible.Optional)]
  92. [EditorSequence("Pricing", 7)]
  93. [LoggableProperty]
  94. public double AverageCost { get; set; }
  95. [EditorSequence("Pricing", 8)]
  96. [RequiredColumn]
  97. public TaxCodeLink TaxCode { get; set; }
  98. [EditorSequence("Pricing", 9)]
  99. [RequiredColumn]
  100. public PurchaseGLCodeLink PurchaseGL { get; set; }
  101. [EditorSequence("Pricing", 10)]
  102. [RequiredColumn]
  103. public SalesGLCodeLink SellGL { get; set; }
  104. [EditorSequence("Pricing", 11)]
  105. [RequiredColumn]
  106. public CostCentreLink CostCentre { get; set; }
  107. [EditorSequence("Pricing", 12)]
  108. public CostSheetSectionLink CostSheetSection { get; set; }
  109. [ProductChargeEditor]
  110. [EditorSequence("Pricing", 13)]
  111. public ProductCharge Charge { get; set; }
  112. /// <summary>
  113. /// Flag to indicate whether stock movements are to be tracked for this item.
  114. /// If set, no stock movements will be recorded, even if the Warehouse and/or default location are set.
  115. /// </summary>
  116. [CheckBoxEditor]
  117. [EditorSequence("Warehousing", 1)]
  118. public bool NonStock { get; set; } = false;
  119. /// <summary>
  120. /// The Warehouse that this item resides in. DefaultLocation Lookups are limited to this Warehouse only, although
  121. /// actual stock holdings can be anywhere (imperfect systems)
  122. /// </summary>
  123. [EditorSequence("Warehousing", 2)]
  124. public StockWarehouseLink Warehouse { get; set; }
  125. private class StockLocationLookup : LookupDefinitionGenerator<StockLocation, Product>
  126. {
  127. // If there are multiple items, they must be all in the same warehouse
  128. public override Filter<StockLocation> DefineFilter(Product[] items)
  129. {
  130. var warehouses = items.Select(x => x.Warehouse.ID).Distinct().ToArray();
  131. if (warehouses.Length == 1)
  132. return new Filter<StockLocation>(x => x.Active).IsEqualTo(true).And(x => x.Warehouse.ID).IsEqualTo(warehouses.First());
  133. return new Filter<StockLocation>(x => x.ID).IsEqualTo(CoreUtils.FullGuid);
  134. }
  135. public override Columns<Product> DefineFilterColumns()
  136. => Columns.None<Product>().Add(x => x.Warehouse.ID);
  137. }
  138. [LookupDefinition(typeof(StockLocationLookup))]
  139. /// <summary>
  140. /// (Optional) The Location to be used when Purchase Orders / Consignments are received.
  141. /// If blank, the item will be received into the default location for the Warehouse assign to the product
  142. /// If that is also blank, then no stock movement will be recorded when receiving the item
  143. /// </summary>
  144. [EditorSequence("Warehousing", 4)]
  145. public StockLocationLink DefaultLocation { get; set; }
  146. private class ProductFormLookups : LookupDefinitionGenerator<DigitalForm, Product>
  147. {
  148. public override Filter<DigitalForm> DefineFilter(Product[] items)
  149. {
  150. // Get all FillableFormTypes where 2nd parameter is typeof(PurchaseOrder)
  151. return new Filter<DigitalForm>(x => x.Active).IsEqualTo(true).And(x => x.AppliesTo).IsEqualTo("PurchaseOrderItem");
  152. }
  153. public override Columns<Product> DefineFilterColumns()
  154. => Columns.None<Product>();
  155. }
  156. [Caption("Incoming QA")]
  157. [EditorSequence("Warehousing", 5)]
  158. public DigitalFormLink DigitalForm { get; set; }
  159. [Caption("Mfg Treatment?")]
  160. //[EditorSequence("Warehousing", 6)]
  161. [NullEditor]
  162. [Obsolete("Replaced with TreatmentType", true)]
  163. public bool IsManufacturingTreatment { get; set; }
  164. private class TreatmentTypeLookup : LookupDefinitionGenerator<TreatmentType, Product>
  165. {
  166. public override Filter<TreatmentType>? DefineFilter(Product[] items)
  167. {
  168. return new Filter<TreatmentType>(x => x.Active).IsEqualTo(true);
  169. }
  170. }
  171. [LookupDefinition(typeof(TreatmentTypeLookup))]
  172. [EditorSequence("Warehousing", 6)]
  173. public TreatmentTypeLink TreatmentType { get; set; }
  174. [NullEditor]
  175. public string Barcodes { get; set; }
  176. [Aggregate(typeof(ProductUnitAggregate))]
  177. [DoubleEditor(Editable = Editable.Hidden)]
  178. public double UnitQty { get; set; }
  179. [Aggregate(typeof(ProductRemnantAggregate))]
  180. [DoubleEditor(Editable = Editable.Hidden)]
  181. public double RemnantQty { get; set; }
  182. [Aggregate(typeof(OnOrderAggregate))]
  183. [DoubleEditor(Editable = Editable.Hidden)]
  184. public double OnOrder { get; set; }
  185. [Aggregate(typeof(TotalStockAggregate))]
  186. [DoubleEditor(Editable = Editable.Hidden)]
  187. public double TotalStock { get; set; }
  188. [Formula(typeof(ReservedStockFormula))]
  189. [DoubleEditor(Editable = Editable.Hidden)]
  190. public double ReservedStock { get; set; }
  191. [Aggregate(typeof(FreeStockAggregate))]
  192. [DoubleEditor(Editable = Editable.Hidden)]
  193. public double FreeStock { get; set; }
  194. [Aggregate(typeof(TotalRequiredAggregate))]
  195. [DoubleEditor(Editable = Editable.Hidden)]
  196. public double Required { get; set; }
  197. [Aggregate(typeof(ProductReceivedAggregate))]
  198. [DateTimeEditor(Editable = Editable.Hidden)]
  199. public DateTime LastReceived { get; set; }
  200. [Aggregate(typeof(ProductIssuedAggregate))]
  201. [DateTimeEditor(Editable = Editable.Hidden)]
  202. public DateTime LastIssued { get; set; }
  203. [Obsolete("Replaced with DefaultInstance.Style")]
  204. [NullEditor]
  205. public ProductStyleLink DefaultStyle { get; set; }
  206. [Obsolete("Replaced with DefaultInstance.MinimumStockLevel")]
  207. [NullEditor]
  208. public int MinimumStockLevel { get; set; }
  209. [Obsolete("Replaced with DefaultInstance.Dimensions")]
  210. [NullEditor]
  211. public ProductDimensions Dimensions { get; set; }
  212. [NullEditor]
  213. [Obsolete("Replaced with Dimensions", true)]
  214. // [DoubleEditor]
  215. // [EditorSequence(4)]
  216. public double UnitSize { get; set; }
  217. [NullEditor]
  218. [Obsolete("Replaced with Dimensions", false)]
  219. // [EditorSequence(5)]
  220. public ProductUOMLink Units { get; set; }
  221. [NullEditor]
  222. [Obsolete("Replaced with Dimensions", true)]
  223. // [DoubleEditor]
  224. // [EditorSequence(6)]
  225. // [Caption("Standard Weight")]
  226. public double Weight { get; set; }
  227. [NullEditor]
  228. public string Issues { get; set; }
  229. public override string ToString()
  230. {
  231. return string.Format("{0}: {1} ({2})", Code, Name, DefaultInstance.Dimensions.UnitSize);
  232. }
  233. public static double CalculateNettCost(ProductPricingStrategy strategy, double basecost, double componentcost)
  234. {
  235. if (strategy == ProductPricingStrategy.Kit)
  236. return basecost + componentcost;
  237. if (strategy == ProductPricingStrategy.Subcontractor)
  238. return basecost - componentcost;
  239. // Standard or Assembly
  240. return basecost;
  241. }
  242. }
  243. public class FreeStockAggregate : CoreAggregate<Product, StockMovement, double>
  244. {
  245. public override Expression<Func<StockMovement, double>> Aggregate => x => x.Qty;
  246. public override Filter<StockMovement> Filter => new Filter<StockMovement>(x => x.Job).NotLinkValid();
  247. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  248. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  249. {
  250. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  251. };
  252. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  253. }
  254. public class OnOrderAggregate : CoreAggregate<Product, PurchaseOrderItem, double>
  255. {
  256. public override Expression<Func<PurchaseOrderItem, double>> Aggregate => x => x.Qty;
  257. //public Expression<Func<PurchaseOrderItem, Guid>> Link => x => x.ProductLink.ID;
  258. public override Dictionary<Expression<Func<PurchaseOrderItem, object?>>, Expression<Func<Product, object?>>> Links =>
  259. new Dictionary<Expression<Func<PurchaseOrderItem, object?>>, Expression<Func<Product, object?>>>()
  260. {
  261. { PurchaseOrderItem => PurchaseOrderItem.Product.ID, Product => Product.ID }
  262. };
  263. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  264. }
  265. public class ProductReceivedAggregate : CoreAggregate<Product, StockMovement, DateTime>
  266. {
  267. public override Expression<Func<StockMovement, DateTime>> Aggregate => x => x.Date;
  268. public override Filter<StockMovement> Filter =>
  269. new Filter<StockMovement>(x => x.Type).IsEqualTo(StockMovementType.Receive);
  270. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  271. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  272. {
  273. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  274. };
  275. public override AggregateCalculation Calculation => AggregateCalculation.Maximum;
  276. }
  277. public class ProductRemnantAggregate : CoreAggregate<Product, StockMovement, double>
  278. {
  279. public override Expression<Func<StockMovement, double>> Aggregate => x => x.Units;
  280. public override Filter<StockMovement> Filter => new Filter<StockMovement>(x => x.IsRemnant).IsEqualTo(true);
  281. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  282. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  283. {
  284. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  285. };
  286. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  287. }
  288. public class ProductUnitAggregate : CoreAggregate<Product, StockMovement, double>
  289. {
  290. public override Expression<Func<StockMovement, double>> Aggregate => x => x.Units;
  291. public override Filter<StockMovement> Filter => new Filter<StockMovement>(x => x.IsRemnant).IsEqualTo(false);
  292. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  293. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  294. {
  295. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  296. };
  297. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  298. }
  299. public class ReservedStockFormula : IFormula<Product, double>
  300. {
  301. public Expression<Func<Product, double>> Value => x => x.TotalStock;
  302. public Expression<Func<Product, double>>[] Modifiers => new Expression<Func<Product, double>>[] { x => x.FreeStock };
  303. public FormulaOperator Operator => FormulaOperator.Subtract;
  304. public FormulaType Type => FormulaType.Virtual;
  305. }
  306. public class StockShortageFormula : IFormula<Product, double>
  307. {
  308. public Expression<Func<Product, double>> Value => x => x.TotalStock;
  309. public Expression<Func<Product, double>>[] Modifiers => new Expression<Func<Product, double>>[] { x => x.Required };
  310. public FormulaOperator Operator => FormulaOperator.Subtract;
  311. public FormulaType Type => FormulaType.Virtual;
  312. }
  313. public class TotalRequiredAggregate : CoreAggregate<Product, JobRequisitionItem, double>
  314. {
  315. public override Expression<Func<JobRequisitionItem, double>> Aggregate => x => x.TotalQty;
  316. public override Dictionary<Expression<Func<JobRequisitionItem, object?>>, Expression<Func<Product, object?>>> Links =>
  317. new Dictionary<Expression<Func<JobRequisitionItem, object?>>, Expression<Func<Product, object?>>>()
  318. {
  319. { JobMaterialRequisitionItem => JobMaterialRequisitionItem.Product.ID, Product => Product.ID }
  320. };
  321. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  322. }
  323. public class TotalStockAggregate : CoreAggregate<Product, StockMovement, double>
  324. {
  325. public override Expression<Func<StockMovement, double>> Aggregate => x => x.Qty;
  326. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  327. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  328. {
  329. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  330. };
  331. public override AggregateCalculation Calculation => AggregateCalculation.Sum;
  332. }
  333. public class ProductIssuedAggregate : CoreAggregate<Product, StockMovement, DateTime>
  334. {
  335. public override Expression<Func<StockMovement, DateTime>> Aggregate => x => x.Date;
  336. public override Filter<StockMovement> Filter =>
  337. new Filter<StockMovement>(x => x.Type).IsEqualTo(StockMovementType.Issue);
  338. public override Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>> Links =>
  339. new Dictionary<Expression<Func<StockMovement, object?>>, Expression<Func<Product, object?>>>()
  340. {
  341. { StockMovement => StockMovement.Product.ID, Product => Product.ID }
  342. };
  343. public override AggregateCalculation Calculation => AggregateCalculation.Maximum;
  344. }
  345. }