Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IConsumedODataService

See: relevant section in reference guide

In version 10.0.0: removed experimental In version 7.18.0: introduced

Hierarchy

  • IRemoteEntitySourceDocument
    • IConsumedODataService

Implemented by

Index

Properties

Methods

Properties

_container

_container: null | IContainer
internal

_containmentName

_containmentName: string

The name of the property of the parent's type which owns this unit.

internal

_declaredAsNamespace

_declaredAsNamespace: boolean
internal

Readonly _isAttached

_isAttached: boolean
internal

Readonly _isDeleted

_isDeleted: boolean
internal

Readonly _isDetached

_isDetached: boolean
internal

_isLoading

_isLoading: boolean

Whether this unit is currently being loaded.

internal

Readonly _isNew

_isNew: boolean
internal

_model

_model: AbstractModel

The {@link modelstore.IModelStore model store} holding the Mendix model this unit abides in.

internal

Readonly applicationId

applicationId: string

In version 8.12.0: added public In version 8.11.0: introduced

Readonly container

container: IStructuralUnit

Readonly containerAsFolderBase

containerAsFolderBase: IFolderBase

Readonly containerAsModule

containerAsModule: IModule

Readonly documentation

documentation: string

In version 9.10.0: added public

Readonly endpointId

endpointId: string

In version 8.14.0: introduced

Readonly environmentType

environmentType: EnvironmentType

In version 8.14.0: introduced

Readonly excluded

excluded: boolean

In version 9.11.0: added public

Readonly icon

icon: null | string

In version 8.11.0: added public In version 8.10.0: introduced

id

id: string

Readonly isLoadable

isLoadable: boolean

Whether this unit and all of its children (recursively) can be loaded.

isLoaded

isLoaded: boolean

Whether this unit has been completely loaded and does not consist of the unit's interface (which corresponds to the unit being partial).

Readonly isReadOnly

isReadOnly: boolean

Whether this unit and all of its children (recursively) are editable.

Readonly lastUpdated

lastUpdated: string

In version 8.14.0: introduced

Readonly metadataHash

metadataHash: string

In version 8.16.0: introduced

Readonly minimumMxVersion

minimumMxVersion: string

In version 8.14.0: introduced

Readonly model

model: IModel

Readonly name

name: string

Readonly qualifiedName

qualifiedName: null | string

Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

Readonly recommendedMxVersion

recommendedMxVersion: string

In version 8.14.0: introduced

Readonly serviceName

serviceName: string

In version 8.10.0: added public In version 8.0.0: introduced

structureTypeName

structureTypeName: string

unit

unit: IAbstractUnit

Unit that owns/contains this thing.

Readonly validated

validated: boolean

In version 9.6.0: introduced

Readonly validatedEntities

validatedEntities: IList<string>

In version 9.8.0: introduced

Readonly version

version: string

In version 8.10.0: added public In version 8.0.0: introduced

Readonly versionInfo

versionInfo: StructureVersionInfo
internal

Methods

_deleteInternal

  • _deleteInternal(): void
  • internal

    Returns void

_getQualifiedName

  • _getQualifiedName(): null | string
  • internal

    Returns null | string

_markLoaded

  • _markLoaded(): void

  • Mark this unit as having been loaded.

    internal

    Returns void

_markLoading

  • _markLoading(): void

  • Mark this unit as being loaded.

    internal

    Returns void

_markNotLoaded

  • _markNotLoaded(): void

  • Mark this unit as not having been loaded.

    internal

    Returns void

_registerAfterLoadCallback

  • _registerAfterLoadCallback(callback: (unit: IAbstractUnit) => void): void

  • Registers a callback taking this unit as argument, to be executed after the unit has been mark as completely loaded.

    internal

    Parameters

    Returns void

_updateWithJson

  • internal

    Parameters

    Returns void

allProperties

  • Returns AbstractProperty<any, any>[]

asLoaded

delete

  • delete(): void

  • Deletes the unit from the model

    Returns void

findElementById

  • Parameters

    • id: string

    Returns null | IAbstractElement

load

loadedProperties

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

    Returns AbstractProperty<any, any>[]

publicProperties

  • Returns AbstractProperty<any, any>[]

resolveByIdReferences

  • resolveByIdReferences(): void
  • internal

    Returns void

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: (structure: IStructure) => void): 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: (structure: IStructure) => T): null | T

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

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

  • Traverses this structure, only visiting children contained in public properties.

    Parameters

    Returns void

Generated using TypeDoc