Skip to main content

%pkg.isc.rest.openAPI.model.passthroughObject

persistent class %pkg.isc.rest.openAPI.model.passthroughObject extends %pkg.isc.rest.openAPI.model.extensibleSuper

SQL Table Name: %pkg_isc_rest_openAPI_model.passthroughObject

Super-class that allows its sub-classes' ..Data property to be represented as JSON in place of them. Note that this data property may be a primitive (a string, an integer, etc)

Method Inventory

Parameters

parameter EXTENSIBLE = 0;
@Override: Whether or not this object allows the use of extended "x-*" properties (defaults to false)

Methods

method AllowsExtendedProperties() as %Boolean
@Override: Whether or not this object allows extended properties
method Count() as %Integer
Pass-through calls to ..Count to the object's Data property Throws an error if the object does not exist or have a Count method defined
method Data()
Returns the value of the ..Data property for this object
method ExportArray(doWrite As %Boolean)
Handles exporting ..Data as JSON when it is an array
method ExportList(doWrite As %Boolean)
Handles exporting ..Data as JSON when it is a list
method ExportValue(doWrite As %Boolean)
Handles exporting ..Data as JSON when it is a single object/primitive
method GetAt(key)
Pass-through calls to ..GetAt to the object's Data property Throws an error if the object does not exist or have a GetAt method defined
method GetJSONType()
Returns the value of the ..JSONType property for this object (or the empty string if not JSONType is defined)
method GetNext(ByRef key)
Pass-through calls to ..GetNext to the object's Data proeprty Throws an error if the object does not exist or have a GetNext method defined
method Insert(obj)
Pass-through calls to ..Insert to the object's Data property Throws an error if the object does not exist or have a Insert method defined
method IsDefined(key)
Pass-through calls to ..IsDefined to the object's Data property Throws an error if the object does not exist or have a IsDefined method defined
method JSONExportOverride(write As %Boolean) as %Status
@Special: Override the JSONExport behavior defined by %pkg.isc.json, in order to return a JSON representation of ..Data instead of this object
method RemoveAt(key)
Pass-through calls to ..RemoveAt to the object's Data property Throws an error if the object does not exist or have a GetAt method defined
method SetAt(obj, key)
Pass-through calls to ..SetAt to the object's Data property Throws an error if the object does not exist or have a SetAt method defined

Inherited Members

Inherited Methods

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (%pkg.isc.rest.openAPI.model.super)

^pkg.isc.rest.oas.model.superD(ID)
=
%%CLASSNAME

Storage Model: Storage (%pkg.isc.rest.openAPI.model.extensibleSuper)

^pkg.isc.rest.oas.model.superD(ID,"%pkg.isc.rest.openAPI.model.extensibleSuper.Extras",n)
=
Extras(n)
FeedbackOpens in a new tab