Namespace: Consultingwerk.Integrations.RapidCloud
Class 
RapidCloudDataEndpoint Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.DataServiceInterface.AbstractDataService
Consultingwerk.Integrations.RapidCloud.RapidCloudDataEndpoint

Inherits: Consultingwerk.OERA.DataServiceInterface.AbstractDataService
Implements: Consultingwerk.Integrations.RapidCloud.IRapidCloudDataEndpoint
ABSTRACT


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



Top Method Summary
Options Name Purpose
AddDesignerFieldsResponse (RapidCloudResponse, dataset-handle) Builds the designer mode response of the RecordGet endpoint type - the field metadata of the primary temp-table instead of data
LOGICAL ApplyCellValue (RapidCloudResponse, handle, character, character) Applies a single cell value to the record in the given buffer with change tracking
ApplyInboundRecord (handle, handle, logical) Applies the inbound record values to the record in the given buffer with change tracking
ApplyUiRules (IRapidCloudRequest, dataset-handle) Serves the RCD UIRules endpoint type - returns the UI rules to execute for a field event
CHARACTER BroadcastSource (IRapidCloudRequest) Returns the source identifier (AppId/CtrlName) of the change broadcast emitted after a successful save
BuildRequestDataset (dataset-handle) Builds the dataset receiving the table shaped data of a write request (RecordSet) - the entity shaped data temp-table plus the RCD envelope tables
HANDLE BuildResultTable (handle, character, character, logical, logical, integer) Builds the response temp-table for a retrieval endpoint invocation - the projection of the source temp-table onto the requested columns plus the RowIdData record identity token of every row
DeleteRecords (IRapidCloudRequest, RapidCloudResponse, handle, dataset-handle) Deletes the records identified by the RowIdData tokens of the inbound rows after asking the user for confirmation
CHARACTER EntityETagValue (handle) Returns the ETag value identifying the current version of the record in the given buffer
FetchEntityData (IFetchDataRequest, dataset-handle) Performs a FetchData request for the Business Entity of this endpoint service against the OERA Service Interface
FetchRecordDataset (character, dataset-handle) Fetches the record identified by the given record identity token from the Business Entity of this endpoint service
Consultingwerk.IQueryExpression FilterExpression (handle, character) Returns the filter expression for the given field and filter value
Consultingwerk.IQueryExpression GetFilter (IRapidCloudRequest) Returns the filter expression of a GridData endpoint invocation
GetGridData (IRapidCloudRequest, dataset-handle) Serves the RCD GridData endpoint type - returns the data of a grid
GetList (IRapidCloudRequest, dataset-handle) Serves the RCD List endpoint type - returns the items of a dropdown, autocomplete or similar list-shaped control
CHARACTER GetOrderBy (IRapidCloudRequest) Returns the order-by phrase (without the BY keyword) of a GridData endpoint invocation
GetRecord (IRapidCloudRequest, dataset-handle) Serves the RCD RecordGet endpoint type - returns a single record for a form
InitializeRecord (RapidCloudResponse, character, character, dataset-handle) Builds the init response of the RecordSet endpoint type - a new record with its initial values or a copy of the source record
INTEGER IntegerParameter (character, character) Parses the value of an integer request parameter
InvokeServerSideEvent (IRapidCloudRequest, character, dataset-handle) Invokes the server-side event handler method for a UIRules or Action request and builds the rules response
CHARACTER PagingContext (character) Returns the paging context of the given NextRowId continuation token
CHARACTER ParameterValue (IRapidCloudRequest, character) Returns the value of the given request parameter
Progress.Json.ObjectModel.JsonObject PayloadContext (handle) Returns the ttPayload properties of the request as a JSON object
PerformAction (IRapidCloudRequest, dataset-handle) Serves the Organi Action endpoint convention - executes server logic triggered by a button
HANDLE PrimarySchemaBuffer () Returns the (schema) buffer of the primary temp-table of the Business Entity of this endpoint service
CHARACTER QueryLiteral (handle, character, character) Returns the query string literal of the given value typed according to the data type of the given field
ResetKeyFields (handle) Resets the unique key fields of the record in the given buffer to their initial values
LOGICAL SaveEntityDataset (RapidCloudResponse, handle) Passes the change-tracking dataset to the OERA update processing and turns Business Entity validation errors into error results
SaveRecordData (IRapidCloudRequest, RapidCloudResponse, character, handle, dataset-handle) Saves the inbound record values - creates a new record (new/copy without identity), updates the identified record (modify) or deletes the identified records (delete)
SetGridCell (IRapidCloudRequest, dataset-handle) Serves the RCD GridCell endpoint type - saves a single cell value of an editable grid
SetRecord (IRapidCloudRequest, dataset-handle) Serves the RCD RecordSet endpoint type - creates, updates or deletes a record
CHARACTER UiRulesEventName (character) Returns the event handler event name of the given RCD field trigger

Top Constructor Summary
Options Name Purpose
RapidCloudDataEndpoint (character) Constructor for the RapidCloudDataEndpoint class
RapidCloudDataEndpoint (character, character) Constructor for the RapidCloudDataEndpoint class

Top Property Summary
Options Name Purpose
CHARACTER EntityName
CHARACTER ListDisplayField
CHARACTER ListKeyField
CHARACTER ServerSideEventHandler


Method Detail
Top

AddDesignerFieldsResponse (RapidCloudResponse, dataset-handle)
Purpose: Builds the designer mode response of the RecordGet
endpoint type - the field metadata of the primary
temp-table instead of data
Notes: The metadata is provided by the
IRapidCloudFieldMetadataProvider service; the default
implementation describes the temp-table through
reflection, SCL-5724 adds a SmartFramework repository
based implementation

Parameters:
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

LOGICAL ApplyCellValue (RapidCloudResponse, handle, character, character)
Purpose: Applies a single cell value to the record in the given
buffer with change tracking
Notes: A value that cannot be converted into the data type of
the field becomes an error result

Parameters:
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
phBuffer HANDLE
The buffer positioned on the record to change
pcFieldName CHARACTER
The name of the field to assign
pcValue CHARACTER
The value to assign
Returns LOGICAL
True when the value was applied
Top

ApplyInboundRecord (handle, handle, logical)
Purpose: Applies the inbound record values to the record in the
given buffer with change tracking
Notes: Only same-named fields are copied - the RowIdData and
ETag pseudo-columns of the inbound temp-table are not
part of the entity temp-table and are ignored by the
buffer-copy. The inbound row carries the whole record as
the RCD frontend posts it (fields the request does not
name hold their initial values, there is no field list in
the request) - the record is updated as a whole, exactly
like the reference implementation (BaseRecordSet:SaveModify)

Parameters:
phTargetBuffer HANDLE
The buffer of the entity temp-table (positioned on the record for updates)
phInputBuffer HANDLE
The buffer positioned on the inbound record values
plCreate LOGICAL
Create a new record instead of updating the positioned record
Top

ApplyUiRules (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD UIRules endpoint type - returns the UI
rules to execute for a field event
Notes: The default implementation reuses the server-side event
handler infrastructure (SCL-5725 decision): the field
trigger of the request is mapped onto the matching event
handler method of the ServerSideEventHandler Business
Task (Value -> ValueChanged, Leave -> Leave, ...); a
request triggered by a designer rule action instead of a
field event invokes the method named by the Action or
CtrlName parameter. Without a configured event handler
the endpoint type responds with an
EndpointNotImplementedException

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

CHARACTER BroadcastSource (IRapidCloudRequest)
Purpose: Returns the source identifier (AppId/CtrlName) of the
change broadcast emitted after a successful save
Notes:

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
Returns CHARACTER
The source identifier or an empty value when the request carries no app context
Top

BuildRequestDataset (dataset-handle)
Purpose: Builds the dataset receiving the table shaped data of a
write request (RecordSet) - the entity shaped data
temp-table plus the RCD envelope tables
Notes: The dataset shape follows the request dataset of the
reference implementation: the data temp-table (like the
entity temp-table plus the RowIdData and ETag
pseudo-columns), ttResult, ttRules, ttPayload and
ttListObject. The caller is responsible for deleting the
returned dataset handle

Parameters:
phDataset DATASET-HANDLE
OUTPUT The created request dataset
Top

HANDLE BuildResultTable (handle, character, character, logical, logical, integer)
Purpose: Builds the response temp-table for a retrieval endpoint
invocation - the projection of the source temp-table onto
the requested columns plus the RowIdData record identity
token of every row
Notes: The caller is responsible for deleting the returned
temp-table handle. An empty (or *) column list returns
all fields of the source temp-table. A RowIdData field of
the source temp-table is ignored - the token is always
built by RapidCloudRecordKey

Parameters:
phSourceBuffer HANDLE
The buffer of the fetched source temp-table
pcColumnsList CHARACTER
The comma-delimited list of requested columns (empty or * for all)
pcOrderBy CHARACTER
The order-by phrase (without the BY keyword, may be empty) defining the row order
plIncludeETag LOGICAL
Include the ETag pseudo-column carrying the version of every row (RecordGet responses)
plGenerateIdentity LOGICAL
Populate the RowIdData and ETag values (false for init responses - a new or copied record has no identity yet)
piRecordCount INTEGER
OUTPUT The number of rows of the response temp-table
Returns HANDLE
The handle of the created response temp-table
Top

DeleteRecords (IRapidCloudRequest, RapidCloudResponse, handle, dataset-handle)
Purpose: Deletes the records identified by the RowIdData tokens of
the inbound rows after asking the user for confirmation
Notes: Every record is deleted through its own SaveChanges call;
when a record cannot be deleted the processing stops and
the response reports the error - records deleted before
the failure stay deleted. The confirmation is asked
through the IRapidCloudInteractionService (SCL-5731
tracks the open points of the blocking websocket call)

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
phInputBuffer HANDLE
The buffer of the inbound temp-table with the records to delete
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CHARACTER EntityETagValue (handle)
Purpose: Returns the ETag value identifying the current version of
the record in the given buffer
Notes: Provided by the Business Entity through the
ISupportsETagValue interface (SCL-5644) - an entity that
does not implement the interface returns an empty value
and the optimistic locking verification is skipped

Parameters:
phBuffer HANDLE
The buffer positioned on the record to return the ETag value for
Returns CHARACTER
The character ETag value or an empty value
Top

FetchEntityData (IFetchDataRequest, dataset-handle)
Purpose: Performs a FetchData request for the Business Entity of
this endpoint service against the OERA Service Interface
Notes: The caller is responsible for deleting the output dataset
handle

Parameters:
poFetchDataRequest Consultingwerk.OERA.IFetchDataRequest
The IFetchDataRequest describing the request
phDataset DATASET-HANDLE
OUTPUT The dataset with the fetched data
Top

FetchRecordDataset (character, dataset-handle)
Purpose: Fetches the record identified by the given record
identity token from the Business Entity of this endpoint
service
Notes: The caller is responsible for deleting the output dataset
handle and for testing the availability of the record

Parameters:
pcRowIdData CHARACTER
The record identity token of the record to fetch
phDataset DATASET-HANDLE
OUTPUT The dataset with the fetched record
Top

Consultingwerk.IQueryExpression FilterExpression (handle, character)
Purpose: Returns the filter expression for the given field and
filter value
Notes: Character fields perform a BEGINS match, every other data
type a typed equality match

Parameters:
phField HANDLE
The handle of the buffer field to filter on
pcValue CHARACTER
The filter value of the request
Returns Consultingwerk.IQueryExpression
The IQueryExpression for the field filter
Top

Consultingwerk.IQueryExpression GetFilter (IRapidCloudRequest)
Purpose: Returns the filter expression of a GridData endpoint
invocation
Notes: The default implementation follows the <FieldName>Filter
parameter convention (SCL-5724): for every field of the
primary temp-table the request parameter named
"<FieldName>Filter" is probed - a value performs a BEGINS
match on character fields and a typed equality match on
every other data type. This matches the filter controls
the GridDef endpoint derives from the filterable columns.
Endpoint services with different filter semantics
override this hook and compose QueryExpression /
ListQueryExpression instances qualified with the name of
the primary temp-table

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
Returns Consultingwerk.IQueryExpression
The IQueryExpression with the filter or ? for an unfiltered request
Top

GetGridData (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD GridData endpoint type - returns the data
of a grid
Notes: Generic implementation on top of
ServiceInterface:FetchData. FetchData. Filtering is provided by the
GetFilter hook, the sort order by the GetOrderBy hook.
Request parameters: ColumnsList (column projection),
Limit (batch size), NextRowId (paging continuation
token). Every response row carries the RowIdData record
identity token

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

GetList (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD List endpoint type - returns the items of a
dropdown, autocomplete or similar list-shaped control
Notes: Generic implementation on top of
ServiceInterface:FetchData, FetchData, driven by the ListKeyField and
ListDisplayField properties. The Id parameter resolves a
single record by key (display value for a stored key), the
SearchText parameter performs a BEGINS match on the
display field. Endpoint services that need multi-column
lists, images or grouping override this method instead

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

CHARACTER GetOrderBy (IRapidCloudRequest)
Purpose: Returns the order-by phrase (without the BY keyword) of a
GridData endpoint invocation
Notes: Hook for concrete endpoint services - the default
implementation orders by the unique key fields of the
primary temp-table, which also provides a stable order
for the paging continuation

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
Returns CHARACTER
The order-by phrase or an empty value for the default order
Top

GetRecord (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD RecordGet endpoint type - returns a single
record for a form
Notes: Generic implementation on top of
ServiceInterface:FetchData. FetchData. The record is located through
the RowIdData record identity token. In designer mode
(DesignerYN parameter) the field metadata of the primary
temp-table is returned instead of data, provided by the
IRapidCloudFieldMetadataProvider service

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

InitializeRecord (RapidCloudResponse, character, character, dataset-handle)
Purpose: Builds the init response of the RecordSet endpoint type -
a new record with its initial values or a copy of the
source record
Notes: The returned record carries no identity yet (empty
RowIdData and ETag values) - the frontend passes the
values back with Action new/copy and Function save

Parameters:
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
pcAction CHARACTER
The Action parameter value (new or copy)
pcRowIdData CHARACTER
The record identity token of the source record (copy only)
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

INTEGER IntegerParameter (character, character)
Purpose: Parses the value of an integer request parameter
Notes:

Parameters:
pcValue CHARACTER
The value of the request parameter
pcParameterName CHARACTER
The name of the request parameter (used in the error message)
Returns INTEGER
The integer value of the request parameter
Top

InvokeServerSideEvent (IRapidCloudRequest, character, dataset-handle)
Purpose: Invokes the server-side event handler method for a
UIRules or Action request and builds the rules response
Notes: The request context (RowIdData, AppId, field trigger and
the ttPayload properties) is carried in the
EventCustomContext of the event handler parameter; the
RowIdData record identity token is also available as the
EventContext

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
pcMethodName CHARACTER
The name of the event handler method to invoke
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

CHARACTER PagingContext (character)
Purpose: Returns the paging context of the given NextRowId
continuation token
Notes: The token format is <table>#<context> as built by
RapidCloudResponse:AddNextRowId; AddNextRowId; a value without the
table segment is used as the context directly

Parameters:
pcNextRowId CHARACTER
The NextRowId parameter value
Returns CHARACTER
The paging context for the FetchDataRequest
Top

CHARACTER ParameterValue (IRapidCloudRequest, character)
Purpose: Returns the value of the given request parameter
Notes: Returns an empty value instead of the unknown value when
the parameter is not part of the request

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

Progress.Json.ObjectModel.JsonObject PayloadContext (handle)
Purpose: Returns the ttPayload properties of the request as a JSON
object
Notes:

Parameters:
phRequest HANDLE
The request dataset
Returns Progress.Json.ObjectModel.JsonObject
The JSON object with one property per payload row
Top

PerformAction (IRapidCloudRequest, dataset-handle)
Purpose: Serves the Organi Action endpoint convention - executes
server logic triggered by a button
Notes: The default implementation reuses the server-side event
handler infrastructure (SCL-5725 decision): the Action
(or CtrlName) parameter of the request names the event
handler method invoked on the ServerSideEventHandler
Business Task - matching the button-to-method convention
of the server: toolbar actions. Without a configured
event handler the endpoint type responds with an
EndpointNotImplementedException

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

HANDLE PrimarySchemaBuffer ()
Purpose: Returns the (schema) buffer of the primary temp-table of
the Business Entity of this endpoint service
Notes: The schema dataset is fetched once and cached for the
lifetime of this endpoint service instance. Public so the
GridDef endpoint (RapidCloudRepositoryEndpoint) can
derive the grid columns of the entity through the same
cached schema (SCL-5724)

Returns HANDLE
The handle of the primary temp-table buffer
Top

CHARACTER QueryLiteral (handle, character, character)
Purpose: Returns the query string literal of the given value typed
according to the data type of the given field
Notes: The value is converted through a scratch record of the
given (schema) buffer, so numeric, date and logical
fields receive correctly typed literals

Parameters:
phBuffer HANDLE
The (schema) buffer defining the field
pcFieldName CHARACTER
The name of the field the literal is compared against
pcValue CHARACTER
The value to convert into a query string literal
Returns CHARACTER
The query string literal
Top

ResetKeyFields (handle)
Purpose: Resets the unique key fields of the record in the given
buffer to their initial values
Notes: Used for the init response of a copy - the copy carries
the values of the source record but no identity, so the
saved copy does not collide with the source record. The
key fields are the fields of the record identity token
(RapidCloudRecordKey)

Parameters:
phBuffer HANDLE
The buffer positioned on the record
Top

LOGICAL SaveEntityDataset (RapidCloudResponse, handle)
Purpose: Passes the change-tracking dataset to the OERA update
processing and turns Business Entity validation errors
into error results
Notes: After a successful save the dataset carries the saved
values including trigger- or backend-assigned values

Parameters:
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
phDataset HANDLE
The handle of the dataset with the tracked changes
Returns LOGICAL
True when the changes were saved without validation errors
Top

SaveRecordData (IRapidCloudRequest, RapidCloudResponse, character, handle, dataset-handle)
Purpose: Saves the inbound record values - creates a new record
(new/copy without identity), updates the identified
record (modify) or deletes the identified records
(delete)
Notes: On modify the round-tripped ETag value is verified
against the current record when both values are present
(optimistic locking following the ETag implementation of
the RestEntitiesWebHandler, SCL-5644)

Parameters:
poRequest Consultingwerk.Integrations.RapidCloud.IRapidCloudRequest
The request of the endpoint invocation
poResponse Consultingwerk.Integrations.RapidCloud.RapidCloudResponse
The response envelope of the endpoint invocation
pcAction CHARACTER
The Action parameter value (new/copy/modify/delete)
phInputBuffer HANDLE
The buffer of the inbound temp-table with the record values
phResponse DATASET-HANDLE
OUTPUT The response ProDataset
Top

SetGridCell (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD GridCell endpoint type - saves a single
cell value of an editable grid
Notes: Generic implementation on top of
ServiceInterface:SaveChanges. SaveChanges. The record is located
through the RowIdData record identity token, the cell
value arrives as the EditColName/EditColValue parameter
pair. Business Entity validation errors become error
results

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

SetRecord (IRapidCloudRequest, dataset-handle)
Purpose: Serves the RCD RecordSet endpoint type - creates, updates
or deletes a record
Notes: Generic implementation on top of
ServiceInterface:SaveChanges. SaveChanges. The operation is driven by
the Action (new/copy/modify/delete, default modify) and
Function (init/save/discard, default save) request
parameters; the record values arrive as a table in the
request body. Inbound ttResult rows skip the operation
(client-side validation short circuit). On modify the
round-tripped ETag value is verified against the current
record when present

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

CHARACTER UiRulesEventName (character)
Purpose: Returns the event handler event name of the given RCD
field trigger
Notes: Maps the RCD trigger vocabulary onto the event names of
the server-side event handler infrastructure

Parameters:
pcFieldTrigger CHARACTER
The RCD field trigger (Value, Leave, Keypress, Disabled, Enter)
Returns CHARACTER
The event handler event name


Constructor Detail
Top

RapidCloudDataEndpoint (character)
Purpose: Constructor for the RapidCloudDataEndpoint class
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity this endpoint service reads and mutates data through
Top

RapidCloudDataEndpoint (character, character)
Purpose: Constructor for the RapidCloudDataEndpoint class
Notes:

Parameters:
pcEntityName CHARACTER
The name of the Business Entity this endpoint service reads and mutates data through
pcServerSideEventHandler CHARACTER
The server-side event handler Business Task serving the UIRules and Action endpoint types


Property Detail
Top

CHARACTER EntityName

Returns CHARACTER
Top

CHARACTER ListDisplayField

Returns CHARACTER
Top

CHARACTER ListKeyField

Returns CHARACTER
Top

CHARACTER ServerSideEventHandler

Returns CHARACTER


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