Product Class

Products are the different items in the enterprise, which can be purchased, stored, sold and depreciated. Entity: Gen_Products

Inheritance Hierarchy

SystemObject
  Aloe.SystemFrameworks.DomainDomainObject
    Aloe.SystemFrameworks.DomainEditableDomainObject
      Aloe.SystemFrameworks.DomainEntityObject
        Aloe.EnterpriseOne.Model.CoreEnterpriseOneEntityObject
          Aloe.EnterpriseOne.Model.General.ProductsProduct

Namespace: Aloe.EnterpriseOne.Model.General.Products
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class Product : EnterpriseOneEntityObject, IConversionRatioProvider<MeasurementUnit>, 
	IConversionRatioToBaseProvider<MeasurementUnit>

Public Class Product
	Inherits EnterpriseOneEntityObject
	Implements IConversionRatioProvider(Of MeasurementUnit), IConversionRatioToBaseProvider(Of MeasurementUnit)

public ref class Product : public EnterpriseOneEntityObject, 
	IConversionRatioProvider<MeasurementUnit^>, IConversionRatioToBaseProvider<MeasurementUnit^>

type Product =  
    class
        inherit EnterpriseOneEntityObject
        interface IConversionRatioProvider<MeasurementUnit>
        interface IConversionRatioToBaseProvider<MeasurementUnit>
    end

The Product type exposes the following members.

Constructors

	Name	Description
	Product	Initializes a new instance of the Product class with specific ObjectTransaction

Top

Properties

	Name	Description
	ABCClass	Product importance classification, where A are the most important and C - the least important products. Usually used as user filtering condition when previewing results of the procurement planning process. [Required] [Default("B ")] [Filter(eq)]
	Active	True if the product is active, false - not to list in combo boxes for choosing in new documents. [Required] [Default(true)] [Filter(eq)]
	AllowVariableMeasurementRatios	Allow variable (dynamic) measurement ratios for each transaction. If specified, each store transaction could specify different measurement ratio between the used measurement unit and the base measurement unit. [Required] [Default(false)] [Filter(eq)]
	BaseMeasurementCategory	The base measurement category for quantities of this product. [Required] [Filter(multi eq)]
	BaseUnit	Gets the base measurement unit of this product.
	CargoType	Specifies what type of cargo this product is. Required when generating transportation requisitions. null means unspecified. [Filter(multi eq)]
	CatalogDescriptionHtml	Full HTML description of the product. Usually used for display on product catalogs, web pages, etc.
	ChangingAttributes	Gets the attributes that are currently changing. Can be used in attribute change event handler to prevent stack overflow. (Inherited from EditableDomainObject.)
	CodeAndName	Gets a string consisted of the PartNumber and Name separated by a colon - "{PartNumber}: {Name.CurrentString}".
	Codes	List of ProductCode child objects, based on the General.Products.ProductCode.Product back reference
	CostingCurrency	Specifies the currency to use for cost calculations for the product. When null, the base currency for the enterprise company should be used. [Filter(multi eq)]
	CostingMethod	Specifies the costing method for the product. null means to use the Enterprise Company default. Currently supported methods are: EXP - Explicitly specify lot; AVG - Average cost.
	CreationTime	Date and time when the Product was created. [Filter(ge;le)] [ReadOnly]
	CreationUser	Login name of the user, who created the Product. [Filter(like)] [ReadOnly]
	CustomProperties	Gets the custom properties of the object. (Inherited from EnterpriseOneEntityObject.)
	DefaultStoreBins	List of ProductDefaultStoreBin child objects, based on the Logistics.Inventory.ProductDefaultStoreBin.Product back reference
	Description	The description of the product.
	Dimensions	List of ProductDimension child objects, based on the General.Products.ProductDimension.Product back reference
	DistributionChannels	List of ProductDistributionChannel child objects, based on the Crm.Marketing.ProductDistributionChannel.Product back reference
	DocumentAmounts	List of ProductDocumentAmount child objects, based on the General.Products.ProductDocumentAmount.Product back reference
	EnterpriseCompany	When not null, specifies that the product is specific to a given enterprise company and may be used only in documents from this enterprise company. [Filter(multi eq)]
	ExpiryPeriodDays	Total default expiry period for the product (in days) from the date of production to the date of expiry.
	ExtendedProperties	Extended properties contain temporary (not persisted) values in the object instance. (Inherited from EntityObject.)
	FlushingMethod	Consumption method for work orders. M=Manual, using Consuption Journals, F=Forward (on release), B=Backward (on finish). [Required] [Default("M")]
	GuaranteePeriodDays	Default guarantee period length in days. 0 means no guarantee. Should be non-null for serviced products and null for the others.
	Id	The unique Id of the entity object (Inherited from EntityObject.)
	IntrastatCommodityCode	Product code from the Intrastat Combined nomenclature. Used when creating Intrastat declarations. [Filter(multi eq)]
	IntrastatSupplementaryUnit	Additional measurement unit from the Intrastat Combined nomenclature. Used when creating Intrastat declarations. [Filter(multi eq)]
	IsFeatured	Specifies whether the product should be presented at the title space in promotional materials, web pages, etc. [Required] [Default(false)] [Filter(eq)]
	IsGhost	Returns true when the object is a ghost object (Inherited from EntityObject.)
	IsLoaded	Gets a value indicating whether the associated data for this domain object is loaded. (Overrides EntityObjectIsLoaded.)
	IsSerialized	True if the parts use/require serial numbers. [Required] [Default(false)] [Filter(eq)]
	ItemString	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	ItemIDataAttribute	Gets or sets the value of a data attribute (Inherited from DomainObject.)
	LineDiscounts	List of LineDiscount child objects, based on the Crm.LineDiscount.Product back reference
	Lots	List of Lot child objects, based on the Logistics.Inventory.Lot.Product back reference
	LotsIssue	Determines the method by which the lots are automatically issued. The method determines the sequence of the lots: in the order of receipt (FIFO), in the order inverse of receipt (LIFO) or in the order of expiration (FEFO).
	ManufacturingPolicy	Manufacturing policy controls the procurement planing system actions for this product. Allowed values are MTS=Make-To-Stock; MTO=Make-To-Order; ATO=Assemble-To-Order. [Required] [Default("MTS")]
	MeasurementUnit	Default measurement unit, when creating new documents with this product. [Required] [Filter(multi eq)]
	MinimalSalesPricePerLot	Minimal allowed price for sales of this product. The price is for one standard lot and in the costing currency of the product. The minimum is enforced upon planning and/or releasing a document. null means that there is no minimal sales price enforcement. [Currency: CostingCurrency]
	MinimalSalesQuantityBase	Minimal base quantity of this product that has to be specified in any sale.
	Name	Name of the item. [Required] [Filter(eq;like)]
	NoEvents	Turns on "No events" mode and returns a class, that will turn it off when Disposed. See remarks for more info. (Inherited from DomainObject.)
	ObjectState	Gets the state of the domain object. (Overrides EditableDomainObjectObjectState.)
	OriginCountry	Country from which the product originates (in which the product is produced/cultivated ...). Primarily used for Intrastat reporting. [Filter(multi eq)]
	PartNumber	Unique part number of the product. [Required] [Filter(multi eq;like)] [ORD]
	Pictures	List of ProductPicture child objects, based on the General.Products.ProductPicture.Product back reference
	PlanningDemandTimeFenceDays	Period in the future, in which changes to the MPS are not accepted due to the high cost of changing. Demand for the period is calculated based entirely on the customer orders. Abbr. - DTF (null = Default of 30 days).
	PlanningHorizonDays	Number of days in the future for which to plan the demand and supply (null = Default of 180 days).
	PlanningTimeFenceDays	Period in the future inside of which changes to the MPS are carefully evaluated to prevent costly schedule disruption. Demand for the period between DTF and PTF is calculated as the bigger of customer orders and sales forecast. Abbr. - PTF. (null = Default of 90 days).
	Prices	List of ProductPrice child objects, based on the Crm.ProductPrice.Product back reference
	ProductCurrency	Gets the product currency which is the CostingCurrency. When CostingCurrency is null the base currency of the enterprise company is used.
	ProductGroup	The product group, under which the product is categorized. [Required] [Filter(multi eq)]
	ProductType	The type of the product. This also defines whether the product is stocked. null=no specific product type and the product is stocked. [Required] [Filter(multi eq)]
	PurchaseMeasurementUnit	Default measurement unit to use, when creating new purchase documents with this product. [Filter(multi eq)]
	PurchaseProductPrices	List of PurchaseProductPrice child objects, based on the Logistics.Procurement.PurchaseProductPrice.Product back reference
	Repository	Provides access to ProductsRepository repository methods
	ScrapRate	Default scrap rate for the recipe, when this product is used as ingredient. [Required] [Default(0)]
	SerialNumbers	List of SerialNumber child objects, based on the Logistics.Inventory.SerialNumber.Product back reference
	ShortName	Short name of the product. Used for space-constrained devices, like mobile phones, fiscal printers, etc. [Filter(eq;like)]
	ShowInCatalog	Specifies whether to show the product in catalogs, referring to the product group of the product. false=Do not show; true=Show. [Required] [Default(false)] [Filter(multi eq)]
	StandardCostPerLot	Standard cost for one standard lot of the product in the currency, specified by Costing_Currency_Id. [Currency: ProductCurrency] [Required] [Default(0)]
	StandardLotSizeBase	The size of a standard lot, expressed in the base measurement unit of the product. Used for Standard_Cost and Standard_Price. [Unit: BaseMeasurementCategory.BaseUnit] [Required] [Default(1)]
	StandardPricePerLot	Standard sales price (used if no special price is defined) for one standard lot of the product in the currency, specified by Costing_Currency_Id. [Currency: ProductCurrency] [Required] [Default(0)]
	SupplySchemaId	The supply schema to use for the distribution of the product among warehouses. [Filter(multi eq)]
	Transaction	The EnterpriseOne transaction to which this object is attached. (Inherited from EnterpriseOneEntityObject.)
	UpdateTime	Date and time when the Product was last updated. [Filter(ge;le)] [ReadOnly]
	UpdateUser	Login name of the user, who last updated the Product. [Filter(like)] [ReadOnly]
	UseLots	Specifies whether the use of lots for this product in store documents is required or is unallowed or is allowed while not required. [Required] [Default("A")]
	ValuationGroup	Valuation group of the product. Used in reconciliations when compensating pluses and minuses. Equal plus and minus amounts within a valuation group are allowed to be compensated with each other for zero net fiscal effect. [Filter(multi eq)]
	Variants	List of ProductVariant child objects, based on the General.ProductVariant.Product back reference

Top

Methods

	Name	Description
	Delete	Deletes the domain object. (Overrides EntityObjectDelete.)
	DuplicateObject	Creates a copy of the object. (Inherited from EntityObject.)
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Inherited from EntityObject.)
	Equals(EntityObject)	Indicates whether the current object is equal to another object of the same type. (Inherited from EntityObject.)
	ExecuteBusinessRules	Executes all business rules for the object for the specified BusinessEvent. The validation fails are saved in the event. (Inherited from EditableDomainObject.)
	GetAggregateParent	Gets the aggregate parent of this entity object. If this is the aggregate root the return value is null. (Inherited from EntityObject.)
	GetAggregateRoot	Gets the aggregate root entity object. If the entity does not have aggregate parent reference aggregate root is this entity object. (Inherited from EntityObject.)
	GetDefaultRecipe	Gets the active recipe for the specified date and store.
	GetHashCode	Returns a hash code for this instance. (Inherited from EntityObject.)
	GetProductDistributionChannelOrDefault	Gets the product distribution channel, which was valid for the specified date and distribution channel.
	GetRatioFromStandardLotToUnit	Gets the conversion ratio from the standard lot of the product to the specified unit.
	GetRatioOrDefault	Gets the conversion ratio for conversion from the specified unit to the specified unit. Returns Zero when the ratio is not available.
	GetRatioToBaseOrDefault	Gets the conversion ratio from the specified unit to the base unit for this provider. Returns Zero if the ratio is not available.
	GetRelatedObjectsForValidation	Gets the related objects which would need validation upon validation of this object. (Inherited from EntityObject.)
	GetStandardUnitCost	Gets the standard unit cost of the product in the specified measurement unit and currency.
	GetStandardUnitPrice	Gets the standard unit price of the product in the specified measurement unit and currency.
	GetUnitPrice	Gets the unit price of the product in the specified measurement unit and currency.
	IssueWarning(String)	Issues a warning with the specified message. (Inherited from EditableDomainObject.)
	IssueWarning(ExpressionFuncString, Object)	Issues a warning with the specified message. The message can contain standard string placeholders. (Inherited from EditableDomainObject.)
	MatchesFilter(DataAccessFilter)	Returns true if this entity object matches the specified filter. (Inherited from EnterpriseOneEntityObject.)
	MatchesFilter(DataAccessFilter, IBufferRow)	Matches the filter against the specified row and returns the result of the match. (Inherited from EnterpriseOneEntityObject.)
	Refresh	Refreshes this instance with data from data source. Only objects with ObjectState equal to Unchanged are refreshed. (Inherited from EntityObject.)
	ToString	Returns a String that represents this instance. (Inherited from EntityObject.)
	ToString(String)	Returns a String that represents this instance. (Inherited from EntityObject.)
	TryGet	Tries to get the specified attribute and returns it or null, when it is not found. (Inherited from DomainObject.)

Top

Extension Methods

	Name	Description
	FillAggregateMissingDefaults	Recalculates the default values for all objects in the aggregate. (Defined by EntityObjectExtensions.)
	FillMissingDefaults	Executes the late default expression defined in each attribute (if any) if the current value is null or equal to a constant default. (Defined by EntityObjectExtensions.)
	FormatString	Converts the object to string based on the format specified. (Defined by FormatStringExtensions.)
	GetCurrentQuantityBase	Gets the stored quantity of the product. (Defined by CurrentBalanceExtensions.)
	GetExtensibleDataObject	Gets the extensible data object related to the entity object. Can return null if such ExtensibleDataObject doesn't exist. (Defined by ExtensibleDataObjectExtensions.)
	GetLotsAvailability	Loads the available lots in order of their issue. The order is determined in the product definition. See LotsIssue. (Defined by LotsManagement.)
	GetOrCreateExtensibleDataObject	Returns an ExtensibleDataObject related to the entity object. If such object doesn't exist the object is created in the same transaction. (Defined by ExtensibleDataObjectExtensions.)
	GetRatioMeasurementUnit	Gets the conversion ratio for convertion from the specified unit to the specified unit. Throws exception if the ratio is not available. (Defined by IConversionRatioProviderExtensions.)
	GetRatioThroughBaseMeasurementUnit	Gets the conversion ratio from the source to the destination unit. The ratio is calculated through the base unit. (Defined by ConversionRatioToBaseProviderStaticMethods.)
	GetRatioThroughBaseOrDefaultMeasurementUnit	Gets the conversion ratio from the source to the destination unit. The ratio is calculated through the base unit. If the ratio is not available, Zero is returned. (Defined by ConversionRatioToBaseProviderStaticMethods.)
	IsConvertibleMeasurementUnit	Verifies if there is a conversion ratio for convertion from the specified unit to the specified unit. (Defined by IConversionRatioProviderExtensions.)
	IsConvertibleToBaseMeasurementUnit	Checks if there is a conversion ratio for convertion from the specified unit to the base unit for this provider. (Defined by ConversionRatioToBaseProviderStaticMethods.)
	RecalculateMasterAttributes	Recalculates the values of a master attributes in a master-detail relationship. (Defined by EntityObjectExtensions.)
	RecalculateMissingValues	Recalculates the missing values using the first reactive expression of the attributes. (Defined by EntityObjectExtensions.)

Top

Reference

Aloe.EnterpriseOne.Model.General.Products Namespace