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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
CreateErrorResponse (character, dataset-handle) Creates a response ProDataset carrying the given message as a ttResult error row
CreateErrorResponse (Error, dataset-handle) Creates a response ProDataset carrying the messages of the given error as ttResult error rows
Invoke (character, dataset-handle) Dispatches the RCD endpoint procedure invocation with the given procedure name to the matching keyed endpoint service
LOGICAL InvokeSessionEndpoint (RapidCloudEndpointTypeEnum, IRapidCloudRequest, dataset-handle) Invokes the session endpoint service when the given endpoint type names one of the fixed-named RCD session endpoints
LOGICAL InvokeStructureEndpoint (RapidCloudEndpointTypeEnum, IRapidCloudRequest, dataset-handle) Invokes the structure endpoint service when the given endpoint type names one of the fixed-named RCD structure endpoints of the designer and the portal
LOGICAL RequiresSessionContext (RapidCloudEndpointTypeEnum) Returns whether the given endpoint type is served in the session context established from the client-principal
ResolveCustomizationResultCodes () Resolves the customization result codes of the session when they have not been resolved yet
Consultingwerk.Integrations.RapidCloud.IRapidCloudRepositoryEndpoint ResolveRepositoryEndpoint (character) Resolves the repository endpoint service for the given Service Key

Top Property Summary
Options Name Purpose
CHARACTER IMPERSONATION_PARAMETER
CHARACTER UI_TYPE


Method Detail
Top

CreateErrorResponse (character, dataset-handle)
Purpose: Creates a response ProDataset carrying the given message
as a ttResult error row
Notes: Used for conditions that carry no error object (STOP)

Parameters:
pcMessageText CHARACTER
The error message to return to the RCD frontend
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CreateErrorResponse (Error, dataset-handle)
Purpose: Creates a response ProDataset carrying the messages of the
given error as ttResult error rows
Notes: The ABL call stack is never part of the response

Parameters:
poError Progress.Lang.Error
The error to return to the RCD frontend
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

Invoke (character, dataset-handle)
Purpose: Dispatches the RCD endpoint procedure invocation with the
given procedure name to the matching keyed endpoint
service
Notes: Errors are returned as ttResult error rows in the response
ProDataset and logged through the LogManager - the ABL
call stack is never part of the response

Parameters:
pcProgramName CHARACTER
The name of the invoked endpoint procedure (as returned by the PROGRAM-NAME function)
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

LOGICAL InvokeSessionEndpoint (RapidCloudEndpointTypeEnum, IRapidCloudRequest, dataset-handle)
Purpose: Invokes the session endpoint service when the given
endpoint type names one of the fixed-named RCD session
endpoints
Notes: The IRapidCloudSessionEndpoint is resolved from the
regular Service Container, defaulting to the
RapidCloudSessionEndpoint implementation (SCL-5721)

Parameters:
poEndpointType Consultingwerk.Integrations.RapidCloud.RapidCloudEndpointTypeEnum
The endpoint type of the invocation
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Returns LOGICAL
Logical value indicating whether the request was served by the session endpoint
Top

LOGICAL InvokeStructureEndpoint (RapidCloudEndpointTypeEnum, IRapidCloudRequest, dataset-handle)
Purpose: Invokes the structure endpoint service when the given
endpoint type names one of the fixed-named RCD structure
endpoints of the designer and the portal
Notes: The IRapidCloudStructureEndpoint is resolved from the
regular Service Container, defaulting to the
RapidCloudStructureEndpoint implementation reading and
writing through the IRapidCloudLayoutRepository (SCL-6043)

Parameters:
poEndpointType Consultingwerk.Integrations.RapidCloud.RapidCloudEndpointTypeEnum
The endpoint type of the invocation
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Returns LOGICAL
Logical value indicating whether the request was served by the structure endpoint
Top

LOGICAL RequiresSessionContext (RapidCloudEndpointTypeEnum)
Purpose: Returns whether the given endpoint type is served in the
session context established from the client-principal
Notes: SCL-5721. The two login endpoints (FrameworkAuthCheck,
FrameworkAuthLogin) are invoked before the user is
authenticated - there is no client-principal to establish a
context from. Every other endpoint type, including
AfterLoginData, requires the context

Parameters:
poEndpointType Consultingwerk.Integrations.RapidCloud.RapidCloudEndpointTypeEnum
The endpoint type of the invocation
Returns LOGICAL
Logical value indicating whether the endpoint type requires the session context
Top

ResolveCustomizationResultCodes ()
Purpose: Resolves the customization result codes of the session when
they have not been resolved yet
Notes: SCL-5994. The RCD login is a credential oracle (SCL-5721) and
the session context is established per request from the
client-principal, so the codes are resolved once the context
of the request has been established - with
SessionManager:UiType UiType naming the RCD user interface - and are
reset together with the context when the request ends. Nothing
is resolved for an anonymous request, without the SmartDB or
when no ICustomizationResultService is registered. A failing
resolution is logged and does not fail the endpoint invocation

Top

Consultingwerk.Integrations.RapidCloud.IRapidCloudRepositoryEndpoint ResolveRepositoryEndpoint (character)
Purpose: Resolves the repository endpoint service for the given
Service Key
Notes: Falls back to the default service (registered without a
Service Key) when no keyed registration exists - keyed
registrations are only required for grids that build their
definition programmatically

Parameters:
pcServiceKey CHARACTER
The Service Key (entity part) of the endpoint name
Returns Consultingwerk.Integrations.RapidCloud.IRapidCloudRepositoryEndpoint
The repository endpoint service to serve the request


Property Detail
Top

CHARACTER IMPERSONATION_PARAMETER

Returns CHARACTER
Top

CHARACTER UI_TYPE

Returns CHARACTER


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