Logistics.Inventory.StoreGroups Entity

Hierarchy of store groups. Entity: Inv_Store_Groups

Default Visualization

Default Display Text Format:
{Code}: {Name}
Default Search Members:
Code; Name
Code Data Member:
Code
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

Logistics.Inventory.StoreGroups

Attributes

Name	Type	Description
Code	string (16)	The unique code of the StoreGroup. `Required` `Filter(eq;like)` `ORD`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
~~FullPath~~	string (25) nullable	OBSOLETE! Do not use! The full path to the store group in a dot separated, non-leading dot format. For example: 001.005.008. `Obsolete` `Filter(eq;like)` `ORD` `ReadOnly` `Obsoleted in version 23.1.2.3`
Id	guid
Name	MultilanguageString (254)	The name of this StoreGroup. `Required` `Filter(like)`
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.
~~ParentFullPath~~	string (25) nullable	OBSOLETE! Do not use! The full path to the parent store group. It is stored in a dot separated, non-leading dot format. For example: 001.005. `Obsolete` `Filter(eq;like)` `ReadOnly` `Obsoleted in version 23.1.2.3`

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies (nullable)	The Enterprise Company to which this StoreGroup applies, or null if it is for all enterprise companies. `Filter(multi eq)`
EnterpriseCompanyLocation	CompanyLocations (nullable)	The Enterprise Company Location to which this StoreGroup applies, or null if it is for all enterprise company locations. `Filter(multi eq)`
Parent	StoreGroups (nullable)	Parent store group. null if this is root group. `Filter(multi eq)` `Introduced in version 23.1.2.3`

Attribute Details

Code

The unique code of the StoreGroup. Required Filter(eq;like) ORD

Type: string (16)
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 16
Show in UI: ShownByDefault

Back-End Default Expression:
obj.IncMax( o => o.Code, o => ( o.Parent == obj.Parent), "000")

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

FullPath

OBSOLETE! Do not use! The full path to the store group in a dot separated, non-leading dot format. For example: 001.005.008. Obsolete Filter(eq;like) ORD ReadOnly Obsoleted in version 23.1.2.3

Type: string (25) nullable
Indexed: True
Category: System
Supported Filters: Equals, Like
Supports Order By: True
Maximum Length: 25
Show in UI: ShownByDefault

Id

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

Name

The name of this StoreGroup. Required Filter(like)

Type: MultilanguageString (254)
Category: System
Supported Filters: Like
Supports Order By: False
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

ParentFullPath

OBSOLETE! Do not use! The full path to the parent store group. It is stored in a dot separated, non-leading dot format. For example: 001.005. Obsolete Filter(eq;like) ReadOnly Obsoleted in version 23.1.2.3

Type: string (25) nullable
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 25
Show in UI: HiddenByDefault

Reference Details

EnterpriseCompany

The Enterprise Company to which this StoreGroup applies, or null if it is for all enterprise companies. Filter(multi eq)

Type: EnterpriseCompanies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: HiddenByDefault

EnterpriseCompanyLocation

The Enterprise Company Location to which this StoreGroup applies, or null if it is for all enterprise company locations. Filter(multi eq)

Type: CompanyLocations (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Parent

Parent store group. null if this is root group. Filter(multi eq) Introduced in version 23.1.2.3

Type: StoreGroups (nullable)
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

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST