Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumedODataService

See: relevant section in reference guide

In version 10.0.0: removed experimental In version 7.18.0: introduced

Hierarchy

  • RemoteEntitySourceDocument
    • ConsumedODataService

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected __applicationId

__applicationId: PrimitiveProperty<string> = ...
internal

Protected __catalogUrl

__catalogUrl: PrimitiveProperty<string> = ...
internal

Protected __description

__description: PrimitiveProperty<string> = ...
internal

Protected __documentation

__documentation: PrimitiveProperty<string> = ...
internal

Protected __endpointId

__endpointId: PrimitiveProperty<string> = ...
internal

Protected __environmentType

__environmentType: EnumProperty<EnvironmentType> = ...
internal

Protected __errorHandlingMicroflow

__errorHandlingMicroflow: ByNameReferenceProperty<IMicroflow> = ...
internal

Protected __excluded

__excluded: PrimitiveProperty<boolean> = ...
internal

Protected __exportLevel

__exportLevel: EnumProperty<ExportLevel> = ...
internal

Protected __headersMicroflow

__headersMicroflow: ByNameReferenceProperty<IMicroflow> = ...
internal

Protected __httpConfiguration

__httpConfiguration: PartProperty<HttpConfiguration> = ...
internal

Protected __icon

__icon: PrimitiveProperty<null | string> = ...
internal

Protected __lastUpdated

__lastUpdated: PrimitiveProperty<string> = ...
internal

Protected __metadata

__metadata: PrimitiveProperty<string> = ...
internal

Protected __metadataHash

__metadataHash: PrimitiveProperty<string> = ...
internal

Protected __metadataReferences

__metadataReferences: PartListProperty<MetadataReference> = ...
internal

Protected __metadataUrl

__metadataUrl: PrimitiveProperty<string> = ...
internal

Protected __minimumMxVersion

__minimumMxVersion: PrimitiveProperty<string> = ...
internal

Protected __name

__name: PrimitiveProperty<string> = ...
internal

Protected __oDataVersion

__oDataVersion: EnumProperty<ODataVersion> = ...
internal

Protected __proxyHost

__proxyHost: ByNameReferenceProperty<IConstant> = ...
internal

Protected __proxyPassword

__proxyPassword: ByNameReferenceProperty<IConstant> = ...
internal

Protected __proxyPort

__proxyPort: ByNameReferenceProperty<IConstant> = ...
internal

Protected __proxyType

__proxyType: EnumProperty<RequestProxyType> = ...
internal

Protected __proxyUsername

__proxyUsername: ByNameReferenceProperty<IConstant> = ...
internal

Protected __recommendedMxVersion

__recommendedMxVersion: PrimitiveProperty<string> = ...
internal

Protected __serviceId

__serviceId: PrimitiveProperty<string> = ...
internal

Protected __serviceName

__serviceName: PrimitiveProperty<string> = ...
internal

Protected __timeoutExpression

__timeoutExpression: PrimitiveProperty<string> = ...
internal

Protected __timeoutModel

__timeoutModel: PartProperty<Expression> = ...
internal

Protected __useQuerySegment

__useQuerySegment: PrimitiveProperty<boolean> = ...
internal

Protected __validated

__validated: PrimitiveProperty<boolean> = ...
internal

Protected __validatedEntities

__validatedEntities: PrimitiveListProperty<string> = ...
internal

Protected __version

__version: PrimitiveProperty<string> = ...
internal

Protected __versionApiMockResults

__versionApiMockResults: PrimitiveProperty<string> = ...
internal

_container

_container: null | IContainer
internal

_containmentName

_containmentName: string
internal

_declaredAsNamespace

_declaredAsNamespace: boolean = false
internal

Protected _isDoingDelete

_isDoingDelete: boolean = false
internal

_isLoadable

_isLoadable: boolean = true
internal

_isLoading

_isLoading: boolean = false
internal

_isPartial

_isPartial: boolean
internal

_isReadOnly

_isReadOnly: boolean = false
internal

_isReverting

_isReverting: boolean = false

Indicates that the internal data of this element is being reverted to its previous value, so some validation check could be skipped

internal

_isUpdating

_isUpdating: boolean = true

Indicates that the internal data of this element is being updated, as a result of data received from the server, so no storage events should be send

internal

_markLoaded

_markLoaded: () => void = AbstractUnit.prototype._markLoaded

Type declaration

    • (): void
    • internal

      Returns void

_markLoading

_markLoading: () => void = AbstractUnit.prototype._markLoading

Type declaration

    • (): void
    • internal

      Returns void

_markNotLoaded

_markNotLoaded: () => void = AbstractUnit.prototype._markNotLoaded

Type declaration

    • (): void
    • internal

      Returns void

_model

_model: AbstractModel
internal

_registerAfterLoadCallback

_registerAfterLoadCallback: (callback: ICallback<IAbstractUnit>) => void = AbstractUnit.prototype._registerAfterLoadCallback

Type declaration

_registeredQualifiedName

_registeredQualifiedName: null | string = null

used by qualified names cache to determine old name after a rename

internal

_state

_state: StructureState = "attached"

The current state of the structure: (new|attached|detached|deleted).

internal

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Rest$ConsumedODataService"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

_isAttached

  • get _isAttached(): boolean

  • This structure is attached somewhere in the model. This is the "normal" state for an structure.

    internal

    Returns boolean

_isDeleted

  • get _isDeleted(): boolean

  • This structure has been deleted and should no longer be used.

    internal

    Returns boolean

_isDetached

  • get _isDetached(): boolean

  • This structure is detached, so that it can be attached somewhere else in the model.

    internal

    Returns boolean

_isNew

  • get _isNew(): boolean

  • This structure was just constructed and has not been added to the model yet.

    internal

    Returns boolean

applicationId

  • get applicationId(): string
  • set applicationId(newValue: string): void

  • In version 8.12.0: added public In version 8.11.0: introduced

    Returns string

  • In version 8.12.0: added public In version 8.11.0: introduced

    Parameters

    • newValue: string

    Returns void

catalogUrl

  • get catalogUrl(): string
  • set catalogUrl(newValue: string): void

  • In version 8.10.0: introduced

    Returns string

  • In version 8.10.0: introduced

    Parameters

    • newValue: string

    Returns void

container

  • get container(): TContainer

containerAsFolderBase

containerAsModule

  • get containerAsModule(): Module

description

  • get description(): string
  • set description(newValue: string): void

  • In version 8.10.0: introduced

    Returns string

  • In version 8.10.0: introduced

    Parameters

    • newValue: string

    Returns void

documentation

  • get documentation(): string
  • set documentation(newValue: string): void

  • In version 9.10.0: added public

    Returns string

  • In version 9.10.0: added public

    Parameters

    • newValue: string

    Returns void

endpointId

  • get endpointId(): string
  • set endpointId(newValue: string): void

  • In version 8.14.0: introduced

    Returns string

  • In version 8.14.0: introduced

    Parameters

    • newValue: string

    Returns void

environmentType

errorHandlingMicroflow

  • get errorHandlingMicroflow(): null | IMicroflow
  • set errorHandlingMicroflow(newValue: null | IMicroflow): void

  • In version 9.6.0: introduced

    Returns null | IMicroflow

  • In version 9.6.0: introduced

    Parameters

    Returns void

errorHandlingMicroflowQualifiedName

  • get errorHandlingMicroflowQualifiedName(): null | string

  • Returns null | string

excluded

  • get excluded(): boolean
  • set excluded(newValue: boolean): void

  • In version 9.11.0: added public

    Returns boolean

  • In version 9.11.0: added public

    Parameters

    • newValue: boolean

    Returns void

exportLevel

  • In version 9.3.0: introduced

    Returns ExportLevel

  • In version 9.3.0: introduced

    Parameters

    Returns void

headersMicroflow

  • In version 8.4.0: introduced

    Returns null | IMicroflow

  • In version 8.4.0: introduced

    Parameters

    Returns void

headersMicroflowQualifiedName

  • get headersMicroflowQualifiedName(): null | string

  • Returns null | string

httpConfiguration

icon

  • get icon(): null | string
  • set icon(newValue: null | string): void

  • In version 8.11.0: added public In version 8.10.0: introduced

    Returns null | string

  • In version 8.11.0: added public In version 8.10.0: introduced

    Parameters

    • newValue: null | string

    Returns void

isLoadable

  • get isLoadable(): boolean

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

    Returns boolean

isLoaded

  • get 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).

    Returns boolean

isReadOnly

  • get isReadOnly(): boolean

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

    Returns boolean

lastUpdated

  • get lastUpdated(): string
  • set lastUpdated(newValue: string): void

metadata

  • get metadata(): string
  • set metadata(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

metadataHash

  • get metadataHash(): string
  • set metadataHash(newValue: string): void

  • In version 8.16.0: introduced

    Returns string

  • In version 8.16.0: introduced

    Parameters

    • newValue: string

    Returns void

metadataReferences

metadataUrl

  • get metadataUrl(): string
  • set metadataUrl(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

minimumMxVersion

  • get minimumMxVersion(): string
  • set minimumMxVersion(newValue: string): void

model

  • get model(): TModel

name

  • get name(): string
  • set name(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

oDataVersion

  • In version 8.6.0: introduced

    Returns ODataVersion

  • In version 8.6.0: introduced

    Parameters

    Returns void

proxyHost

proxyHostQualifiedName

  • get proxyHostQualifiedName(): null | string

  • Returns null | string

proxyPassword

proxyPasswordQualifiedName

  • get proxyPasswordQualifiedName(): null | string

  • Returns null | string

proxyPort

proxyPortQualifiedName

  • get proxyPortQualifiedName(): null | string

  • Returns null | string

proxyType

proxyUsername

proxyUsernameQualifiedName

  • get proxyUsernameQualifiedName(): null | string

  • Returns null | string

qualifiedName

  • get 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.

    Returns null | string

recommendedMxVersion

  • get recommendedMxVersion(): string
  • set recommendedMxVersion(newValue: string): void

serviceId

  • get serviceId(): string
  • set serviceId(newValue: string): void

  • In version 8.14.0: deleted In version 8.0.0: introduced

    Returns string

  • In version 8.14.0: deleted In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

serviceName

  • get serviceName(): string
  • set serviceName(newValue: string): void

  • In version 8.10.0: added public In version 8.0.0: introduced

    Returns string

  • In version 8.10.0: added public In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

timeoutExpression

  • get timeoutExpression(): string
  • set timeoutExpression(newValue: string): void

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.5.0: introduced

    Returns string

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    In version 8.5.0: introduced

    Parameters

    • newValue: string

    Returns void

unit

  • get unit(): this

  • Unit that owns/contains this thing.

    Returns this

useQuerySegment

  • get useQuerySegment(): boolean
  • set useQuerySegment(newValue: boolean): void

  • In version 9.6.0: introduced

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

    Returns void

validated

  • get validated(): boolean
  • set validated(newValue: boolean): void

  • In version 9.6.0: introduced

    Returns boolean

  • In version 9.6.0: introduced

    Parameters

    • newValue: boolean

    Returns void

validatedEntities

  • get validatedEntities(): IList<string>

version

  • get version(): string
  • set version(newValue: string): void

  • In version 8.10.0: added public In version 8.0.0: introduced

    Returns string

  • In version 8.10.0: added public In version 8.0.0: introduced

    Parameters

    • newValue: string

    Returns void

versionApiMockResults

  • get versionApiMockResults(): string
  • set versionApiMockResults(newValue: string): void

  • In version 8.14.0: deleted In version 8.13.0: introduced

    Returns string

  • In version 8.14.0: deleted In version 8.13.0: introduced

    Parameters

    • newValue: string

    Returns void

versionInfo

Methods

_assertLoaded

  • Asserts that the complete element is available, and not just its public part.

    internal

    Parameters

    Returns void

_cacheElement

_childHandle

  • Finds the given child among the properties of this structure, returning a handle to detach it later when appropriate based on in which property is was found.

    internal

    Parameters

    Returns null | IChildHandle

_deleteChild

  • Deletes the given child from any (part) property that contained it.

    internal

    Parameters

    Returns void

_deleteInternal

  • _deleteInternal(): void

_detachChild

  • Detaches the given child from any (part) property that contained it.

    internal

    Parameters

    Returns void

_dispose

  • _dispose(): void
  • internal

    Returns void

_getQualifiedName

  • _getQualifiedName(): null | string

_handleCreateSelf

  • _handleCreateSelf(): void
  • internal

    Returns void

_initializeDefaultProperties

  • _initializeDefaultProperties(): void
  • internal

    Returns void

_initializeNewInstance

  • _initializeNewInstance(): void
  • internal

    Returns void

_isByNameReferrable

  • _isByNameReferrable(): boolean
  • internal

    Returns boolean

_markCurrentValuesAsDefaults

  • _markCurrentValuesAsDefaults(): void
  • internal

    Returns void

_processLocalNameChange

  • _processLocalNameChange(previousName: null | string): void

  • Update local-by-name references to this structure.

    internal

    Parameters

    • previousName: null | string

    Returns void

_processNameChange

  • _processNameChange(): void

  • If the name of a model element changes, this might effect currently broken references-by-name, so let's process those.

    internal

    Returns void

_registerProperty

  • _registerProperty(prop: AbstractProperty<any, any>, declaredOn: IStructureClass): void
  • internal

    Parameters

    Returns void

_resolveLocalName

  • _resolveLocalName(elementTypeName: string, name: null | string): null | IAbstractElement

  • Given the type and name of an element, returns the element in this model unit with the specified type and name if there is exactly one matching element, otherwise null.

    internal

    Parameters

    • elementTypeName: string
    • name: null | string

    Returns null | IAbstractElement

_scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: Delta): void
  • internal

    Parameters

    Returns void

_sendChangeDelta

  • _sendChangeDelta(propertyName: string, newValue: any, changeType?: "CHANGE" | "ADD" | "REMOVE", index?: number): void

  • Sends the change delta in case a simple property has changed.

    internal

    Parameters

    • propertyName: string
    • newValue: any
    • changeType: "CHANGE" | "ADD" | "REMOVE" = "CHANGE"
    • index: number = -1

    Returns void

_sendDeleteDelta

  • _sendDeleteDelta(): void

  • Sends the delete in case that we were removed from the model.

    internal

    Returns void

_startUsingElementsCache

  • _startUsingElementsCache(): void
  • internal

    Returns void

_stopUsingElementsCache

  • _stopUsingElementsCache(): void
  • internal

    Returns void

Protected _updateElementsContainer

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    internal

    Parameters

    Returns void

_updateWithJson

  • Update an existing (probably partial) interface with real contents received from the server.

    internal

    Parameters

    Returns void

_updateWithJsonImpl

  • internal

    Parameters

    Returns void

allProperties

asLoaded

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns ConsumedODataService

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

  • Type parameters

    Parameters

    • containerType: any

    Returns T

load

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<ConsumedODataService>

loadedProperties

publicProperties

resolveByIdReferences

  • resolveByIdReferences(): void

  • Should be called after deserialization / remote updates, to make sure all references are bound to their actual value.

    internal

    Returns void

toJSON

  • 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 IAbstractElementJson

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

Static createIn

  • Creates a new ConsumedODataService unit in the SDK and on the server. Expects one argument, the projects.IFolderBase in which this unit is contained.

    Parameters

    Returns ConsumedODataService

Generated using TypeDoc