Class RetrievalSchema

In version 6.2.0: introduced

Hierarchy

Element

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RetrievalSchema(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): RetrievalSchema

Overwrites Element.constructor

Parameters
- model: AbstractModel
- structureTypeName: string
- id: string
- isPartial: boolean
- unit: ModelUnit
- container: AbstractElement
Returns RetrievalSchema

Properties

container

container: AbstractElement

entity

entity: string

In version 7.4.0: deleted

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

if false, a load is required to access these properties.

model

model: IModel

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

usedAssociations

usedAssociations: IList<string>

In version 7.2.0: introduced

usedAttributes

usedAttributes: IList<string>

In version 7.2.0: deleted

widgetName

widgetName: string

In version 7.14.0: introduced

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

allProperties

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

Implementation of IElement.allProperties

Inherited from Structure.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded()

Implementation of IElement.asLoaded

Inherited from AbstractElement.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.

deepCopy

deepCopy(targetModel: IAbstractModel)

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel

deepCopyWithIdMap

deepCopyWithIdMap(targetModel: IAbstractModel): object

Inherited from Element.deepCopyWithIdMap

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

Parameters
- targetModel: IAbstractModel
Returns object
- copy: Element
- idMap: IMap<Structure>

delete

delete(): void

Inherited from AbstractElement.delete

Overwrites Structure.delete

Deletes this element from the model.

Returns void

detach

detach()

Inherited from Element.detach

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

findElementById

findElementById(id: string): AbstractElement | null

Inherited from AbstractElement.findElementById

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

Parameters
- id: string
Returns AbstractElement | null

Protected getContainerAs

getContainerAs<T>(containerType: any): T

Inherited from Structure.getContainerAs

Type parameters
- T: IContainer
Parameters
- containerType: any
Returns T

load

load(callback: function, forceRefresh?: boolean): void
load(forceRefresh?: boolean): Promise

Inherited from AbstractElement.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: function
  - - (elem: ): void
    - Parameters
      - elem:
      Returns void
- Optional forceRefresh: boolean
Returns void
Implementation of IElement.load

Inherited from AbstractElement.load

Parameters
- Optional forceRefresh: boolean
Returns Promise

loadedProperties

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

Implementation of IElement.loadedProperties

Inherited from Structure.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IElement.publicProperties

Inherited from Structure.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IElement.toJSON

Inherited from Structure.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from Structure.traverse

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

traverseFind

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

Inherited from Structure.traverseFind

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

traversePublicParts

traversePublicParts(visit: function): void

Inherited from Structure.traversePublicParts

Parameters
- visit: function
  - - (structure: IStructure): void
    - Parameters
      - structure: IStructure
      Returns void
Returns void

Static create

create(model: IModel): RetrievalSchema

Creates and returns a new RetrievalSchema 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 RetrievalSchema

Generated using TypeDoc