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

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
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
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
CHARACTER DefinitionFileName (character, character) Returns the file name of a definition
DeleteApp (character) Deletes the app definition of the given name
DeleteComponent (character) Deletes the component definition of the given name
DeleteDefinition (character) Deletes the definition file of the given file name
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
DECIMAL NextModificationSequence () Returns the next modification sequence value
Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition ReadDefinitionFile (character, logical) Reads a definition file in the ttScreenData wrapper format of the RCD runtime
CHARACTER ResolveDirectories () Returns the directories holding the structure files in resolution order
CHARACTER ResolveFile (character) Resolves the given definition file name against the structure directories
SaveApp (RapidCloudScreenDefinition) Saves the given app definition
SaveComponent (RapidCloudScreenDefinition) Saves the given component definition
SaveDefinition (RapidCloudScreenDefinition, character) Saves the given definition
ValidateDefinitionName (character) Validates the name of a definition before it becomes part of a file name
WriteDefinitionFile (RapidCloudScreenDefinition, character) Writes the given definition into a file in the ttScreenData wrapper format of the RCD runtime

Top Property Summary
Options Name Purpose
CHARACTER StructureDirectories


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

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

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
pcPrefix CHARACTER
The file name prefix of the definition family
Top

CHARACTER DefinitionFileName (character, character)
Purpose: Returns the file name of a definition
Notes:

Parameters:
pcPrefix CHARACTER
The file name prefix of the definition family
pcName CHARACTER
The name of the definition
Returns CHARACTER
The file name of the definition
Top

DeleteApp (character)
Purpose: Deletes the app definition of the given name
Notes: Deleting an app that does not exist is a no-op

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

Parameters:
pcComponentName CHARACTER
The name of the component
Top

DeleteDefinition (character)
Purpose: Deletes the definition file of the given file name
Notes: A file that does not exist is a no-op

Parameters:
pcFileName CHARACTER
The file name of the definition
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 = ?)

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 = ?)

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: The first directory carrying a definition name wins - a
same-named definition in a later directory is layered
out, following the PROPATH override semantics of the
reference

Parameters:
pcNameFilter CHARACTER
The name filter (contains match) or empty for all definitions
pcPrefix CHARACTER
The file name prefix 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 the definition does not
exist

Parameters:
pcName CHARACTER
The name of the definition
pcPrefix CHARACTER
The file name prefix of the definition family
plIncludeStructure LOGICAL
Include the JSON structure of the definition
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition or ?
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

Returns DECIMAL
The next modification sequence value
Top

Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition ReadDefinitionFile (character, logical)
Purpose: Reads a definition file in the ttScreenData wrapper
format of the RCD runtime
Notes:

Parameters:
pcPath CHARACTER
The path of the definition file
plIncludeStructure LOGICAL
Include the JSON structure of the definition
Returns Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition
Top

CHARACTER ResolveDirectories ()
Purpose: Returns the directories holding the structure files in
resolution order
Notes: The StructureDirectories property when set, the PROPATH
entries (without procedure libraries) otherwise

Returns CHARACTER
The comma-delimited list of directories
Top

CHARACTER ResolveFile (character)
Purpose: Resolves the given definition file name against the
structure directories
Notes: The first directory carrying the file wins

Parameters:
pcFileName CHARACTER
The file name of the definition
Returns CHARACTER
The full path of the file or ? when no directory carries it
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 file is overwritten in place; new
definitions are created in the first structure directory

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition to save
pcPrefix CHARACTER
The file name prefix of the definition family
Top

ValidateDefinitionName (character)
Purpose: Validates the name of a definition before it becomes part
of a file name
Notes: Definition names arrive from the RCD designer (client
input). A name with path separators, a parent directory
reference, a drive separator or a leading dot would resolve
a file outside the structure directories - such a name is
rejected

Parameters:
pcName CHARACTER
The name of the definition
Top

WriteDefinitionFile (RapidCloudScreenDefinition, character)
Purpose: Writes the given definition into a file in the
ttScreenData wrapper format of the RCD runtime
Notes:

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The definition to write
pcPath CHARACTER
The path of the definition file


Property Detail
Top

CHARACTER StructureDirectories

Returns CHARACTER


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