Entity

Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path

Extended by

• User
• UserSession
• Func
• Project
• DataConnection
• Model
• Notebook
• TableInfo
• ColumnInfo
• FileInfo
• Group
• Credentials
• ScriptEnvironment
• LogEventType
• LogEvent
• LogEventParameter
• LogEventParameterValue
• Package
• DockerContainer
• UserReport
• UserReportsRule
• ViewLayout
• ViewInfo
• DockerImage
• FuncCall

Constructors

new Entity()

new Entity(dart): Entity

Parameters

Parameter	Type
dart	any

Returns

Entity

Constructs

Entity

Source

src/entities.ts:87

Properties

Property	Modifier	Type
dart	public	any

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:115

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:101

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:93

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:105

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:109

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:112

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:118

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Source

src/entities.ts:127

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Source

src/entities.ts:139

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Source

src/entities.ts:97

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Source

src/entities.ts:132

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Source

src/entities.ts:142

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Source

src/entities.ts:137

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Source

src/entities.ts:145