General.Products.CompositeProductComponents Entity

Namespace: General.Products

Separate components of a product which are packaged and stored individually. Used when a single product is stored in multiple packages. Entity: Log_Composite_Product_Components (Introduced in version 23.1.0.15)

Renames

Old name: Logistics.CompositeProductComponents
New name: General.Products.CompositeProductComponents
Version: 25.1.0.64
Case: 37169

Default Visualization

Default Display Text Format:
{ComponentNo}: {ComponentProduct}
Default Search Members:
CompositeProduct.Name
Name Data Member:
CompositeProduct.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
ComponentNo	int32	Consecutive number of the component within this composite product. `Required` `Filter(multi eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	date nullable	Starting date (inclusive) of the validity of the component. Null means that the component does not have an activation date. `Filter(eq;ge;le)`
Id	guid
IsActive	boolean	Indicates whether the component is currently active for this composite product. `Required` `Default(true)` `Filter(eq)`
Notes	string (max) nullable	Notes for this composite product component.
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.
Quantity	decimal (12, 3)	The number of packages of this component that are needed to compose the product. `Required` `Default(1)` `Filter(multi eq;ge;le)`
ToDate	date nullable	Ending date (inclusive) of the validity of the component. Null means that the component does not have a deactivation date. `Filter(eq;ge;le)`

References

Name	Type	Description
ComponentProduct	Products	The product which is a component of the composite product. `Required` `Filter(multi eq)`
CompositeProduct	Products	The product of which the current component is a part. `Required` `Filter(multi eq)` `Owner`

Attribute Details

ComponentNo

Consecutive number of the component within this composite product. Required Filter(multi eq)

Type: int32
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.CompositeProduct.CompositeProductComponents.Select( c => c.ComponentNo).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.CompositeProduct.CompositeProductComponents.Select( c => c.ComponentNo).DefaultIfEmpty( 0).Max( ) + 1)

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

FromDate

Starting date (inclusive) of the validity of the component. Null means that the component does not have an activation date. Filter(eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Id

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

IsActive

Indicates whether the component is currently active for this composite product. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Notes

Notes for this composite product component.

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

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

Quantity

The number of packages of this component that are needed to compose the product. Required Default(1) Filter(multi eq;ge;le)

Type: decimal (12, 3)
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Default Value: 1
Show in UI: ShownByDefault

ToDate

Ending date (inclusive) of the validity of the component. Null means that the component does not have a deactivation date. Filter(eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

ComponentProduct

The product which is a component of the composite product. Required Filter(multi eq)

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

CompositeProduct

The product of which the current component is a part. Required Filter(multi eq) Owner

Type: Products
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
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