ODataRemoteEntitySource | Mendix Model SDK

In version 8.10.0: introduced

Hierarchy

QueryBasedRemoteEntitySource
- ODataRemoteEntitySource

Implements

IODataRemoteEntitySource

Constructors

constructor

new ODataRemoteEntitySource(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit<IAbstractModel>, container: AbstractElement<IAbstractModel, Container>): ODataRemoteEntitySource

Overrides QueryBasedRemoteEntitySource.constructor
Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit<IAbstractModel>
- container: AbstractElement<IAbstractModel, Container>
Returns ODataRemoteEntitySource

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Rest$ODataRemoteEntitySource"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

get container(): TContainer

Implementation of IODataRemoteEntitySource.container
Inherited from domainmodels.QueryBasedRemoteEntitySource.container
Returns TContainer

containerAsEntity

get containerAsEntity(): Entity

Implementation of IODataRemoteEntitySource.containerAsEntity
Overrides domainmodels.QueryBasedRemoteEntitySource.containerAsEntity
Returns Entity

countable

get countable(): boolean
set countable(newValue: boolean): void

Implementation of IODataRemoteEntitySource.countable

In version 8.16.0: introduced

Returns boolean
Implementation of IODataRemoteEntitySource.countable

In version 8.16.0: introduced

Parameters
- newValue: boolean
Returns void

creatable

get creatable(): boolean
set creatable(newValue: boolean): void

In version 9.11.0: introduced

Returns boolean
In version 9.11.0: introduced

Parameters
- newValue: boolean
Returns void

createChangeLocally

get createChangeLocally(): boolean
set createChangeLocally(newValue: boolean): void

In version 10.4.0: introduced

Returns boolean
In version 10.4.0: introduced

Parameters
- newValue: boolean
Returns void

deletable

get deletable(): boolean
set deletable(newValue: boolean): void

In version 9.11.0: introduced

Returns boolean
In version 9.11.0: introduced

Parameters
- newValue: boolean
Returns void

entitySet

get entitySet(): string
set entitySet(newValue: string): void

In version 9.5.0: deleted In version 8.11.0: introduced

Returns string
In version 9.5.0: deleted In version 8.11.0: introduced

Parameters
- newValue: string
Returns void

entitySetName

get entitySetName(): string
set entitySetName(newValue: string): void

In version 9.5.0: introduced

Returns string
In version 9.5.0: introduced

Parameters
- newValue: string
Returns void

entityTypeName

get entityTypeName(): string
set entityTypeName(newValue: string): void

In version 9.5.0: introduced

Returns string
In version 9.5.0: introduced

Parameters
- newValue: string
Returns void

isLoaded

get isLoaded(): boolean

Implementation of IODataRemoteEntitySource.isLoaded
Inherited from domainmodels.QueryBasedRemoteEntitySource.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

model

get model(): TModel

Implementation of IODataRemoteEntitySource.model
Inherited from domainmodels.QueryBasedRemoteEntitySource.model
Returns TModel

remoteName

get remoteName(): string
set remoteName(newValue: string): void

In version 9.5.0: deleted

Returns string
In version 9.5.0: deleted

Parameters
- newValue: string
Returns void

skipSupported

get skipSupported(): boolean
set skipSupported(newValue: boolean): void

In version 9.21.0: introduced

Returns boolean
In version 9.21.0: introduced

Parameters
- newValue: boolean
Returns void

sourceDocument

get sourceDocument(): null | IConsumedODataService
set sourceDocument(newValue: null | IConsumedODataService): void

Returns null | IConsumedODataService
Parameters
- newValue: null | IConsumedODataService
Returns void

sourceDocumentQualifiedName

get sourceDocumentQualifiedName(): null | string

Returns null | string

topSupported

get topSupported(): boolean
set topSupported(newValue: boolean): void

In version 9.21.0: introduced

Returns boolean
In version 9.21.0: introduced

Parameters
- newValue: boolean
Returns void

unit

get unit(): ModelUnit<IAbstractModel>

Implementation of IODataRemoteEntitySource.unit
Inherited from domainmodels.QueryBasedRemoteEntitySource.unit

Unit that owns/contains this thing.

Returns ModelUnit<IAbstractModel>

Methods

allProperties

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

Implementation of IODataRemoteEntitySource.allProperties
Inherited from QueryBasedRemoteEntitySource.allProperties
Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): ODataRemoteEntitySource

Implementation of IODataRemoteEntitySource.asLoaded
Inherited from QueryBasedRemoteEntitySource.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 ODataRemoteEntitySource

deepCopy

deepCopy(targetModel: IAbstractModel): ODataRemoteEntitySource

Inherited from QueryBasedRemoteEntitySource.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns ODataRemoteEntitySource

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }

Inherited from QueryBasedRemoteEntitySource.deepCopyWithIdMap

Creates a deep copy of this element and its children. Also returns a map from original to new IDs.

Parameters
- targetModel: IAbstractModel
Returns { copy: Element<IAbstractModel>; idMap: IMap<Structure<IAbstractModel, null | IContainer>> }
- copy: Element<IAbstractModel>
- idMap: IMap<Structure<IAbstractModel, null | IContainer>>

delete

delete(): void

Inherited from QueryBasedRemoteEntitySource.delete

Deletes this element from the model.

Returns void

detach

detach(): ODataRemoteEntitySource

Inherited from QueryBasedRemoteEntitySource.detach

Detaches this element from the model, so that it can be attached in a different place.

Returns ODataRemoteEntitySource

findElementById

findElementById(id: string): null | AbstractElement<IAbstractModel, Container>

Implementation of IODataRemoteEntitySource.findElementById
Inherited from QueryBasedRemoteEntitySource.findElementById

Given an element id, returns the element in this abstract element with that id, otherwise null.

Parameters
- id: string
Returns null | AbstractElement<IAbstractModel, Container>

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from QueryBasedRemoteEntitySource.getContainerAs
Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: (elem: ODataRemoteEntitySource) => void, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise<ODataRemoteEntitySource>

Implementation of IODataRemoteEntitySource.load
Inherited from QueryBasedRemoteEntitySource.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
- callback: (elem: ODataRemoteEntitySource) => void
  - - (elem: ODataRemoteEntitySource): void
    - Parameters
      - elem: ODataRemoteEntitySource
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of IODataRemoteEntitySource.load
Inherited from QueryBasedRemoteEntitySource.load
Parameters
- Optional forceRefresh: boolean
Returns Promise<ODataRemoteEntitySource>

loadedProperties

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

Implementation of IODataRemoteEntitySource.loadedProperties
Inherited from QueryBasedRemoteEntitySource.loadedProperties

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

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IODataRemoteEntitySource.publicProperties
Inherited from QueryBasedRemoteEntitySource.publicProperties
Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IODataRemoteEntitySource.toJSON
Inherited from QueryBasedRemoteEntitySource.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 IStructureJSON

traverse

traverse(visit: (structure: IStructure) => void): void

Implementation of IODataRemoteEntitySource.traverse
Inherited from QueryBasedRemoteEntitySource.traverse

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
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

traverseFind<T>(visit: (structure: IStructure) => T): null | T

Implementation of IODataRemoteEntitySource.traverseFind
Inherited from QueryBasedRemoteEntitySource.traverseFind

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

Type parameters
- T
Parameters
- visit: (structure: IStructure) => T
  - - (structure: IStructure): T
    - Parameters
      - structure: IStructure
      Returns T
Returns null | T

traversePublicParts

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

Implementation of IODataRemoteEntitySource.traversePublicParts
Inherited from QueryBasedRemoteEntitySource.traversePublicParts

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

Parameters
- visit: (structure: IStructure) => void
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): ODataRemoteEntitySource

Creates and returns a new ODataRemoteEntitySource instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

Parameters
- model: IModel
Returns ODataRemoteEntitySource

Static createIn

createIn(container: Entity): ODataRemoteEntitySource

Creates and returns a new ODataRemoteEntitySource instance in the SDK and on the server. The new ODataRemoteEntitySource will be automatically stored in the 'source' property of the parent domainmodels.Entity element passed as argument.

Warning! Can only be used on models with the following Mendix meta model versions: 8.10.0 and higher

Parameters
- container: Entity
Returns ODataRemoteEntitySource

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

model: AbstractModel

structureTypeName: string

id: string

isPartial: boolean

unit: ModelUnit<IAbstractModel>

container: AbstractElement<IAbstractModel, Container>

Returns ODataRemoteEntitySource

Properties

id

structureTypeName

Static structureTypeName

Static versionInfo

Accessors

container

Returns TContainer

containerAsEntity

Returns Entity

countable

Returns boolean

Parameters

newValue: boolean

Returns void

creatable

Returns boolean

Parameters

newValue: boolean

Returns void

createChangeLocally

Returns boolean

Parameters

newValue: boolean

Returns void

deletable

Returns boolean

Parameters

newValue: boolean

Returns void

entitySet

Returns string

Parameters

newValue: string

Returns void

entitySetName

Returns string

Parameters

newValue: string

Returns void

entityTypeName

Returns string

Parameters

newValue: string

Returns void

isLoaded

Returns boolean

model

Returns TModel

remoteName

Returns string

Parameters

newValue: string

Returns void

skipSupported

Returns boolean

Parameters

newValue: boolean

Returns void

sourceDocument

Returns null | IConsumedODataService

Parameters

newValue: null | IConsumedODataService