General.Products.ProductGroupRangeProperties Entity

Namespace: General.Products

When specified for a product group, provides a way for automatical creation of new products, based on altering a set of values of some user-defined properties. Each value combination is used to create a new, unique product within the group. Entity: Gen_Product_Group_Range_Properties

Default Visualization

Default Display Text Format:
{ProductGroup.Name:T}
Default Search Members:
ProductGroup.Name
Name Data Member:
ProductGroup.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.ProductGroups
Aggregate Root:
General.Products.ProductGroups

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromPropertyValue	string (254) nullable	Starting value of the range of alternative values. Used only when Rage Type = R (range).
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.
PropertyValuesList	string (max) nullable	Contains the enumeration of all values in the alternating value set. Used only when Rage Type = E (enumeratio).
RangeType	RangeType	Specifies the method of the creation of the value set: R - by range from-to; E - by enumeration of all values;. `Required` `Default("R")`
ToPropertyValue	string (254) nullable	Ending value of the range of alternative values. Used only when Rage Type = R (range).

References

Name	Type	Description
ProductGroup	ProductGroups	The to which this ProductGroupRangeProperty belongs. `Required` `Filter(multi eq)` `Owner`
Property	CustomProperties	The property whose values will be altered. `Required` `Filter(multi eq)`

Attribute Details

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

FromPropertyValue

Starting value of the range of alternative values. Used only when Rage Type = R (range).

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

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

PropertyValuesList

Contains the enumeration of all values in the alternating value set. Used only when Rage Type = E (enumeratio).

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

RangeType

Specifies the method of the creation of the value set: R - by range from-to; E - by enumeration of all values;. Required Default("R")

Type: RangeType
Category: System
Allowed values for the RangeType(General.Products.ProductGroupRangeProperties.md#rangetype) data attribute
Allowed Values (General.Products.ProductGroupRangePropertiesRepository.RangeType Enum Members)

Value	Description
Range	Range value. Stored as 'R'. Database Value: 'R' Model Value: 0 Domain API Value: 'Range'
List	List value. Stored as 'L'. Database Value: 'L' Model Value: 1 Domain API Value: 'List'

Supported Filters: NotFilterable
Supports Order By: False
Default Value: Range
Show in UI: ShownByDefault

ToPropertyValue

Ending value of the range of alternative values. Used only when Rage Type = R (range).

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

Reference Details

ProductGroup

The to which this ProductGroupRangeProperty belongs. Required Filter(multi eq) Owner

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

Property

The property whose values will be altered. Required Filter(multi eq)

Type: CustomProperties
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