Namespace: Consultingwerk.Integrations.RapidCloud.Repository
Class 
RapidCloudSmartRepositoryLayoutRepository Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudSmartRepositoryLayoutRepository

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Integrations.RapidCloud.Repository.IRapidCloudLayoutRepository


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
LOGICAL AppExists (character) Returns if an app definition of the given name exists
DECIMAL AppModificationSequence (character) Returns the modification sequence of the given app definition
Progress.Json.ObjectModel.JsonArray BuildChildren (handle, character, character, integer) Builds the children rows array of a designer node from the child instances of the given parent
CHARACTER CharacterAttribute (handle, character, character) Returns the value of a character attribute of the given attribute buffer
LOGICAL ComponentExists (character) Returns if a component definition of the given name exists
DECIMAL ComponentModificationSequence (character) Returns the modification sequence of the given component definition
CHARACTER ControlMasterName (character) Returns the name of the RcdControl_* node master of the given designer object type
CopyApp (character, character) Copies an app definition under a new name
CopyComponent (character, character) Copies a component definition under a new name
CopyDefinition (character, character, character) Copies a definition under a new name
DeleteApp (character) Deletes the app definition of the given name
DeleteComponent (character) Deletes the component definition of the given name
DeleteDefinition (character, character) Deletes the definition master of the given name
DeleteInstances (ISmartRepositoryService, character) Deletes every node instance of the given definition master
CHARACTER EnsureControlMaster (ISmartRepositoryService, character) Ensures that the RcdControl_* node master of the given designer object type exists
INTEGER IntegerAttribute (handle, character, integer) Returns the value of an integer attribute of the given attribute buffer
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListApps (character) Returns the app definitions matching the given name filter
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListComponents (character) Returns the component definitions matching the given name filter
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListDefinitions (character, character) Returns the definitions of a family matching the given name filter
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadApp (character) Loads the app definition of the given name including its structure
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadComponent (character) Loads the component definition of the given name including its structure
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadDefinition (character, character, logical) Loads the definition of the given name
LOGICAL LogicalAttribute (handle, character, logical) Returns the value of a logical attribute of the given attribute buffer
DECIMAL NextModificationSequence () Returns the next modification sequence value
CHARACTER NodeObjectType (character) Returns the designer object type of the given node master name
CHARACTER ObjectTypeGuid (ISmartRepositoryService, character) Returns the object type GUID of the given object type name
Progress.Json.ObjectModel.JsonObject RenderStructure (handle, handle) Renders the structure JSON of the definition from the instance tree and the structure envelope attribute
SaveApp (RapidCloudScreenDefinition) Saves the given app definition
SaveComponent (RapidCloudScreenDefinition) Saves the given component definition
SaveDefinition (RapidCloudScreenDefinition, character) Saves the given definition
CHARACTER SerializeJson (JsonConstruct) Serializes the given JSON value into a character value
StoreChildren (ISmartRepositoryService, character, JsonArray, character, integer) Creates the node instances of the given children rows
Progress.Json.ObjectModel.JsonObject StructureHeader (JsonObject) Returns the structure envelope of the given ObjData object
Progress.Json.ObjectModel.JsonObject StructureObjData (RapidCloudScreenDefinition) Returns the ObjData object of the definition structure
UpdateMasterDescription (character, character) Updates the description of the given definition master
ValidateNodeConfigs (JsonArray) Serializes the node config of every node of the given children rows, so that an oversized config fails before the repository is touched

Top Constructor Summary
Options Name Purpose
RapidCloudSmartRepositoryLayoutRepository () Constructor for the RapidCloudSmartRepositoryLayoutRepository class

Top Property Summary
Options Name Purpose
CHARACTER AppObjectTypeName
CHARACTER ComponentObjectTypeName
CHARACTER DefaultProductModuleName
CHARACTER ProductModuleName


Method Detail
Top

LOGICAL AppExists (character)
Purpose: Returns if an app definition of the given name exists
Notes:

Parameters:
pcAppName CHARACTER
The name of the app
Returns LOGICAL
True when the app definition exists
Top

DECIMAL AppModificationSequence (character)
Purpose: Returns the modification sequence of the given app
definition
Notes: Returns the unknown value when the app definition does
not exist

Parameters:
pcAppName CHARACTER
The name of the app
Returns DECIMAL
The modification sequence of the app definition or ?
Top

Progress.Json.ObjectModel.JsonArray BuildChildren (handle, character, character, integer)
Purpose: Builds the children rows array of a designer node from
the child instances of the given parent
Notes: The row grid (including empty rows) is restored from the
RcdRowIndex attribute of the child nodes and the given
row count

Parameters:
phRepositoryData HANDLE
The repository data of the screen master
pcContainerGuid CHARACTER
The GUID of the screen master
pcParentInstanceGuid CHARACTER
The GUID of the parent instance, empty for the root level
piRowCount INTEGER
The number of rows of the children array
Returns Progress.Json.ObjectModel.JsonArray
The JsonArray of children rows
Top

CHARACTER CharacterAttribute (handle, character, character)
Purpose: Returns the value of a character attribute of the given
attribute buffer
Notes: Returns the default when the attribute is not part of the
buffer or carries no value

Parameters:
phAttributes HANDLE
The merged attribute buffer
pcAttributeName CHARACTER
The name of the attribute
pcDefault CHARACTER
The value returned when the attribute is not available
Returns CHARACTER
The attribute value or the default
Top

LOGICAL ComponentExists (character)
Purpose: Returns if a component definition of the given name
exists
Notes:

Parameters:
pcComponentName CHARACTER
The name of the component
Returns LOGICAL
True when the component definition exists
Top

DECIMAL ComponentModificationSequence (character)
Purpose: Returns the modification sequence of the given component
definition
Notes: Returns the unknown value when the component definition
does not exist

Parameters:
pcComponentName CHARACTER
The name of the component
Returns DECIMAL
The modification sequence of the component definition or ?
Top

CHARACTER ControlMasterName (character)
Purpose: Returns the name of the RcdControl_* node master of the
given designer object type
Notes:

Parameters:
pcObjectType CHARACTER
The designer object type (e.g. datagrid)
Returns CHARACTER
The name of the node master
Top

CopyApp (character, character)
Purpose: Copies an app definition under a new name
Notes: Occurrences of the source name inside the structure are
replaced with the target name

Parameters:
pcSourceAppName CHARACTER
The name of the app to copy
pcTargetAppName CHARACTER
The name of the new app
Top

CopyComponent (character, character)
Purpose: Copies a component definition under a new name
Notes: Occurrences of the source name inside the structure are
replaced with the target name

Parameters:
pcSourceComponentName CHARACTER
The name of the component to copy
pcTargetComponentName CHARACTER
The name of the new component
Top

CopyDefinition (character, character, character)
Purpose: Copies a definition under a new name
Notes:

Parameters:
pcSourceName CHARACTER
The name of the definition to copy
pcTargetName CHARACTER
The name of the new definition
pcObjectTypeName CHARACTER
The object type of the definition family
Top

DeleteApp (character)
Purpose: Deletes the app definition of the given name
Notes: Deleting an app that does not exist is a no-op. An object
master of the same name that is not an RCD screen
definition is treated as not existing and never deleted

Parameters:
pcAppName CHARACTER
The name of the app
Top

DeleteComponent (character)
Purpose: Deletes the component definition of the given name
Notes: Deleting a component that does not exist is a no-op. An
object master of the same name that is not an RCD screen
definition is treated as not existing and never deleted

Parameters:
pcComponentName CHARACTER
The name of the component
Top

DeleteDefinition (character, character)
Purpose: Deletes the definition master of the given name
Notes: A master that does not exist - or that exists but is not
an RCD screen definition - is a no-op

Parameters:
pcName CHARACTER
The name of the definition
pcObjectTypeName CHARACTER
The object type of the definition family
Top

DeleteInstances (ISmartRepositoryService, character)
Purpose: Deletes every node instance of the given definition master
Notes: The instances are deleted in descending object sequence
(children before their parents, see StoreChildren). An
instance that is gone already (deleted together with its
parent) is skipped

Parameters:
poRepository Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The repository service
pcMasterName CHARACTER
The name of the definition master
Top

CHARACTER EnsureControlMaster (ISmartRepositoryService, character)
Purpose: Ensures that the RcdControl_* node master of the given
designer object type exists
Notes: Creates the master in the configured product module when
it is missing

Parameters:
poRepository Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The repository service
pcObjectType CHARACTER
The designer object type (e.g. datagrid)
Returns CHARACTER
The name of the node master
Top

INTEGER IntegerAttribute (handle, character, integer)
Purpose: Returns the value of an integer attribute of the given
attribute buffer
Notes: Returns the default when the attribute is not part of the
buffer or carries the unknown value

Parameters:
phAttributes HANDLE
The merged attribute buffer
pcAttributeName CHARACTER
The name of the attribute
piDefault INTEGER
The value returned when the attribute is not available
Returns INTEGER
The attribute value or the default
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListApps (character)
Purpose: Returns the app definitions matching the given name
filter
Notes: The returned definitions carry metadata only
(Structure = ?). Only masters of the configured product
module are returned

Parameters:
pcNameFilter CHARACTER
The name filter (contains match) or empty for all apps
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList
The list of matching app definitions
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListComponents (character)
Purpose: Returns the component definitions matching the given
name filter
Notes: The returned definitions carry metadata only
(Structure = ?). Only masters of the configured product
module are returned

Parameters:
pcNameFilter CHARACTER
The name filter (contains match) or empty for all components
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList
The list of matching component definitions
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList ListDefinitions (character, character)
Purpose: Returns the definitions of a family matching the given
name filter
Notes: Enumerates the masters of the configured product module
that carry the RCD screen marker

Parameters:
pcNameFilter CHARACTER
The name filter (contains match) or empty for all definitions
pcObjectTypeName CHARACTER
The object type of the definition family
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinitionList
The list of matching definitions
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadApp (character)
Purpose: Loads the app definition of the given name including its
structure
Notes: Returns the unknown value when the app definition does
not exist

Parameters:
pcAppName CHARACTER
The name of the app
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The app definition or ?
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadComponent (character)
Purpose: Loads the component definition of the given name
including its structure
Notes: Returns the unknown value when the component definition
does not exist

Parameters:
pcComponentName CHARACTER
The name of the component
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The component definition or ?
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition LoadDefinition (character, character, logical)
Purpose: Loads the definition of the given name
Notes: Returns the unknown value when no master of the name
exists, when the master is of a different object type or
when it does not carry the RCD screen marker

Parameters:
pcName CHARACTER
The name of the definition
pcObjectTypeName CHARACTER
The object type of the definition family
plIncludeStructure LOGICAL
Include the JSON structure of the definition
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition or ?
Top

LOGICAL LogicalAttribute (handle, character, logical)
Purpose: Returns the value of a logical attribute of the given
attribute buffer
Notes: Returns the default when the attribute is not part of the
buffer or carries the unknown value

Parameters:
phAttributes HANDLE
The merged attribute buffer
pcAttributeName CHARACTER
The name of the attribute
plDefault LOGICAL
The value returned when the attribute is not available
Returns LOGICAL
The attribute value or the default
Top

DECIMAL NextModificationSequence ()
Purpose: Returns the next modification sequence value
Notes: Milliseconds since the beginning of 2020 - monotonically
increasing across sessions without requiring a database
sequence (matches the file based implementation)

Returns DECIMAL
The next modification sequence value
Top

CHARACTER NodeObjectType (character)
Purpose: Returns the designer object type of the given node master
name
Notes:

Parameters:
pcMasterName CHARACTER
The name of the RcdControl_* node master
Returns CHARACTER
The designer object type (e.g. datagrid)
Top

CHARACTER ObjectTypeGuid (ISmartRepositoryService, character)
Purpose: Returns the object type GUID of the given object type
name
Notes: The GUIDs of the two definition family types are cached

Parameters:
poRepository Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The repository service
pcObjectTypeName CHARACTER
The name of the object type
Returns CHARACTER
The GUID of the object type
Top

Progress.Json.ObjectModel.JsonObject RenderStructure (handle, handle)
Purpose: Renders the structure JSON of the definition from the
instance tree and the structure envelope attribute
Notes: Restores the StructureData wrapper of the RCD storage
format (prods:objId / Progress.Json.ObjectModel.JsonObject)

Parameters:
phRepositoryData HANDLE
The repository data of the screen master
phAttributes HANDLE
The attribute buffer of the screen master
Returns Progress.Json.ObjectModel.JsonObject
The structure JsonObject
Top

SaveApp (RapidCloudScreenDefinition)
Purpose: Saves the given app definition
Notes: Assigns a new modification sequence and the modification
timestamp to the definition

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The app definition to save
Top

SaveComponent (RapidCloudScreenDefinition)
Purpose: Saves the given component definition
Notes: Assigns a new modification sequence and the modification
timestamp to the definition

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The component definition to save
Top

SaveDefinition (RapidCloudScreenDefinition, character)
Purpose: Saves the given definition
Notes: An existing definition master is updated in place, so its
GUID stays stable across saves (links, menu functions and
repository layout diagrams keep referencing it): the
attributes and the description are stored, the node
instances are replaced. Every node config is serialized
before the repository is touched and the update runs
inside one transaction, so a failing save leaves the
previous definition intact (SCL-6043). The audit values
default to the session user

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition to save
pcObjectTypeName CHARACTER
The object type of the definition family
Top

CHARACTER SerializeJson (JsonConstruct)
Purpose: Serializes the given JSON value into a character value
Notes: Throws a clear error when the serialized value exceeds
the ABL character size (~32 KB) that an attribute value
can carry

Parameters:
poJson Progress.Json.ObjectModel.JsonConstruct
The JSON construct to serialize
Returns CHARACTER
The serialized JSON text
Top

StoreChildren (ISmartRepositoryService, character, JsonArray, character, integer)
Purpose: Creates the node instances of the given children rows
Notes: Walks the designer tree top-down, so parent instances
exist before their children

Parameters:
poRepository Consultingwerk.SmartFramework.Repository.ISmartRepositoryService
The repository service
pcMasterName CHARACTER
The name of the screen master
poRows Progress.Json.ObjectModel.JsonArray
The children rows array of the parent node
pcParentInstance CHARACTER
The instance name of the parent node, empty for the root level
piSequence INTEGER
INPUT-OUTPUT The running object sequence within the master
Top

Progress.Json.ObjectModel.JsonObject StructureHeader (JsonObject)
Purpose: Returns the structure envelope of the given ObjData
object
Notes: Carries everything of the ObjData except the children
tree (which is stored as the instance tree): timestamp,
the optional params object, the objects / components /
ctrlnames bookkeeping lists of the designer and the row
count of the root children array

Parameters:
poObjData Progress.Json.ObjectModel.JsonObject
The ObjData object of the structure
Returns Progress.Json.ObjectModel.JsonObject
The structure envelope JsonObject
Top

Progress.Json.ObjectModel.JsonObject StructureObjData (RapidCloudScreenDefinition)
Purpose: Returns the ObjData object of the definition structure
Notes: Validates the StructureData wrapper shape of the RCD
storage format

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition carrying the structure
Returns Progress.Json.ObjectModel.JsonObject
The ObjData JsonObject
Top

UpdateMasterDescription (character, character)
Purpose: Updates the description of the given definition master
Notes: The description of a screen master carries the title of
the definition

Parameters:
pcMasterGuid CHARACTER
The GUID of the definition master
pcDescription CHARACTER
The new description
Top

ValidateNodeConfigs (JsonArray)
Purpose: Serializes the node config of every node of the given
children rows, so that an oversized config fails before
the repository is touched
Notes: Walks the designer tree like StoreChildren

Parameters:
poRows Progress.Json.ObjectModel.JsonArray
The children rows array of the parent node


Constructor Detail
Top

RapidCloudSmartRepositoryLayoutRepository ()
Purpose: Constructor for the RapidCloudSmartRepositoryLayoutRepository class
Notes: Initializes the ProductModuleName from the
DefaultProductModuleName static property



Property Detail
Top

CHARACTER AppObjectTypeName

Returns CHARACTER
Top

CHARACTER ComponentObjectTypeName

Returns CHARACTER
Top

CHARACTER DefaultProductModuleName

Returns CHARACTER
Top

CHARACTER ProductModuleName

Returns CHARACTER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       10.10.2026 15:23:26