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

File:SwaggerTempTableSchemaExporter
Purpose:Exports the schema of an OpenEdge temp-table to Swagger
Author(s):Martyn Kemp / Consultingwerk Ltd.
Created:Wed May 17 08:53:35 BST 2017

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



Top Method Summary
Options Name Purpose
+ CHARACTER AblTypeToCatalogType (character) Converts the given ABL Data Type into a Json Catalog type
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
# AddBufferField (handle, JsonObject) Adds the temp-table field to the given JsonObject
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
# 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
# AddErrorStringField (JsonObject) Adds the _errorString node to the properties (fields) of a table
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
# AddIdField (JsonObject) Adds the _id node to the properties (fields) of a table
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
+ 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
+ Progress.Json.ObjectModel.JsonObject TempTableSchemaToJsonObject (handle) Adds nodes for the schema of the given temp-table to a new JsonObject
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
+ TempTableSchemaToJsonObject (handle, character, IBusinessEntityDescriptor, JsonObject) Adds nodes for the schema of the given temp-table to the given JsonObject
+ TempTableSchemaToJsonObject (handle, character, JsonObject) Adds nodes for the schema of the given temp-table to the given JsonObject
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
+ TempTableSchemaToJsonObject (handle, JsonObject) Adds nodes for the schema of the given temp-table to the given JsonObject
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter

Top Constructor Summary
Options Name Purpose
+ SwaggerTempTableSchemaExporter () Default constructor

Top Property Summary
Options Name Purpose
+ LOGICAL IncludeErrorString
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
+ Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation TempTableAnnotations


Method Detail
Top

PUBLIC CHARACTER AblTypeToCatalogType (character)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Purpose: Converts the given ABL Data Type into a Json Catalog type
Notes:

Parameters:
pcAblType CHARACTER
The ABL Data Type
Returns CHARACTER
The Json Catalog data type
Top

PROTECTED AddBufferField (handle, JsonObject)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Purpose: Adds the temp-table field to the given JsonObject
Notes:

Parameters:
phField HANDLE
The handle of the temp-table field
poJsonObject Progress.Json.ObjectModel.JsonObject
The JsonObject to add the field to
Top

PROTECTED 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

PUBLIC 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

PROTECTED 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

PROTECTED AddErrorStringField (JsonObject)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Purpose: Adds the _errorString node to the properties (fields) of a table
Notes:

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
as JsonObject
Top

PROTECTED AddIdField (JsonObject)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Purpose: Adds the _id node to the properties (fields) of a table
Notes:

Parameters:
poJsonObject Progress.Json.ObjectModel.JsonObject
as JsonObject
Top

PUBLIC 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

PUBLIC 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

PUBLIC Progress.Json.ObjectModel.JsonObject TempTableSchemaToJsonObject (handle)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
Purpose: Adds nodes for the schema of the given temp-table to a new JsonObject
Notes:

Parameters:
phBuffer HANDLE
The handle of the temp-table buffer
Returns Progress.Json.ObjectModel.JsonObject
The reference to the JsonObject
Top

PUBLIC 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
Top

PUBLIC TempTableSchemaToJsonObject (handle, character, JsonObject)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
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)
poJsonObject Progress.Json.ObjectModel.JsonObject
The reference to the JsonObject
Top

PUBLIC TempTableSchemaToJsonObject (handle, JsonObject)
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter
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
poJsonObject Progress.Json.ObjectModel.JsonObject
The reference to the JsonObject


Constructor Detail
Top

PUBLIC SwaggerTempTableSchemaExporter ()
Purpose: Default constructor
Notes:



Property Detail
Top

PUBLIC LOGICAL IncludeErrorString
Inherited from Consultingwerk.OERA.OpenAccess.TempTableSchemaExporter

Returns LOGICAL
Top

PUBLIC Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation TempTableAnnotations

Returns Consultingwerk.Framework.TypeDescriptor.ListSerializableAnnotation


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2024 18:38:50