Class RetrievalQuery

In version 7.12.0: introduced

Hierarchy

Element<IModel>

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overwrites Element.constructor

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

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

allowedUserRoles

get (): IList<IUserRole>

Returns IList<IUserRole>

allowedUserRolesQualifiedNames

get (): string[]

Returns string[]

container

get (): AbstractElement

Inherited from AbstractUnit.container

Returns AbstractElement

entityPath

get (): string
set (newValue: string): any

In version 7.21.0: introduced

Returns string
In version 7.21.0: introduced

Parameters
- newValue: string
Returns any

isLoaded

get (): boolean

Inherited from Element.isLoaded

Overwrites AbstractElement.isLoaded
Checks whether all attributes are available ATM
- if false, a load is required to access these properties.
Returns boolean

microflow

get (): IMicroflow | null
set (newValue: IMicroflow | null): any

In version 7.21.0: introduced

Returns IMicroflow | null
In version 7.21.0: introduced

Parameters
- newValue: IMicroflow | null
Returns any

microflowQualifiedName

get (): string | null

Returns string | null

model

get (): IModel

Inherited from AbstractUnit.model

Returns IModel

pageName

get (): string
set (newValue: string): any

In version 7.14.0: introduced

Returns string
In version 7.14.0: introduced

Parameters
- newValue: string
Returns any

parameters

get (): IList<RetrievalQueryParameter>

In version 8.6.0: introduced

Returns IList<RetrievalQueryParameter>

queryId

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

schemaId

get (): string
set (newValue: string): any

In version 8.4.0: deleted

Returns string
In version 8.4.0: deleted

Parameters
- newValue: string
Returns any

unit

get (): ModelUnit<IAbstractModel>

Inherited from Element.unit

Overwrites AbstractUnit.unit

Returns ModelUnit<IAbstractModel>

usedAssociations

get (): IList<string>

In version 8.4.0: introduced

Returns IList<string>

usedAttributes

get (): IList<string>

In version 8.11.0: introduced

Returns IList<string>

widgetName

get (): string
set (newValue: string): any

In version 8.4.0: introduced

Returns string
In version 8.4.0: introduced

Parameters
- newValue: string
Returns any

xPath

get (): string
set (newValue: string): any

Returns string
Parameters
- newValue: string
Returns any

Methods

allProperties

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

Implementation of IElement.allProperties

Inherited from AbstractUnit.allProperties

Returns AbstractProperty<any, any>[]

asLoaded

asLoaded(): this

Implementation of IElement.asLoaded

Inherited from ModelUnit.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 this

deepCopy

deepCopy(targetModel: IAbstractModel): this

Inherited from Element.deepCopy

Creates a deep copy of this element and its children.

Parameters
- targetModel: IAbstractModel
Returns this

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 AbstractUnit.delete

Deletes this element from the model.

Returns void

detach

detach(): this

Inherited from Element.detach

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

Returns this

findElementById

findElementById(id: string): AbstractElement | null

Implementation of IElement.findElementById

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 AbstractUnit.getContainerAs

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

load

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

Inherited from ModelUnit.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: this): void
    - Parameters
      - elem: this
      Returns void
- Optional forceRefresh: undefined | false | true
Returns void
Implementation of IElement.load

Inherited from ModelUnit.load

Parameters
- Optional forceRefresh: undefined | false | true
Returns Promise<this>

loadedProperties

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

Implementation of IElement.loadedProperties

Inherited from AbstractUnit.loadedProperties

Returns AbstractProperty<any, any>[]

publicProperties

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

Implementation of IElement.publicProperties

Inherited from AbstractUnit.publicProperties

Returns AbstractProperty<any, any>[]

toJSON

toJSON(): IStructureJSON

Implementation of IElement.toJSON

Inherited from AbstractUnit.toJSON

Returns IStructureJSON

traverse

traverse(visit: function): void

Inherited from AbstractUnit.traverse

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

traverseFind

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

Inherited from AbstractUnit.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 AbstractUnit.traversePublicParts

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

Static create

create(model: IModel): RetrievalQuery

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

Generated using TypeDoc