LocationEntity

📊 Overview: 6 Functions

6 Getters

Extends: Entity

🕐 Last updated: 2025-12-10T11:45:23.208Z

---

📑 Table of Contents

• ⚙️ Functions
  • Regular Functions
    • CheckRelated (1 param) → Boolean 🖥️
    • printQRSheet (2 params) 🖥️
    • printLabel (1 param) 🖥️
    • generateQR → Picture 🖥️
    • getStockListboxCollection → $StockListboxCollection : Collection 🖥️
    • removeLocation → Boolean 🖥️
  • Computed Attributes (Getters/Setters/Query/OrderBy)
    • DisplayName 🔍 → Text
    • HasStock 🔍 → Boolean
    • Level 🔍 → Integer
    • ListBoxDisplayName 🔍 → Text
    • ListboxMetaExpression 🔍 → Object
    • SortOrder 🔍 → Text
• 🔗 Related Items

---

Functions

Regular Functions

CheckRelated

[🖥️ local]

Function CheckRelated($LocationID : Text) -> Boolean

Returns true if specified LocationID exists anywhere in this location’s parent hierarchy

Parameters:

Name	Type	Optional	Description
$LocationID	Text	-	-

Returns: Boolean

---

printQRSheet

[🖥️ local]

Function printQRSheet($PageSize : Text; $ShowPrintSettings : Boolean)

Prints a QR code sheet for this location using specified page size

Parameters:

Name	Type	Optional	Description
$PageSize	Text	-	-
$ShowPrintSettings	Boolean	-	-

---

printLabel

[🖥️ local]

Function printLabel($ShowPrintSettings : Boolean)

Prints a location barcode label with QR code

Parameters:

Name	Type	Optional	Description
$ShowPrintSettings	Boolean	-	-

---

generateQR

[🖥️ local]

Function generateQR -> Picture

Generates QR code picture containing location barcode data as JSON

Returns: Picture

---

getStockListboxCollection

[🖥️ local]

Function getStockListboxCollection -> $StockListboxCollection : Collection

Returns collection of stock listbox objects for all pallets and material stock at this location

Returns: Collection

---

removeLocation

[🖥️ local]

Function removeLocation -> Boolean

Deletes this location after validation (no sub-locations, no stock, user confirmation), returns success status

Returns: Boolean

---

Computed Attributes (Getters/Setters/Query/OrderBy)

DisplayName

[🔍 get only, 🖥️ local]

Function get DisplayName -> $DisplayName : Text

Returns full location path with » separators (e.g., “Warehouse » Aisle 1 » Shelf A”)

Returns: Text

---

HasStock

[🔍 get only]

Function get HasStock -> Boolean

Returns true if location has any pallets or material stock assigned to it

Returns: Boolean

---

Level

[🔍 get only, 🖥️ local]

Function get Level -> $Level : Integer

Returns hierarchy depth level (0=root, 1=first level, etc.)

Returns: Integer

---

ListBoxDisplayName

[🔍 get only, 🖥️ local]

Function get ListBoxDisplayName -> $ListBoxDisplayName : Text

Returns location name indented with tabs based on hierarchy level for listbox display

Returns: Text

---

ListboxMetaExpression

[🔍 get only, 🖥️ local]

Function get ListboxMetaExpression -> $ListboxMetaExpression : Object

Returns styling object for listbox row (font weight, background color based on hierarchy level)

Returns: Object

---

SortOrder

[🔍 get only, 🖥️ local]

Function get SortOrder -> $SortOrder : Text

Returns tab-delimited hierarchy path for sorting locations in tree structure

Returns: Text

---

Related Items

🗂️ Tables

• Location - ORDA Entity class for Location table

� Related Classes

• Location - ORDA DataClass class for Location table

� Forms

• LocationManager - Data source for LocationManager form

---

Generated from LocationEntity.4dm