General.Products.ProductDimensions Entity

Namespace: General.Products

Contains convertion ratios between the supported measument categories for each product. Does not contain a record for the default category of the products, for which the convertion ratio is defined as equal to 1. Entity: Gen_Product_Dimensions

Default Visualization

Default Display Text Format:
{Product.Name:T}
Default Search Members:
Product.Name
Name Data Member:
Product.Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
General.Products.Products
Aggregate Root:
General.Products.Products

Attributes

Name	Type	Description
ConvertToBaseDivisor	decimal (9, 3)	This was intended to be the divisor, but due to a historical bug actually contains the multiplier of the convertion ratio from the non-base measurement category to the base measurement category. This should be automatically calculated by the system. `Required`
ConvertToBaseMultiplier	decimal (9, 3)	This was intended to be the multiplier, but due to a historical bug actually contains the divisor of the convertion ratio from the non-base measurement category to the base measurement category. This should be automatically calculated by the system. `Required`
DestQuantity	Quantity (9, 3)	Quantity in some of the base units, that equals Source_Quantity. `Unit: DestQuantityUnit` `Required` `Default(1)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
SourceQuantity	Quantity (9, 3)	The quantity in the non-base unit. `Unit: SourceQuantityUnit` `Required` `Default(1)`

References

Name	Type	Description
DestQuantityUnit	MeasurementUnits	The measurement unit of Dest_Quantity. Should be one of the units of the base measurement category of the product. `Required` `Filter(multi eq)`
MeasurementCategory	MeasurementCategories	The measurement category of Source Quantity Unit. For each product, only one conversion ratio can be specified for a measurement category. `Required` `Filter(multi eq)` `ReadOnly`
Product	Products	The product for which we specify conversion ratios. `Required` `Filter(multi eq)` `Owner`
SourceQuantityUnit	MeasurementUnits	The non-base measurement unit for which we specify convertion ratio. `Required` `Filter(multi eq)`

Attribute Details

ConvertToBaseDivisor

This was intended to be the divisor, but due to a historical bug actually contains the multiplier of the convertion ratio from the non-base measurement category to the base measurement category. This should be automatically calculated by the system. Required

Type: decimal (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown

Back-End Default Expression:
( ( obj.DestQuantity.Value * obj.DestQuantityUnit.Multiplier) * obj.SourceQuantityUnit.Divisor)

ConvertToBaseMultiplier

This was intended to be the multiplier, but due to a historical bug actually contains the divisor of the convertion ratio from the non-base measurement category to the base measurement category. This should be automatically calculated by the system. Required

Type: decimal (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: CannotBeShown

Back-End Default Expression:
( ( obj.SourceQuantity.Value * obj.SourceQuantityUnit.Multiplier) * obj.DestQuantityUnit.Divisor)

DestQuantity

Quantity in some of the base units, that equals Source_Quantity. Unit: DestQuantityUnit Required Default(1)

Type: Quantity (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

SourceQuantity

The quantity in the non-base unit. Unit: SourceQuantityUnit Required Default(1)

Type: Quantity (9, 3)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: Constant
Show in UI: ShownByDefault

Reference Details

DestQuantityUnit

The measurement unit of Dest_Quantity. Should be one of the units of the base measurement category of the product. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

MeasurementCategory

The measurement category of Source Quantity Unit. For each product, only one conversion ratio can be specified for a measurement category. Required Filter(multi eq) ReadOnly

Type: MeasurementCategories
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

Back-End Default Expression:
obj.SourceQuantityUnit.MeasurementCategory

Front-End Recalc Expressions:
obj.SourceQuantityUnit.MeasurementCategory

Product

The product for which we specify conversion ratios. Required Filter(multi eq) Owner

Type: Products
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

SourceQuantityUnit

The non-base measurement unit for which we specify convertion ratio. Required Filter(multi eq)

Type: MeasurementUnits
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST