Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CompositeType

A {@code CompositeType} represents a type that is composed of a list of sub-types, for example an {@code Address} type. The sub-types can be simple {@code DataType} or other {@code CompositeType} objects. Typically, a {@code CompositeType} may represent an arbitrarily deep hierarchy of types.

Properties

Optional configDefinition

configDefinition: model.ConfigDefinition

Optional description

description: undefined | string

A user defined description for the object.

Optional elements

elements: Array<TypedObject>

An array of elements.

Optional key

key: undefined | string

The key of the object.

Const modelType

modelType: string = "COMPOSITE_TYPE"

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional parentType

parentType: model.CompositeType

Methods

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: BaseType): object

getJsonObj