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

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


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



Top Method Summary
Options Name Purpose
AddAppRow (RapidCloudScreenDefinition, logical) Adds a ttFrameworkApps row for the given definition
AddComponentRow (RapidCloudScreenDefinition, logical) Adds a ttFrameworkComponents row for the given definition
AssignAppRow (RapidCloudScreenDefinition, logical) Assigns the current ttFrameworkApps row from the given definition
AssignComponentRow (RapidCloudScreenDefinition, logical) Assigns the current ttFrameworkComponents row from the given definition
Progress.Json.ObjectModel.JsonObject CopyStructure (JsonObject, character, character) Returns a copy of the given structure with the source name replaced by the target name
DeleteApps (IRapidCloudRequest, dataset-handle) Serves the FrameWorkApps-Delete endpoint - deletes the app definitions named by the request rows
DeleteComponents (IRapidCloudRequest, dataset-handle) Serves the FrameWorkComponents-Delete endpoint - deletes the component definitions named by the request rows
GetPortalApp (IRapidCloudRequest, dataset-handle) Serves the FrameWorkAppsPortal endpoint - returns the structure of the app named by the Id parameter for the portal runtime
Consultingwerk.Integrations.RapidCloud.Repository.IRapidCloudLayoutRepository LayoutRepository () Returns the layout repository service
ListApps (IRapidCloudRequest, dataset-handle) Serves the FrameWorkApps endpoint - returns the app definitions matching the AppName filter, or the single app including its structure when the Id parameter is set
ListComponents (IRapidCloudRequest, dataset-handle) Serves the FrameWorkComponents endpoint - returns the component definitions matching the ComponentName filter, or the single component including its structure when the Id parameter is set
CHARACTER LoginCompanyCode () Returns the code of the login company of the session
CHARACTER ParameterValue (IRapidCloudRequest, character) Returns the value of the given request parameter
Progress.Json.ObjectModel.JsonObject ParseStructure (longchar) Parses the structure JSON of a request row
ReadAppsRequest (IRapidCloudRequest) Fills the ttFrameworkApps, ttResult and ttPayload tables from the request body
ReadComponentsRequest (IRapidCloudRequest) Fills the ttFrameworkComponents, ttResult and ttPayload tables from the request body
LOGICAL ReferencesComponents (RapidCloudScreenDefinition) Returns whether the given app definition references components (component placeholders)
SaveApp (IRapidCloudRequest, dataset-handle) Serves the FrameWorkApps-Save endpoint - saves the app definition of the request row (new, copied or modified)
SaveComponent (IRapidCloudRequest, dataset-handle) Serves the FrameWorkComponents-Save endpoint - saves the component definition of the request row (new, copied or modified)


Method Detail
Top

AddAppRow (RapidCloudScreenDefinition, logical)
Purpose: Adds a ttFrameworkApps row for the given definition
Notes:

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The app definition
plStructure LOGICAL
Include the structure JSON in the row
Top

AddComponentRow (RapidCloudScreenDefinition, logical)
Purpose: Adds a ttFrameworkComponents row for the given definition
Notes:

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The component definition
plStructure LOGICAL
Include the structure JSON in the row
Top

AssignAppRow (RapidCloudScreenDefinition, logical)
Purpose: Assigns the current ttFrameworkApps row from the given
definition
Notes:

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The app definition
plStructure LOGICAL
Include the structure JSON in the row
Top

AssignComponentRow (RapidCloudScreenDefinition, logical)
Purpose: Assigns the current ttFrameworkComponents row from the
given definition
Notes:

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The component definition
plStructure LOGICAL
Include the structure JSON in the row
Top

Progress.Json.ObjectModel.JsonObject CopyStructure (JsonObject, character, character)
Purpose: Returns a copy of the given structure with the source name
replaced by the target name
Notes: The copy semantics of the reference implementation
(control and reference naming convention of the RCD
designer)

Parameters:
poStructure Progress.Json.ObjectModel.JsonObject
The structure of the source definition
pcSourceName CHARACTER
The name of the source definition
pcTargetName CHARACTER
The name of the new definition
Returns Progress.Json.ObjectModel.JsonObject
The copied structure or ? when the source carries no structure
Top

DeleteApps (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkApps-Delete endpoint - deletes the app
definitions named by the request rows
Notes: The response carries the info result of the reference
implementation and no app rows

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

DeleteComponents (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkComponents-Delete endpoint - deletes the
component definitions named by the request rows
Notes: The response carries the info result of the reference
implementation and no component rows

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

GetPortalApp (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkAppsPortal endpoint - returns the
structure of the app named by the Id parameter for the
portal runtime
Notes: The Version value (the client cache key of the reference
implementation) combines the modification sequence of the
app and the login company code of the session. Field
securities are not applied (ttReadOnly, ttMandatory and
ttTabs stay empty) and an app referencing components
answers with an error result - see the class header

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

Consultingwerk.Integrations.RapidCloud.Repository.IRapidCloudLayoutRepository LayoutRepository ()
Purpose: Returns the layout repository service
Notes: Defaults to the SmartFramework repository implementation
(Consultingwerk/Integrations/RapidCloud/services.xml
registers the deployment's choice)

Returns Consultingwerk.Integrations.RapidCloud.Repository.IRapidCloudLayoutRepository
The IRapidCloudLayoutRepository instance
Top

ListApps (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkApps endpoint - returns the app
definitions matching the AppName filter, or the single app
including its structure when the Id parameter is set
Notes:

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

ListComponents (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkComponents endpoint - returns the
component definitions matching the ComponentName filter,
or the single component including its structure when the
Id parameter is set
Notes:

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CHARACTER LoginCompanyCode ()
Purpose: Returns the code of the login company of the session
Notes: The CoCd convention of the after-login data (SCL-5721):
the short name, falling back to the name of the login
company

Returns CHARACTER
The login company code or an empty value
Top

CHARACTER ParameterValue (IRapidCloudRequest, character)
Purpose: Returns the value of the given request parameter
Notes: An absent parameter (unknown value) is returned as an
empty value

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
pcParameterName CHARACTER
The name of the request parameter
Returns CHARACTER
The parameter value or an empty value
Top

Progress.Json.ObjectModel.JsonObject ParseStructure (longchar)
Purpose: Parses the structure JSON of a request row
Notes:

Parameters:
plcStructure LONGCHAR
The structure JSON of the request row
Returns Progress.Json.ObjectModel.JsonObject
The parsed structure or ? when the row carries no structure
Top

ReadAppsRequest (IRapidCloudRequest)
Purpose: Fills the ttFrameworkApps, ttResult and ttPayload tables
from the request body
Notes:

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
Top

ReadComponentsRequest (IRapidCloudRequest)
Purpose: Fills the ttFrameworkComponents, ttResult and ttPayload
tables from the request body
Notes:

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
Top

LOGICAL ReferencesComponents (RapidCloudScreenDefinition)
Purpose: Returns whether the given app definition references
components (component placeholders)
Notes: The components list of the ObjData object of the RCD
structure

Parameters:
poDefinition Consultingwerk.Integrations.RapidCloud.Repository.RapidCloudScreenDefinition
The app definition
Returns LOGICAL
True when the structure references at least one component
Top

SaveApp (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkApps-Save endpoint - saves the app
definition of the request row (new, copied or modified)
Notes: A new app (IsNewYN) must not exist yet; a CopyAppName
names the app whose structure (with the app name replaced)
becomes the structure of the saved app. The audit values
are stamped from the session user, the modification
sequence is assigned by the layout repository. The
response carries the saved row and the info result of the
reference implementation

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

SaveComponent (IRapidCloudRequest, dataset-handle)
Purpose: Serves the FrameWorkComponents-Save endpoint - saves the
component definition of the request row (new, copied or
modified)
Notes: A new component (IsNewYN) must not exist yet; a
CopyComponentName names the component whose structure
(with the component name replaced) becomes the structure
of the saved component. The audit values are stamped from
the session user, the modification sequence is assigned
by the layout repository

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset


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