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

Inherits: Progress.Lang.Object


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



Top Method Summary
Options Name Purpose
AddResult (RapidCloudResponse, character, character) Adds a result message of the given type to the response
AnswerQuestions (ListQuestion, EventHandlerParameter) Answers the unanswered questions of the given list through the IRapidCloudInteractionService
ApplyChangedValues (handle, RapidCloudResponse) Creates Value rules for the form fields whose value the event handler changed in the dataset
ApplyFormFields (handle, handle) Applies the form state sent by the RCD frontend to the primary buffer of the event handler dataset
ApplyUiActions (UiControl, RapidCloudResponse, character) Translates the UI actions of the given UiControl into RCD portal trigger rules
ApplyUiControl (UiControl, RapidCloudResponse, character) Translates the given UiControl into the RCD rules vocabulary of the response
AssignFieldValue (handle, character) Assigns the given form state value to a buffer field
CHARACTER CustomContextValue (EventHandlerParameter, character) Returns a character value of the custom context of the event handler parameter
Consultingwerk.CommonUi.UiControl InvokeEventHandler (character, character, EventHandlerParameter, handle, RapidCloudResponse) Invokes the given server-side event handler method and translates the returned UiControl into the RCD response
CHARACTER MessageResultType (ValidationMessage) Returns the result type of the given validation message
CHARACTER MessageText (ValidationMessage) Returns the resolved text of the given validation message
CHARACTER NotificationResultType (Notification) Returns the result type of the given notification
CHARACTER RenderFieldValue (handle) Renders the value of a buffer field in the RCD form state representation
ResetDatasetChangeState (handle) Resets the change-state (before-image records, row-states) of the given ProDataset


Method Detail
Top

AddResult (RapidCloudResponse, character, character)
Purpose: Adds a result message of the given type to the response
Notes: An empty message text is ignored

Parameters:
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response to add the result to
pcType CHARACTER
The result type (error, warning or info)
pcText CHARACTER
The message text
Top

AnswerQuestions (ListQuestion, EventHandlerParameter)
Purpose: Answers the unanswered questions of the given list
through the IRapidCloudInteractionService
Notes: The questions and their replies are carried back into the
next handler invocation on the event handler parameter
(the pattern of the GUI question loop)

Parameters:
poQuestions Consultingwerk.Framework.MessageInteraction.ListQuestion
The questions raised by the event handler
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The event handler parameter of the invocation
Top

ApplyChangedValues (handle, RapidCloudResponse)
Purpose: Creates Value rules for the form fields whose value the
event handler changed in the dataset
Notes: Compares the primary buffer values against the snapshot
taken when the form state was applied

Parameters:
phDataset HANDLE
The dataset of the event handler
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response to add the rules to
Top

ApplyFormFields (handle, handle)
Purpose: Applies the form state sent by the RCD frontend to the
primary buffer of the event handler dataset
Notes: The Value properties of the form state are written to the
same-named fields of the first buffer (typed following
the fConvString2* conventions of the reference). A
snapshot of the applied values supports the changed-value
rules created after the invocation

Parameters:
phDataset HANDLE
The dataset of the event handler
phFormFieldsTable HANDLE
The handle of the ttFormfields shaped table, may be ?
Top

ApplyUiActions (UiControl, RapidCloudResponse, character)
Purpose: Translates the UI actions of the given UiControl into RCD
portal trigger rules
Notes:

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl returned by the event handler
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response to add the rules to
pcAppId CHARACTER
The id of the RCD app of the request (may be empty)
Top

ApplyUiControl (UiControl, RapidCloudResponse, character)
Purpose: Translates the given UiControl into the RCD rules
vocabulary of the response
Notes: Field controls map onto ReadOnly / Hidden / Label rules,
messages and notifications onto result rows, the focus
field onto the cursor rule and the UI actions onto the
portal triggers. Unsupported UI actions are logged and
skipped

Parameters:
poUiControl Consultingwerk.CommonUi.UiControl
The UiControl returned by the event handler
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response to add the rules to
pcAppId CHARACTER
The id of the RCD app of the request (may be empty)
Top

AssignFieldValue (handle, character)
Purpose: Assigns the given form state value to a buffer field
Notes: Typed following the fConvString2* conventions of the
reference (ISO dates, decimal point)

Parameters:
phField HANDLE
The buffer field to assign
pcValue CHARACTER
The form state value
Top

CHARACTER CustomContextValue (EventHandlerParameter, character)
Purpose: Returns a character value of the custom context of the
event handler parameter
Notes: The RCD data endpoint carries the request context
(RowIdData, AppId, Fieldtrigger, Payload) as a JsonObject
in the EventCustomContext

Parameters:
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The event handler parameter of the invocation
pcName CHARACTER
The name of the context property
Returns CHARACTER
The character value of the property or an empty value when the property is not set
Top

Consultingwerk.CommonUi.UiControl InvokeEventHandler (character, character, EventHandlerParameter, handle, RapidCloudResponse)
Purpose: Invokes the given server-side event handler method and
translates the returned UiControl into the RCD response
Notes: The handler reference follows the server:<Class>[:<Method>]
convention of the SmartComponent Library - a method named
in the reference overrides the given method name.
Questions raised by the handler are answered through the
IRapidCloudInteractionService and the handler is invoked
again (desktop-style question loop)

Parameters:
pcHandlerReference CHARACTER
The handler reference (server:<Class>[:<Method>], the prefix is optional)
pcMethodName CHARACTER
The name of the handler method (when the reference does not name one)
poParameter Consultingwerk.CommonUi.EventHandlerParameter
The event handler parameter
phFormFieldsTable HANDLE
The handle of the ttFormfields shaped table with the form state, ? when the request carries none
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response to add the rules to
Returns Consultingwerk.CommonUi.UiControl
The UiControl returned by the event handler
Top

CHARACTER MessageResultType (ValidationMessage)
Purpose: Returns the result type of the given validation message
Notes:

Parameters:
poMessage Consultingwerk.OERA.ValidationMessages.ValidationMessage
The validation message
Returns CHARACTER
The RetType value (error, warning or info)
Top

CHARACTER MessageText (ValidationMessage)
Purpose: Returns the resolved text of the given validation message
Notes: SmartMessage references are resolved through the
IMessageProvider; plain messages return their message
strings

Parameters:
poMessage Consultingwerk.OERA.ValidationMessages.ValidationMessage
The validation message
Returns CHARACTER
The resolved message text
Top

CHARACTER NotificationResultType (Notification)
Purpose: Returns the result type of the given notification
Notes:

Parameters:
poNotification Consultingwerk.CommonUi.Notification
The notification
Returns CHARACTER
The RetType value (error, warning or info)
Top

CHARACTER RenderFieldValue (handle)
Purpose: Renders the value of a buffer field in the RCD form state
representation
Notes: Typed following the fConv* conventions of the reference
(ISO dates, decimal point, JavaScript logical values)

Parameters:
phField HANDLE
The buffer field to render
Returns CHARACTER
The rendered value
Top

ResetDatasetChangeState (handle)
Purpose: Resets the change-state (before-image records, row-states)
of the given ProDataset
Notes: The dataset returned by the (singleton) event handler
service may still carry change-state from a previous
event on the same session (SCL-5342)

Parameters:
phDataset HANDLE
The dataset to reset


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