Namespace: OpenEdge.Web.DataObject.Writer
Class
OpenAPI30ServiceWriter
Parent classes:
Inherits: OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter

/* *************************************************************************************************************************
Copyright (c) 2018 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:OpenAPI30ServiceWriter
Purpose:Writes a DataObjectService to a OpenApi (Swagger) 3.0 doc
Author(s):pjudge
Created:2018-09-20
Notes:- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md




Method Summary
Options Name Purpose
Clear () /** Clears or empties the target */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Close () /** Closes the writer. */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
CHARACTER FieldInfo (character, character)
Flush () /** Flushes(writes) the input to the target */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject GetCatalogSchema (SemanticVersion) /* Returns a schema for a Data Object Service Catalog @param SemanticVersion The catalog version @return JsonObject The catalog JSON-schema */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject GetPathJson (DataObjectService, character, MethodEnum)
Open ()
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:Open ()
Write (Object) /* Writes an object array into the Value. @param Progress.Lang.Object An object to write. It will typically be in the OpenEdge.Web.DataObject package and be part of a DataObjectService */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Write (Object[]) /* Writes an object array into the Value. @param Progress.Lang.Object[] A set of objects to write. They will typically be in the OpenEdge.Web.DataObject package and be part of a DataObjectService */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject WriteDataset (handle)
WriteDefaultFieldValue (handle, JsonObject) /* Writes the correctly-typed default value for a field @param handle A valid buffer-field handle @param JsonObject A valid JSON object representing the field */
Progress.Json.ObjectModel.JsonObject WriteDefaultSchemas ()
Progress.Json.ObjectModel.JsonArray WriteDefaultServers ()
WriteDOS (DataObjectService) /* Writes a single Data Object Service @param DataObjectService The service to write */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Json.ObjectModel.JsonObject WriteHeaders (MappedOperation)
Progress.Json.ObjectModel.JsonObject WriteInfo ()
WriteOperation (DataObjectService, MappedOperation)
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteOperation (DataObjectService, MappedOperation)
WriteSchema (DataObjectService, handle)
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteSchema (DataObjectService, handle)
WriteService (DataObjectService)
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteService (DataObjectService)
Progress.Json.ObjectModel.JsonObject WriteServiceRoot ()
Progress.Json.ObjectModel.JsonObject WriteTable (handle)
WriteTag (character, character, JsonObject)
WriteTuple (Object, Object) /* Writes a tuple (key-value pair). This is effectively a VIRTUAL method (no default behaviour but not compiled enforcement either). @param Progress.Lang.Object The key value - property name (required) @param Progress.Lang.Object A value to be written for the property. May be null. */
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
WriteURI (URI) /* Writes a URI to the output @param URI The URI to write */
Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteURI (URI)

Constructor Summary
Options Name Purpose
OpenAPI30ServiceWriter ()
OpenAPI30ServiceWriter () /* Default constructor */

Property Summary
Options Name Purpose
ILogWriter Logger
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
OpenEdge.Core.SemanticVersion OPEN_API_VERSION
Progress.Lang.Object Value
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Progress.Lang.Class ValueType
Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter


Method Detail
Top

PUBLIC Clear ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Clears or empties the target
Top

PUBLIC Close ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Closes the writer.
Top

PROTECTED CHARACTER FieldInfo (character, character)

Parameters:
pAblType CHARACTER
pFormat CHARACTER
Returns CHARACTER
Top

PUBLIC Flush ()

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Purpose: Flushes(writes) the input to the target
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetCatalogSchema (SemanticVersion)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Returns a schema for a Data Object Service Catalog
Parameters:
pVersion OpenEdge.Core.SemanticVersion
Returns Progress.Json.ObjectModel.JsonObject
JsonObject The catalog JSON-schema
Top

PROTECTED Progress.Json.ObjectModel.JsonObject GetPathJson (DataObjectService, character, MethodEnum)

Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
pUri CHARACTER
pMethod OpenEdge.Net.HTTP.MethodEnum
Returns Progress.Json.ObjectModel.JsonObject
Top

PUBLIC Open ()

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:Open ()
Top

PUBLIC Write (Object)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes an object array into the Value.
be in the OpenEdge.Web.DataObject package and be part of
a DataObjectService
Parameters:
pData Progress.Lang.Object
Top

PUBLIC Write (Object[])

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes an object array into the Value.
be in the OpenEdge.Web.DataObject package and be part of
a DataObjectService
Parameters:
pData Progress.Lang.Object
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteDataset (handle)

Parameters:
pDataset HANDLE
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteDefaultFieldValue (handle, JsonObject)

/* Writes the correctly-typed default value for a field
Parameters:
pField HANDLE
pJson Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteDefaultSchemas ()

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonArray WriteDefaultServers ()

Returns Progress.Json.ObjectModel.JsonArray
Top

PROTECTED WriteDOS (DataObjectService)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes a single Data Object Service
Parameters:
pData OpenEdge.Web.DataObject.DataObjectService
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteHeaders (MappedOperation)

Parameters:
pData OpenEdge.Web.DataObject.MappedOperation
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteInfo ()

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteOperation (DataObjectService, MappedOperation)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteOperation (DataObjectService, MappedOperation)
Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
pData OpenEdge.Web.DataObject.MappedOperation
Top

PROTECTED WriteSchema (DataObjectService, handle)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteSchema (DataObjectService, handle)
Parameters:
pService OpenEdge.Web.DataObject.DataObjectService
pData HANDLE
Top

PROTECTED WriteService (DataObjectService)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteService (DataObjectService)
Parameters:
pData OpenEdge.Web.DataObject.DataObjectService
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteServiceRoot ()

Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED Progress.Json.ObjectModel.JsonObject WriteTable (handle)

Parameters:
pTable HANDLE
Returns Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteTag (character, character, JsonObject)

Parameters:
pName CHARACTER
pDescription CHARACTER
pExtDoc Progress.Json.ObjectModel.JsonObject
Top

PROTECTED WriteTuple (Object, Object)

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
/* Writes a tuple (key-value pair).
This is effectively a VIRTUAL method (no default behaviour but not compiled enforcement either).
Parameters:
pKey Progress.Lang.Object
pValue Progress.Lang.Object
Top

PROTECTED WriteURI (URI)

Overrides OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter:WriteURI (URI)
/* Writes a URI to the output
Parameters:
pData OpenEdge.Net.URI


Constructor Detail
Top

STATIC OpenAPI30ServiceWriter ()

Top

PUBLIC OpenAPI30ServiceWriter ()

/* Default constructor


Property Detail
Top

PUBLIC ILogWriter Logger

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns ILogWriter
Top

PUBLIC OpenEdge.Core.SemanticVersion OPEN_API_VERSION

Returns OpenEdge.Core.SemanticVersion
Top

PUBLIC Progress.Lang.Object Value

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns Progress.Lang.Object
Top

PUBLIC Progress.Lang.Class ValueType

Inherited from OpenEdge.Web.DataObject.Writer.DataObjectServiceWriter
Returns Progress.Lang.Class


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0