Entity class
Represents one entity.
Extends
Section titled “Extends”MetaEntity
- attributes
- caption
- captionPlural
- description
- endpoint
- id
- name
- parent
- subEntities
- useInConditions
- useInResult
- useInSorting
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor. ⊕ new Entity(parent?: Entity): Entity
Parameters:
Section titled “Parameters:”- parent: Entity, Optional
Public Properties
Section titled “Public Properties”attributes
Section titled “attributes”● attributes: Array<EntityAttr>
caption
Section titled “caption”The caption of entity attr.
● caption: string
captionPlural
Section titled “captionPlural”The caption of entity attr in plural form.
● captionPlural: string
description
Section titled “description”The description of entity.
● description: string
endpoint
Section titled “endpoint”The endpoint of entity. It is used for odata or graphql brokers
● endpoint?: string
The id.
● id: string
The name of entity.
● name: string
parent
Section titled “parent”The parent.
● parent: MetaEntity
subEntities
Section titled “subEntities”● subEntities: Array<Entity>
useInConditions
Section titled “useInConditions”The value indicating whether the attribute can be used in query conditions.
● useInConditions: boolean
useInResult
Section titled “useInResult”The value indicating whether the attribute can be used in result columns (SELECT clause).
● useInResult: boolean
useInSorting
Section titled “useInSorting”The value indicating whether the attribute can be used in sorting.
● useInSorting: boolean
Public Methods
Section titled “Public Methods”loadFromData
Section titled “loadFromData”Loads entity from its JSON representation object.
▸ loadFromData(model: DataModel,data: EntityData): void
Parameters:
Section titled “Parameters:”- model: DataModel - The Data Model.
- data: EntityData - The JSON representation object.
Returns void
▸ scan(processAttribute?: (attr: EntityAttr, opts: any) => void,processEntity?: (entity: Entity, opts: any) => void): void
Parameters:
Section titled “Parameters:”- processAttribute: (attr: EntityAttr, opts:
any) =>void, Optional - processEntity: (entity: Entity, opts:
any) =>void, Optional
Returns void