Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IODataKey

NOTE: This class is experimental and is subject to change in newer Model SDK versions.

In version 8.9.0: introduced

Hierarchy

Implemented by

Index

Properties

Methods

Properties

container

container: IAbstractElement

containerAsODataRemoteEntitySource

containerAsODataRemoteEntitySource: IODataRemoteEntitySource

id

id: string

isLoaded

isLoaded: boolean

model

model: IModel

parts

parts: IList<IODataKeyPart>

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

structureTypeName

structureTypeName: string

unit

unit: IAbstractUnit

Unit that owns/contains this thing.

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<ODataKey>

  • Parameters

    • callback: function
    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<ODataKey>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

  • Returns all properties when this structure is loaded, otherwise just the public properties.

    Returns AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

  • toJSON(): object

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns object

traverse

  • traverse(visit: function): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: function): T | null

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns T | null

traversePublicParts

  • traversePublicParts(visit: function): void

Generated using TypeDoc