General.ProductVariants Entity
Namespace: General
Contains definitions of different variants of a product. The variants are differentiated by color, size and style. Entity: Gen_Product_Variants
Default Visualization
Default Display Text Format:
{Name:T}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
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 |
---|---|---|
BarCode | string (16) nullable | When specified, it contains a bar code which uniquely identifies the product variant. Filter(eq;like) ORD |
Code | string (16) | The code of the variant. The code is unique within the Product. It is the concatenation of the codes of the color, size and style. Required Filter(eq;like) ReadOnly |
DisplayText | string | Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object. |
Id | guid | |
Name | MultilanguageString (512) nullable | Product variant name. It is the concatenation of the names of the color, size and style. ReadOnly |
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. |
References
Name | Type | Description |
---|---|---|
Product | Products | The product for which this variant is defined. Required Filter(multi eq) Owner |
VariantColor | VariantColors (nullable) | The color of the variant. null means that the variant does not have a specific color. Filter(multi eq) |
VariantSize | VariantSizes (nullable) | The size of the variant. null means that the variant does not have a specific size. Filter(multi eq) |
VariantStyle | VariantStyles (nullable) | The style of the variant. null means that the variant does not have a specific style. Filter(multi eq) |
Attribute Details
BarCode
When specified, it contains a bar code which uniquely identifies the product variant. Filter(eq;like)
ORD
Type: string (16) nullable
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Code
The code of the variant. The code is unique within the Product. It is the concatenation of the codes of the color, size and style. Required
Filter(eq;like)
ReadOnly
Type: string (16)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 16
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: ****
Id
Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Name
Product variant name. It is the concatenation of the names of the color, size and style. ReadOnly
Type: MultilanguageString (512) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Back-End Default Expression:
Join( " ", new [] {obj.VariantColor.Name, obj.VariantSize.Name, obj.VariantStyle.Name})
Front-End Recalc Expressions:
Join( " ", new [] {obj.VariantColor.Name, obj.VariantSize.Name, obj.VariantStyle.Name})
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: ****
Reference Details
Product
The product for which this variant is defined. Required
Filter(multi eq)
Owner
Type: Products
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
VariantColor
The color of the variant. null means that the variant does not have a specific color. Filter(multi eq)
Type: VariantColors (nullable)
Category: System
Supported Filters: Equals, EqualsIn
VariantSize
The size of the variant. null means that the variant does not have a specific size. Filter(multi eq)
Type: VariantSizes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
VariantStyle
The style of the variant. null means that the variant does not have a specific style. Filter(multi eq)
Type: VariantStyles (nullable)
Category: System
Supported Filters: Equals, EqualsIn
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: stringsearch
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: nullexactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: FalseorderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: Falsetop
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0
Business Rules
None
Front-End Business Rules
None
API
Domain API Query: https://demodb.my.erp.net/api/domain/odata/General_ProductVariants?$top=10
Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#General_ProductVariants?$top=10