Entity
Defined in: src/entities/entity.ts:17
Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path
Extended by
UserUserSessionGroupFuncScriptEnvironmentDataConnectionCredentialsTableInfoColumnInfoFileInfoLogEventTypeLogEventLogEventParameterLogEventParameterValueProjectViewLayoutViewInfoUserReportUserReportsRuleModelNotebookPackageDockerContainerDockerImageFuncCall
Constructors
Constructor
new Entity(
dart):Entity
Defined in: src/entities/entity.ts:22
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Entity
Constructs
Entity
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
dart | public | any | src/entities/entity.ts:19 |
Accessors
author
Get Signature
get author():
any
Defined in: src/entities/entity.ts:59
Who created entity *
Returns
any
createdOn
Get Signature
get createdOn():
Dayjs
Defined in: src/entities/entity.ts:50
Time when entity was created *
Returns
Dayjs
entityType
Get Signature
get entityType():
string
Defined in: src/entities/entity.ts:66
Entity type name *
Returns
string
friendlyName
Get Signature
get friendlyName():
string
Defined in: src/entities/entity.ts:36
Entity friendly name
Returns
string
Set Signature
set friendlyName(
x):void
Defined in: src/entities/entity.ts:37
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
id
Get Signature
get id():
string
Defined in: src/entities/entity.ts:28
Entity ID (GUID)
Returns
string
Set Signature
set id(
x):void
Defined in: src/entities/entity.ts:29
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
name
Get Signature
get name():
string
Defined in: src/entities/entity.ts:40
Entity short name
Returns
string
Set Signature
set name(
x):void
Defined in: src/entities/entity.ts:41
Parameters
| Parameter | Type |
|---|---|
x | string |
Returns
void
nqName
Get Signature
get nqName():
string
Defined in: src/entities/entity.ts:44
Entity full-qualified name
Returns
string
path
Get Signature
get path():
string
Defined in: src/entities/entity.ts:47
Entity path
Returns
string
updatedOn
Get Signature
get updatedOn():
Dayjs|null
Defined in: src/entities/entity.ts:53
Time when entity was updated *
Returns
Dayjs | null
Methods
getProperties()
getProperties():
Promise<{[index:string]:any; }>
Defined in: src/entities/entity.ts:69
Gets entity properties
Returns
Promise<{[index: string]: any; }>
hasTag()
hasTag(
tag):boolean
Defined in: src/entities/entity.ts:81
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean
newId()
newId():
void
Defined in: src/entities/entity.ts:32
Generates new id for this entity.
Returns
void
setProperties()
setProperties(
props):Promise<any>
Defined in: src/entities/entity.ts:74
Sets entity properties
Parameters
| Parameter | Type |
|---|---|
props | {[index: string]: any; } |
Returns
Promise<any>
tag()
tag(
tag):boolean
Defined in: src/entities/entity.ts:84
Adds a specified tag
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean
toString()
toString():
string
Defined in: src/entities/entity.ts:79
Returns a string representing the object
Returns
string
unTag()
unTag(
tag):boolean
Defined in: src/entities/entity.ts:87
Removes a specified tag
Parameters
| Parameter | Type |
|---|---|
tag | string |
Returns
boolean