Namespace: Consultingwerk.OERA.Swagger
Class 
SwaggerTempTableSchemaExporter Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Consultingwerk.OERA.Swagger.SwaggerTempTableSchemaExporter

Inherits: Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter


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



Top Method Summary
Options Name Purpose
AddBufferField (handle, JsonObject, logical) Adds the temp-table field to the given JsonObject
AddBufferFields (handle, JsonObject, character, logical) Adds the temp-table field to the given JsonObject
AddColumnAttributes (JsonObject, character, character, handle) Adds a boolean attribute to all table columns based on a list of columns
AddMandatoryColumns (JsonObject, JsonObject, IBusinessEntityDescriptor, handle) Adds the mandatory column attributes (x-mandatory and the required array) of the buffer's table descriptor to the given object schema
AddRequiredFields (JsonObject, JsonObject, character, handle) Adds the mandatory columns to the required array of the table's object schema
Progress.Json.ObjectModel.JsonArray GetEnumValues (handle) Returns an array of enum string values for a field
Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetTempTableAnnotations (character, character) Find annotations for a specific temp-table, defined in a Business Entity
TempTableSchemaToJsonObject (handle, character, IBusinessEntityDescriptor, JsonObject) Adds nodes for the schema of the given temp-table to the given JsonObject

Top Constructor Summary
Options Name Purpose
SwaggerTempTableSchemaExporter () Default constructor

Top Property Summary
Options Name Purpose
Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation TempTableAnnotations


Method Detail
Top

AddBufferField (handle, JsonObject, logical)
Purpose: Adds the temp-table field to the given JsonObject
Notes:
if FALSE the initial values (DEFAULT-STRING) are used

Parameters:
phField HANDLE
The handle of the temp-table field
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject to add the field to
plBufferValueAsDefault LOGICAL
If TRUE, then the buffer's field values (BUFFER-VALUE) are used for the default values.
Top

AddBufferFields (handle, JsonObject, character, logical)
Purpose: Adds the temp-table field to the given JsonObject
Notes:
if FALSE the initial values (DEFAULT-STRING) are used/

Parameters:
phBuffer HANDLE
The handle of the temp-table buffer
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject to add the field to
pcFields CHARACTER
The can-do list of fields to add to the JsonObject
plBufferValueAsDefault LOGICAL
If TRUE, then the buffer's field values (BUFFER-VALUE) are used for the default values.
Top

AddColumnAttributes (JsonObject, character, character, handle)
Purpose: Adds a boolean attribute to all table columns based on
a list of columns
Notes: Used for ReadOnly, Mandatory, non filterable and non sortable
Columns

Parameters:
poProperties Progress.Json.ObjectModel.JsonObject
The JsonObject representing the columns of a table in the catalog
pcAttributeName CHARACTER
The attribute name to attach to the column
pcColumns CHARACTER
The comma delimited list of columns to add the attribute to
phBuffer HANDLE
The handle of the buffer to determine the field's SERIALIZE-NAME
Top

AddMandatoryColumns (JsonObject, JsonObject, IBusinessEntityDescriptor, handle)
Purpose: Adds the mandatory column attributes (x-mandatory and the required
array) of the buffer's table descriptor to the given object schema
Notes: Used for flat record schemas (e.g. the RecordTemplate schema of
RESTful entities) whose properties are built through AddBufferFields
and therefore do not receive the table descriptor attributes

Parameters:
poSchemaObject Progress.Json.ObjectModel.JsonObject
The JsonObject representing the object schema (carrying the properties object)
poProperties Progress.Json.ObjectModel.JsonObject
The JsonObject representing the columns of the schema
poBusinessEntityDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The Business Entity Descriptor providing the table descriptor
phBuffer HANDLE
The handle of the temp-table buffer
Top

AddRequiredFields (JsonObject, JsonObject, character, handle)
Purpose: Adds the mandatory columns to the required array of the table's
object schema
Notes: The required array is the standard OpenAPI way of marking fields
as mandatory; the x-mandatory column attribute is kept for
backwards compatibility

Parameters:
poItemsObject Progress.Json.ObjectModel.JsonObject
The JsonObject representing the object schema of a table in the catalog
poProperties Progress.Json.ObjectModel.JsonObject
The JsonObject representing the columns of a table in the catalog
pcColumns CHARACTER
The comma delimited list of mandatory columns
phBuffer HANDLE
The handle of the buffer to determine the field's SERIALIZE-NAME
Top

Progress.Json.ObjectModel.JsonArray GetEnumValues (handle)
Purpose: Returns an array of enum string values for a field
Notes: Uses a FieldType() annotation to determine which enum type is
associated with a field
annotation exists.

Parameters:
phField HANDLE
The handle of the temp-table field
Returns Progress.Json.ObjectModel.JsonArray
A JSON array of possible values, or the unknown value, if no such
Top

Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation GetTempTableAnnotations (character, character)
Purpose: Find annotations for a specific temp-table, defined in a Business Entity
Notes: If no annotations are found, the TempTableAnnotations property will be set to the unknown value

Parameters:
pcTableName CHARACTER
The temp-table name
pcClassName CHARACTER
The name of the class in which the temp-table is defined
Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation
Returns a list of annotations for the named table, or the unknown value.
Top

TempTableSchemaToJsonObject (handle, character, IBusinessEntityDescriptor, JsonObject)
Purpose: Adds nodes for the schema of the given temp-table to the given
JsonObject
Notes:

Parameters:
phBuffer HANDLE
The handle of the temp-table buffer
pcType CHARACTER
The type attribute for the table reference (array / object)
poBusinessEntityDescriptor Consultingwerk.OERA.BusinessEntityDescriptor.IBusinessEntityDescriptor
The Business Entity Descriptor
poJsonObject Progress.Json.ObjectModel.JsonObject
The reference to the JsonObject


Constructor Detail
Top

SwaggerTempTableSchemaExporter ()
Purpose: Default constructor
Notes:



Property Detail
Top

Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation TempTableAnnotations

Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       16.08.2026 16:57:43